Skip to main content

corgi env check

corgi env check​

Fail when a service's env file misses keys its .env-example declares

Synopsis​

Diff each service's env source against the example file its repo commits (.env-example or .env.example), subtracting every key corgi generates itself (db and service dependencies, ports, environment literals). What remains is a key the service expects and nothing provides — the kind that fails at the first request, thousands of log lines from the cause.

Exits non-zero on any missing key, on a declared env source that does not exist while the example still needs keys, and when nothing could be checked at all — a vacuous pass would read as coverage.

Empty values are not findings: an empty key is often a deliberate off switch.

Examples: corgi env check # each service's resolved env source corgi env check api # just one service corgi env check --file .env.ci # a committed CI env file in each repo corgi env check --json

corgi env check [service...] [flags]

Options​

      --file string   Check this file inside each service repo instead of the resolved env source
  -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 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
      --tier string               Resolve env for this compose envTier (e.g. staging, prod)

SEE ALSO​

  • corgi env - Print services' fully-resolved environment (read-only)
Auto generated by spf13/cobra on 31-Aug-2026​