Reference

Information-oriented, exhaustive lookup. These pages describe the tool's surface as precisely as possible — they are for confirming a flag, a field, or a value, not for learning.

• CLI — every subcommand, argument, and flag.
• Configuration file — the .planwerk/config.yaml schema and precedence rules.
• Review patterns — pattern format, sources, and remote-source syntax.
• Output format — severity levels, finding fields, and the machine-readable report block.
• GitHub Action — inputs and outputs of the composite action.
• Environment variables & exit codes.
• Project structure — repository layout, workflows, and dependencies.

For task-oriented instructions see the How-to guides; for background and rationale see the Explanation section.