Skip to main content

corgi surface

corgi surface

What a reviewer reads first: the public slice of the stack's diff

Synopsis

Lists the exported symbols, routes, contracts, migrations and config files the current branches changed in every repository of the stack, against a base branch, with removals and signature changes marked breaking. No toolchain needed: it reads the diff. Paste the Markdown into the pull request body; review it before the diff.

corgi surface corgi surface --base develop --json corgi surface --branch feature/ABC-123/limits # the branch's worktrees

corgi surface [flags]

Options

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

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