Skip to main content

corgi status

corgi status​

Healthcheck every declared service and db_service

Synopsis​

Verifies every db_service and (non-manualRun) service declared in corgi-compose.yml is reachable on its port.

For each db_service:

  • TCP connect on localhost:<port>. If 'healthCheck' is set, or the driver is 'localstack', corgi additionally does an HTTP GET and accepts any non-5xx response as healthy.

For each service:

  • TCP connect on localhost:<port>. If 'healthCheck' is set, corgi does GET http://localhost:<port><healthCheck> and accepts any non-5xx response.

Exit code is non-zero if anything's down so CI / scripts can consume it.

corgi status [flags]

Options​

  -h, --help   help for status

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 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
      --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
Auto generated by spf13/cobra on 23-Apr-2026​