Install and use
Reference and corrections
Where the reference documentation lives, which release these pages point at, and how to suggest a correction.
Reference documentation lives with the engine, in the public repository. These pages introduce it and link to the versioned files, instead of copying them. Keeping the details in one place reduces drift.
Every link below points at the v1.4.0 release of the engine, the version these pages describe.
The file at the repository’s default branch may be newer than what you have installed.
| What you need | Where it lives |
|---|---|
| CLI commands, settings, environment, exit codes | docs/cli.md |
| Install steps, inputs, updating | docs/install.md |
| Copy install (different trust assumptions; the reusable workflow is preferred) | docs/setup-copy.md, after reading the security policy on what is executed from the head |
| How the pieces fit together | docs/architecture.md |
| The Claude Code adapter and its hardening | docs/providers/claude-code.md |
| The Codex adapter (CLI only) | docs/providers/codex.md |
| Measuring review precision | docs/precision.md |
| Security statement and unverified claims | SECURITY.md |
| Why things are the way they are | docs/adr/ |
| Every setting: inputs, environment variables, defaults, budgets | docs/configuration.md |
| What a review costs, how the budgets work and what coverage means | docs/costs.md |
| Working with reviews: asking, reading, re-reviewing and replying | docs/reviews.md |
| Failed, skipped or silent runs, by symptom | docs/troubleshooting.md |
| Short answers and limitations | docs/faq.md |
| What changed in each release | CHANGELOG.md |
Suggest a correction
Section titled “Suggest a correction”For corrections to the engine reference, send a pull request to the public repository. Its reference files are plain markdown.