Documentation

Everything you need to use readtheplan.

From first install to production CI gating. All content sourced from the repo and ADRs.

Open source MIT licensed No accounts

Guides

Install, analyze a plan, and see results in under 30 seconds. Start here.

Every command, flag, and output format for native plans and cross-tool infrastructure gates.

Gate your CI pipeline. Block dangerous changes before they reach prod.

Portable gates for GitLab, Jenkins, Azure DevOps, CircleCI, Buildkite, Bitbucket, and other runners.

Sample plans with rendered output. Safe, review, dangerous, irreversible.

ADRs covering risk classification taxonomy, compliance framework design, and agent gate contracts.

Dev setup, test commands, coding conventions, and good first issues.

readtheplan annotates every change with control IDs from these frameworks:

Security, availability, confidentiality controls. CC1-CC9 mappings.

Annex A controls. A.5-A.18 coverage for infrastructure changes.

Administrative, physical, and technical safeguards for PHI data.