Reference

Reference is the lookup surface for everything Prose exposes once a project is past the Usage chapters. Where Usage walks workflows and Integrations wraps them at boundaries, Reference answers shaped questions about flags, knobs, codes, diagnostic shapes, suppression directives, and the deterministic order rules fire in.

The Glossary is the substrate underneath every other reference page, because every [[term]] link on every page across the whole site lands there. Start at the Glossary when a word in the docs needs a definition rather than a workflow.

A–Z Token Index

Every CLI flag, configuration key, exit code, output format, subcommand, and suppression directive Prose exposes. Hover any entry for its description and the destination page that documents it in full.

CLI Flag10 entries

• --color
• --diff
• --ignore <slug>
• --no-cache
• --output-format
• --quiet
• --select <slug>
• --stdin
• --validate
• --verbose

Configuration Key11 entries

• cache.enabled
• cache.max-size-mib
• code-line-length
• docstring-line-length
• docstring-structured-policy
• enabled
• import-line-length
• imports.first-party
• max-shift
• max-shift-policy
• target-version

Exit Code5 entries

• 0
• 1
• 2
• 3
• 4

Output Format4 entries

• github
• json
• sarif
• text

Subcommand7 entries

• prose cache clean
• prose cache compact
• prose cache info
• prose check
• prose completions
• prose format
• prose server

Suppression Directive7 entries

• # yapf: disable
• # yapf: enable
• # prose: ignore[<slug>]
• # prose: keep
• # fmt: off
• # fmt: on
• # fmt: skip

The Section at a Glance

• Cache covers the user-level cache, the [cache] knobs, the --no-cache flag, and the prose cache clean subcommand.
• CLI covers every flag, its precedence, and the subcommand it belongs to.
• Configuration covers the prose.toml and pyproject.toml config files and per-rule knobs.
• Exit Codes covers the five-code contract CI gates compile against.
• Output Formats covers text, json, github, and sarif shapes.
• Pipeline Order covers the deterministic order rules fire in, with rationale per rule.
• Suppression Directives covers # fmt: off / on, # fmt: skip, # yapf aliases, and # prose: ignore / # prose: keep.
• Glossary covers every term used in the docs, with cross-links to every page that introduces it.

See Also

For the workflow context behind any of these surfaces, see Usage and Integrations. For the rule catalog the references describe, see Rules. For the primitive surface a downstream Rust caller links against, see Primitives.