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.

Modes: -w, --watch Repoll continuously and redraw the table in place (live timestamp + counts). Falls back to append-only transition lines for piped stdout, --json, or --quiet. -r, --ready Block until every target is up. Exit 0 when all healthy, exit 1 on --timeout (default 5m). Alias: --until-healthy. --service csv Narrow probes to listed services. --json Machine-readable. One-shot: array. Watch/ready: NDJSON per transition. -q, --quiet Suppress per-line output; rely on exit code only.

corgi status [flags]

Options​

  -h, --help                help for status
  -i, --interval duration   Delay between watch polls (default 2s)
      --json                Emit machine-readable JSON. One-shot: array. Watch: NDJSON one-per-transition.
  -q, --quiet               Suppress per-line output; rely on exit code only
  -r, --ready               Exit 0 once every probed target is up; exit 1 on --timeout (alias: --until-healthy)
      --service strings     Limit checks to listed services (csv); applies to both services + db_services
      --timeout duration    Max wait for --until-healthy (default 5m0s)
      --until-healthy       Same as --ready
  -w, --watch               Repoll continuously; press Ctrl+C to stop

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
      --interactive               Force interactive prompts even when no TTY/agent detected
      --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 22-Jul-2026​