Reference#
Information-oriented pages: what exists, what it is called, what it defaults to. Nothing here teaches a workflow — for that, work through the tutorials, or start at Getting started.
Page |
Answers |
|---|---|
Which commands and flags exist, and what each exit code means |
|
Every key of |
|
What each material state means, and which transitions are legal |
Two of these pages cannot drift from the code, by construction. The command
reference is rendered from the real Typer application at build time, so it
is the same text --help prints. The configuration and state pages are written
by hand, and the test suite checks them against the real schema, the real stage
constructors and the real state machine on every run — a field or a state that
is not documented here fails a test.
For the Python API behind all of this — the value objects, the stage and backend contracts, the orchestrator — see API reference.