Skip to content

archgate review-context

Pre-compute review context with ADR briefings for changed files. Designed for CI and editor plugin integrations that need a summary of which ADRs apply to the files being changed.

Terminal window
archgate review-context [options]
OptionDescription
--stagedOnly include git-staged files
--base [ref]Compare changed files against a base ref (auto-detects when omitted)
--run-checksInclude ADR compliance check results
--domain <domain>Filter to a single domain
--verboseInclude each ADR’s Decision and Do’s/Don’ts prose
Terminal window
archgate review-context --staged

By default each ADR is identified by id, title, domain, files, and rules only — enough to know which ADRs apply to the changed files. Read the ones you need with archgate adr show <id>.

Pass --verbose to embed every applicable ADR’s Decision and Do’s/Don’ts prose in the response instead. That prose grows with the number of matched ADRs and dominates the payload — on this repository it is ~78% of the output (roughly 70KB versus 6KB without it), which is large enough that agent harnesses stop displaying the result inline. Prefer the default and drill down; reach for --verbose only when a single self-contained payload is genuinely required.

When --run-checks is passed, checkSummary follows the same rule as archgate check --json: its results array carries only rules with something to report, while the counts beside it still cover every rule that ran.