Skip to content

Commit 5fcb783

Browse files
docs(site): document export-gate-schema hidden build-time command (#849)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent 6c0697b commit 5fcb783

1 file changed

Lines changed: 24 additions & 0 deletions

File tree

site/src/content/docs/setup/cli.mdx

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -274,6 +274,30 @@ Options:
274274
- `--ado-project <name>` -- Azure DevOps project name override
275275
- `--dry-run` -- validate inputs without making write calls
276276

277+
## Internal / build-time tools
278+
279+
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.
280+
281+
### `export-gate-schema`
282+
283+
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.
284+
285+
```bash
286+
ado-aw export-gate-schema [--output <path>]
287+
```
288+
289+
Options:
290+
291+
- `--output`, `-o <path>` -- write the schema to a file instead of stdout; parent directories are created automatically
292+
293+
Typical use (from the repo root):
294+
295+
```bash
296+
cargo run -- export-gate-schema --output scripts/ado-script/schema/gate-spec.schema.json
297+
```
298+
299+
See the [ado-script reference](/ado-aw/reference/ado-script/) for how this command fits into the TypeScript type-codegen workflow.
300+
277301
## Deprecated commands
278302

279303
### `configure` (deprecated alias)

0 commit comments

Comments
 (0)