Skip to content
Guided Review
Documentation

Install

Choose the CLI for local changes or the Chrome extension for GitHub pull requests. Both use the same review engine.

AppUse it when…
CLIYou’re on a local branch, commit, or working tree
Chrome extensionThe change is already a PR on github.com

Same clustering pipeline either way. The extension can submit to GitHub; the CLI keeps notes local and offers Generate Prompt. Motivation: Why. Product map: Introduction.

Choose CLI or Chrome extension

CLI — Node.js 22+, then:

npx @guided-review/cli

The published package is @guided-review/cli. The binary is guidedreview. npx guided-review (unscoped, hyphen) is a different tool. The CLI binds localhost, opens the browser UI, and walks file-by-file until you hit Structure With AI.

Chrome extension — Install from the Chrome Web Store. On a PR, click Start Guided Review (or the toolbar icon). Pin the extension so the icon stays visible.

A provider key is optional for a file-by-file walk; required for AI clustering and summaries — Configure AI provider.

Detailed docs

Full install steps, Options, flags, and day-two workflows live on the app pages:

After you install

  1. Configure an AI provider (extension Options or CLI Settings / env).
  2. Extension path: Your first review. CLI path: CLI → Follow the Walkthrough.
  3. Optionally connect GitHub if you’ll submit from the extension.

Stuck on a missing button, provider error, or port conflict: Troubleshooting.

Next. Chrome Extension · CLI · Configure AI provider · Your first review