Skip to main content

corgi validate

corgi validate

Statically validate corgi-compose.yml

Synopsis

Runs static semantic checks over corgi-compose.yml without starting containers, cloning repos, or touching the network.

Errors (exit 1):

  • depends_on_services / depends_on_db references a name that doesn't exist
  • a cycle exists in the depends_on_services graph
  • db_services.driver is not a known driver
  • a service exposes a port but has no start command and no docker runner
  • two services / db_services bind the same host port

Warnings (non-fatal, fatal under --strict):

  • a depended-on service has no healthCheck (TCP probe used)
  • cloneFrom is set without a branch

Flags: --json Emit {"ok":bool,"errors":[...],"warnings":[...]} --strict Treat warnings as failures

corgi validate [flags]

Options

-h, --help help for validate
--strict Treat warnings as failures

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
--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
Auto generated by spf13/cobra on 8-Jun-2026