Documentation
Introduction
Guided Review turns a GitHub pull request into an ordered walkthrough — schema first, then logic, call-sites, and tests — so you can review with intent instead of scrolling a raw diff.
What is Guided Review?
Guided Review is a Chrome extension for GitHub pull requests. On a PR page it adds a Start Guided Review button. When you start a review, the extension:
- Reads the PR’s unified diff (fetched through the extension’s background worker)
- Sends that diff to your configured AI provider (Anthropic, OpenAI, or Grok)
- Turns the response into a sequence of review units — logical groups of hunks with short commentary
- Shows those units in an overlay so you can step through the change set in a sensible order
You stay on GitHub. Your API key stays in the extension. The model plans structure and commentary; the code you see always comes from the real parsed diff. For what leaves your machine, see Privacy & data.
What you'll find here
Getting started
- Install the extension — Chrome Web Store or load unpacked for development
- Your first review — from a PR page to walking units
Setup
- Configure AI provider — API keys, models, and connection checks
- Connect GitHub — optional auth for submitting reviews from the overlay
Product
- How a review plan works — units, chunking, and what the model is allowed to invent
- Leave line comments — comment mode, drafts, multi-line ranges
- Submit a review — Comment / Approve / Request Changes from the overlay
- Keyboard shortcuts — navigate, comment, and submit without leaving the keyboard
Help & trust
- Troubleshooting — common failures and fixes
- FAQ — free, tracking, what the AI does and doesn’t do
- Privacy & data — what leaves your machine and what doesn’t
Quick start
- Install the extension.
- Open the options page and configure a provider.
- Open any GitHub pull request and click Start Guided Review.
- Step through the plan — see Your first review for details.
- Optionally draft line comments and submit a review (needs GitHub connected).
Note
Open source. Guided Review is Apache-2.0. Source and issues live on GitHub. Stuck? Start with the FAQ or Troubleshooting.