Reference
Reference is where to look up any single thing Prose exposes once a project is past the Usage chapters. Usage walks through workflows and Integrations wires them into an editor, a hook, or CI, whereas Reference answers a specific question about a flag, a facet, an exit code, a diagnostic format, a suppression directive, or the order rules run in.
The Glossary sits beneath every other reference page, because every [[term]] link across the site opens there. Start at the Glossary when a word in the docs needs a definition rather than a walkthrough.
A–Z Token Index
The index below lists every CLI flag, configuration key, exit code, output format, subcommand, and suppression directive Prose exposes. Hover an entry for its description and the page that documents it in full.
The Section at a Glance
- Cache covers the per-user cache, the
[cache]keys, the--no-cacheflag, and theprose cachesubcommands. - CLI covers every flag, how the flags combine, and the subcommand each belongs to.
- Configuration covers the
prose.toml,.config/prose.toml, andpyproject.tomlconfig files and every per-rule facet. - Exit Codes covers what each exit code means, which is the contract a CI gate reads.
- Glossary covers every term the docs use, each linked to the page that introduces it.
- Output Formats covers the
text,json,github, andsarifformats. - Pipeline Order covers the fixed order rules run in and why each rule sits where it does.
- Suppression Directives covers
# fmt: off / on,# fmt: skip, the# yapfaliases,# prose: ignore, and# prose: keep.
See Also
The Usage and Integrations sections cover the workflows these pages support. Rules lists the rules the references describe, and Primitives covers the Rust types a downstream crate links against.