Introduction
Guided Review turns a diff into an ordered walkthrough — schema first, then logic, call-sites, and tests — so you can review with intent instead of scrolling a raw change list. Same engine for GitHub pull requests and local git work. For the motivation behind that, see Why.
What is Guided Review?
Guided Review is two surfaces on one review engine:
| Surface | What you review | How you start |
|---|---|---|
| Chrome extension | Pull requests on github.com | Start Guided Review on the PR page |
| CLI | Local branch, commit, or working tree | npx @guided-review/cli → browser UI on localhost |
On either path:
- The real unified diff is parsed into files, hunks, and lines
- With your AI provider configured (Anthropic, OpenAI, or Grok), the model returns review units — logical groups of hunks with short commentary
- You step through those units in a keyboard-first overlay; the code you see always comes from the real parsed diff
Without a key you still get a file-by-file walk. The model plans structure and commentary only — it never invents the code lines. For what leaves your machine, see Privacy & data.
The extension can optionally submit reviews to GitHub. The CLI keeps line notes local and can Generate Prompt for a coding agent instead.
What you'll find here
Getting Started
Apps
- Chrome Extension — Install from the Web Store, then Start Guided Review on a PR
- CLI — npx @guided-review/cli for local branch, commit, or working-tree diffs
Setup
- Configure AI provider — API keys for extension and CLI, models, and usage cost
- Connect GitHub — optional auth for submitting reviews from the extension
Product
- Your first review — from a PR page to walking and searching units
- Reading the overlay — layout of the review UI for extension and CLI
- How a review plan works — units, chunking, no-AI fallback, and what the model may invent
- Images & binary files — image previews, binary empty state, comments and search
- Leave line comments — comment mode, drafts, multi-line ranges
- Generate Prompt — clipboard prompt from local notes for a coding agent
- Submit a review — Comment / Approve / Request Changes from the extension
- Keyboard shortcuts — navigate, search, comment, submit, and CLI extras
Help
- Troubleshooting — common failures and fixes for extension and CLI
- FAQ — free, cost, tracking, extension vs CLI, what the AI does
Trust
- Privacy & data — what leaves your machine, what stays, and how to clear it
Quick start
Start at Install for both hosts, then:
GitHub pull requests
- Install the Chrome extension (or follow Install).
- Configure a provider (optional for a file-by-file walk).
- Open any GitHub pull request and click Start Guided Review.
- Follow the walkthrough — see Your first review.
- Optionally draft line comments and submit (needs GitHub connected).
Local changes
- Install / run the CLI with Node.js 22+:
npx @guided-review/cli. - Pick a diff scope (branch vs base, uncommitted, or a commit).
- Optionally hit Structure With AI, then walk the units.
- Full local workflow: CLI.
Open source. Guided Review is Apache-2.0. Source and issues live on GitHub. Stuck? Start with the FAQ or Troubleshooting.