Skip to content

docs: document export-ado-proxy-catalog{,-schema} hidden CLI commands #1852

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
github-actions wants to merge 1 commit into
base: main
Choose a base branch
from
+11 −1
Draft

docs: document export-ado-proxy-catalog{,-schema} hidden CLI commands #1852

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -395,7 +395,9 @@ index to jump to the right page.
`check`, `mcp`, `execute`, `secrets`, `enable`, `disable`,
`remove`, `list`, `status`, `run`, `audit`, `mcp-author`, `trace`,
`inspect`, `graph`, `whatif`, `lint`, `catalog`; `configure` is a
deprecated hidden alias; `export-gate-schema` and `export-fact-catalog` are hidden build-time tools).
deprecated hidden alias; `export-gate-schema`, `export-fact-catalog`,
`export-ado-proxy-catalog-schema`, and `export-ado-proxy-catalog` are hidden
build-time tools).
- [`docs/agency-plugin.md`](docs/agency-plugin.md) — the Agency / Claude Code
plugin (`agency/plugins/ado-aw/`): canonical layout, six skills, `mcp-author`
wiring, the self-contained root marketplace catalogs, `init --agency`
Expand Down
8 changes: 8 additions & 0 deletions docs/cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -192,6 +192,14 @@ These commands are not shown in `--help` but are available for contributors work
- `--output, -o <path>` - Write the catalog to a file instead of stdout. Parent directories are created automatically.
- Typical use: `cargo run -- export-fact-catalog --output scripts/ado-script/src/trigger-e2e/fact-catalog.gen.json`

- `export-ado-proxy-catalog-schema` - Export the `ado-proxy` catalog JSON Schema used by the `scripts/ado-script` TypeScript workspace for type codegen (`ado-proxy-catalog.types.gen.ts`).
- `--output, -o <path>` - Write the schema to a file instead of stdout. Parent directories are created automatically.
- Typical use: `cargo run -- export-ado-proxy-catalog-schema --output schema/ado-proxy-catalog.schema.json`. See [`docs/ado-script.md`](ado-script.md).

- `export-ado-proxy-catalog` - Export the versioned deny-by-default `ado-proxy` read-operation catalog as JSON (`catalog.gen.json`). Drift guard between the Rust-side catalog and the bundle's committed snapshot; `catalog-drift.test.ts` re-runs the exporter and fails on any diff.
- `--output, -o <path>` - Write the catalog to a file instead of stdout. Parent directories are created automatically.
- Typical use: `cargo run -- export-ado-proxy-catalog --output src/ado-proxy/catalog.gen.json`. See [`docs/ado-script.md`](ado-script.md).

### Hidden Pipeline-Internal Commands

These commands are started by the pipeline itself (or by AWF on its behalf) and are not part of the authoring surface:
Expand Down