corgi vocab
corgi vocab
Explain any error code, compose field, command or flag in one answer
Synopsis
Answers for one name without reading the docs: an error code (E_PORT_CONFLICT), a corgi-compose.yml key (depends_on_db, healthCheck, driver), a command (run, agent watch) with every flag it takes, or a flag (--detach) with the commands that take it. With no name, lists the error codes and the commands.
An unknown name is refused with the closest match, and exit 1. Under --json the answer is one object with a "kind" of code, field, command or flag.
corgi vocab <name> [flags]
Examples
corgi vocab E_READINESS_TIMEOUT
corgi vocab depends_on_db --json
corgi vocab agent watch
corgi vocab --detach
Options
-h, --help help for vocab
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
-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
--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