Skip to main content

corgi doctor

corgi doctor​

Preflight checks: required tools, Docker, port availability

Synopsis​

Preflight checks for running this corgi-compose.

Verifies in order:

  1. Every tool declared in the 'required:' block is installed (offers install if present and interactive).
  2. Docker daemon is reachable (skipped if no db_services are declared).
  3. Every port used by db_services and services is free. Ports already in use are reported with the owning process (COMMAND, pid).

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

corgi doctor [flags]

Options​

  -h, --help   help for doctor

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​