Skip to main content

corgi docs check

corgi docs check​

Docs that mention what the diff changed, and pointers that no longer land

Synopsis​

Reads the stack's changed surface (exported symbols, routes, contracts, migrations, config) against a base branch, then finds every Markdown file that names one of them - those are the docs to re-read. Also checks the file:line pointers in CLAUDE.md, AGENTS.md and .claude/rules against the tree.

corgi docs check corgi docs check --base develop --json corgi docs check --branch feature/ABC-123/limits

Exit 1 when something needs a look, so it can gate a merge.

corgi docs check [flags]

Options​

--base string base branch (default: main)
--branch string check the existing worktrees of this branch instead of the checkouts
-h, --help help for check

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​