Skip to content
Guided Review
Documentation

FAQ

Short answers to the questions people ask before and after install. Longer how-tos live in the rest of the docs — start from the Introduction if you’re new.

How does it work?

Install the Chrome extension, open a GitHub PR, click Start Guided Review. The extension reads the PR diff, calls your AI provider for an ordered set of review units, and shows them in an overlay mapped back to the real hunks. You step through (first review), comment, and optionally submit a review. Pipeline detail: How a review plan works. Keyboard-first path: Keyboard shortcuts.

Do you track anything?

The extension does not track review activity and does not talk to Guided Review servers — only GitHub and your AI provider. The marketing site may include anonymous analytics. Full breakdown: Privacy & data.

Is it free forever?

Forever is a long time. It’s free while it can be maintained for free. If demand grows and maintenance can’t stay free, something for compensation might show up later. It’s open source — you can fork it if you need to. Getting set up costs only your own provider usage (Configure AI provider).

Does the AI approve PRs?

No. The model clusters and orders changes and writes short guidance (How a review plan works). You read the code and you submit approve / comment / request changes. Take unit summaries with a grain of salt.

Which AI providers?

Anthropic (Claude), OpenAI, and Grok (xAI). You bring your own API key. Setup and model list: Configure AI provider. Connection failures: Troubleshooting.

We’ll keep adding more providers — request one on the repo, or open a PR that adds yours.

Do I need GitHub auth?

Not to generate a plan or walk units (Your first review). Yes, if you want to submit a review (line comments and overall decision) from the overlay. Drafting comments works offline of GitHub auth. Scopes, SSO, and disconnect: Connect GitHub.

Where is the code?

github.com/nshntarora/guidedreview (Apache-2.0). Issues and PRs welcome when something’s wrong or unclear. Load-from-source: Install → Load unpacked.

Note