Skip to content

docs

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

docs

README.md

CLI reference

Source content for the CLI reference published on the Supabase docs site.

  • supabase/ — long-form command descriptions, one file per command path
  • templates/examples.yaml — per-command usage examples, keyed by doc id

Build

bun scripts/generate-docs-spec.ts > cli_v1_commands.yaml

Release

  1. Clone the supabase/supabase repo
  2. Copy over the CLI reference and reformat
mv ../cli/apps/cli/cli_v1_commands.yaml apps/docs/spec/
npx prettier -w apps/docs/spec/cli_v1_commands.yaml
  1. If there are new commands added, update common-cli-sections.json manually

Maintenance

When adding or changing a command or flag, update the matching entries in src/legacy/docs/legacy-docs-spec.tables.ts — each table's doc comment says when it applies: TAGS, DEFAULT_OVERRIDES, REQUIRED, EXPERIMENTAL (and _OPTIONAL), EXCLUDED (whole commands), EXCLUDED_FLAGS, ARG_OVERRIDES, CHOICE_OVERRIDES, EXTRA_FLAGS. The spec build fails on entries that no longer resolve against the command tree, but new commands and flags must be added by hand — nothing detects a missing entry for a new surface.