Skip to main content

corgi k8s

corgi k8s​

Services that run in Kubernetes: up, down, the manifests corgi generates

Synopsis​

A service with runner: {name: k8s} runs in a cluster instead of on this machine. corgi run applies it, waits for the rollout, forwards its port to localhost and streams its logs; stopping removes what it applied.

services: api: port: 3000 runner: name: k8s kubeContext: kind-dev # needed for any cluster that is not local manifests: deploy/k8s # or chart: deploy/chart, or neither: corgi

builds the Dockerfile and writes a Deployment

corgi k8s manifests api # what corgi would apply, to start your own from corgi k8s status # every k8s service: context, namespace, rollout

Options​

-h, --help help for k8s

Options inherited from parent commands​

--describe Describe contents of corgi-compose file
--dockerContext string Specify docker context to use, can be default,orbctl,colima (default "default")
-l, --exampleList List examples to choose from. Click on any example to download it
-f, --filename string Custom filepath for for corgi-compose
--fromScratch Clean the .corgi/corgi_services folder before running
-t, --fromTemplate string Create corgi service from template url
--fromTemplateName string Create corgi service from template name and url
-g, --global Use global path to one of the services
--interactive Force interactive prompts even when no TTY/agent detected
--isolate string Run this workspace under a named lease: own port block, own database names, own containers
--json Emit machine-readable JSON output
--privateToken string Private token for private repositories to download files
-o, --runOnce Run corgi once and exit
--silent Hide all welcome messages

SEE ALSO​

  • corgi - Corgi cli magic friend
  • corgi k8s down - Remove what corgi applied for a service
  • corgi k8s manifests - Print the Deployment and Service corgi generates for a service
  • corgi k8s status - Every k8s service: its context, namespace and rollout
  • corgi k8s up - Apply a service to its cluster, forward its port and follow its logs until stopped
Auto generated by spf13/cobra on 16-Nov-2026​