Factual, low-narrative contracts: output formats, schemas, exit codes. Several
pages are generated from their source (the clap command tree, the exit-code
Category, and the JSON schemas) by ost internal docs generate and checked for
drift in CI — do not edit them by hand.
| Document | Source | Purpose |
|---|---|---|
| cli.md | generated (clap command tree) | Every ost command, its arguments and options. |
| exit-codes.md | generated (ost_core::Category) |
The category → exit-code contract. |
| schemas.md | generated (schemas/*.json) |
The JSON Schemas ost validates documents against. |
| support-matrix.md | generated (support/platforms.toml) |
Per-feature, per-platform support levels. |
| environment-variables.md | generated (support/environment-variables.toml) |
Supported OST environment, CI, and CMake-cache variables. |
| json-output.md | hand-written | The --json output contract: envelope, error codes, and compatibility policy. |
| artifact-policy.md | hand-written | Artifact trust levels, policy TOML schema, matching rules, and stable errors. |
| artifact-evidence.md | hand-written | SPDX SBOM and SLSA/in-toto provenance generation, transport, and verification. |
| external-build-provenance.md | hand-written | Imported CMake identity, generator sources, scoped requirements, and validation semantics. |
| template-catalog.md | hand-written | Embedded scaffold ids, maturity, inputs, provenance, and copied CMake helper contract. |
| plugin-workspace.md | hand-written | Bundle dependency declarations, schema contracts, graph validation, and stable issue codes. |
| host-discovery.md | hand-written | DCC host providers, [host.discovery] config, status/confidence model, fingerprints, inventories, and stable codes. |
To regenerate the generated pages, from the repository root:
cargo run -q -p ost-cli -- internal docs generate