Skip to main content

corgi docs commands

corgi docs commands​

Every corgi command and flag named in Markdown exists in this binary

Synopsis​

Reads each corgi invocation in the code of Markdown files (inline code and fenced blocks) and checks it against this binary: the command path exists, and every --flag is one that command takes. A skill or guide that names a flag the CLI does not parse teaches an agent a command that fails.

With no paths it reads ./docs, ./plugins and README.md. Exit 1 on a finding, each with the nearest real command or flag.

corgi docs commands corgi docs commands plugins/corgi/skills --json

corgi docs commands [<file or dir>…] [flags]

Options​

-h, --help help for commands

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
--generate Generate cobra docs. Useful for development only, because it updates corgi docs.
-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
--json-schema Print the JSON Schema (draft-07) for corgi-compose.yml and exit.
--privateToken string Private token for private repositories to download files
-o, --runOnce Run corgi once and exit
--silent Hide all welcome messages

SEE ALSO​

Auto generated by spf13/cobra on 16-Nov-2026​