Skip to content

docs(site): document export-gate-schema hidden build-time command #849

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

Merged
jamesadevine merged 1 commit into from
Jun 5, 2026
Merged

docs(site): document export-gate-schema hidden build-time command #849

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
24 changes: 24 additions & 0 deletions site/src/content/docs/setup/cli.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -274,6 +274,30 @@ Options:
- `--ado-project <name>` -- Azure DevOps project name override
- `--dry-run` -- validate inputs without making write calls

## Internal / build-time tools

These commands are hidden from `--help` and are intended for contributors working on the ado-aw compiler itself — not for end users or compiled pipelines.

### `export-gate-schema`

Export the gate spec JSON Schema used by the `scripts/ado-script` TypeScript workspace for type code generation. Outputs JSON to stdout or to a file.

```bash
ado-aw export-gate-schema [--output <path>]
```

Options:

- `--output`, `-o <path>` -- write the schema to a file instead of stdout; parent directories are created automatically

Typical use (from the repo root):

```bash
cargo run -- export-gate-schema --output scripts/ado-script/schema/gate-spec.schema.json
```

See the [ado-script reference](/ado-aw/reference/ado-script/) for how this command fits into the TypeScript type-codegen workflow.

## Deprecated commands

### `configure` (deprecated alias)
Expand Down