Skip to content
Guided Review
Documentation

Install the extension

Guided Review runs as a Chrome Manifest V3 extension. Install it once, then use it on any github.com pull request. For the “why” and product map, see the Introduction.

Chrome Web Store

  1. Open the Guided Review listing on the Chrome Web Store.
  2. Click Add to Chrome and confirm.
  3. Pin the extension from the puzzle-piece menu if you want one-click access to options.
Note

Store ID placeholder. If the store link still shows a placeholder ID, use the install button on guidedreview.com or install from source below. Site shortcut: ⌘/Ctrl + I — see Keyboard shortcuts.

Load unpacked (development)

For local builds and contributors:

  1. Clone the repository.
  2. From the monorepo root, install and build the extension:
npm install
npm run build:extension
  1. Open chrome://extensions, enable Developer mode, and click Load unpacked.
  2. Select apps/extension/dist — never a root-level dist/ if one exists from an older layout.
  3. After code changes, run npm run build:extension again, then hit Reload on the extension card and refresh the GitHub PR tab.
Note

Dev HMR. npm run dev / npm run dev:extension serves Vite HMR on port 5173, but Chrome still loads the built files under apps/extension/dist. Rebuild (or rely on the dev pipeline that writes there) and reload the extension when behavior looks stale. More on stale builds: Troubleshooting.

After install

  1. Open the extension Options page (right-click the extension icon → Options, or open it from chrome://extensions).
  2. Configure an AI provider and save your API key.
  3. Optionally connect GitHub if you want to submit reviews from the overlay.
  4. Open a PR and follow Your first review.

Keys and tokens stay on your machine — details in Privacy & data. If the Start Guided Review button never appears, see Troubleshooting.

← PreviousIntroductionNext →Your first review