Skip to content
Guided Review
Documentation

Configure AI provider

Connect Anthropic, OpenAI, or Grok to group related changes into review units with summaries. Guided Review uses your provider account and API key; there is no product backend.

Choose your setup below. You can also read changed files without a key.

Chrome extension

  1. Open the extension Options page (after you install the extension).
  2. In the AI Provider card, choose a provider and model.
  3. Paste an API key from that provider’s console.
  4. Click Save, then Test Connection if you want a cheap health check before a real review.

The same Options page also has GitHub (optional, for submit) and Review → Automatically Open on Files Changed. Full Options map: Chrome Extension → Options.

CLI

  1. Run npx @guided-review/cli in your repository.
  2. Open Settings (⌘/Ctrl + ,, or Connect AI Provider when no key is set).
  3. Choose a provider and model, paste your API key, and save.
  4. Generate review units to use the provider on your diff.

You can also turn on Use My Subscription to use a coding agent already logged in on this machine. Subscription reuse is unofficial and can break; use a provider API key for a more reliable setup.

Key precedence

For each run, the CLI checks:

  1. Flags and environment variables: --provider / --model / --agent and ANTHROPIC_API_KEY / OPENAI_API_KEY / XAI_API_KEY or GROK_API_KEY.
  2. A saved key in ~/.config/guided-review/config.json (or $XDG_CONFIG_HOME / GUIDED_REVIEW_CONFIG_DIR).
  3. A coding agent already on this machine (Claude Code, Codex, or Grok).

A saved API key takes precedence over subscription reuse. Flags and environment variables take precedence for the current run.

When the CLI borrows an agent key, it reads that agent’s store at review time and does not copy the secret into Guided Review config. Details and scopes: CLI → API keys.

Supported providers

ProviderNotes
Claude (Anthropic)Anthropic’s API
OpenAIOpenAI chat completions
Grok (xAI)xAI’s OpenAI-compatible API

OpenAI and Grok share the same client shape; Anthropic uses its own streaming endpoint. Structured output for the review plan is enforced with a shared JSON schema so behavior stays consistent across backends — see How a review plan works.

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

Pick a model

Select a model available on your account. Prefer a model that handles long contexts well if you review large diffs — Guided Review chunks oversized diffs by file (~60k characters per chunk) so no single call is expected to swallow an entire monorepo change set, but each chunk still benefits from a capable model.

Models currently listed in the extension Options (ids can change as providers ship or retire models):

ProviderModels
AnthropicClaude Opus 5.5, Fable 5.1, Sonnet 5.5, Haiku 5.5; Opus 4.8, Opus 4.7, Sonnet 5, Sonnet 4.6, Haiku 4.5
OpenAIGPT-6 Astra, GPT-6.1 Sol, GPT-6 Luna; GPT-5, GPT-5 Mini, GPT-4.1, GPT-4.1 Mini, GPT-4o, o3, o4 Mini
GrokGrok 4.7, Grok 4.3; Grok 4.6, Grok 4.5, Grok 4, Grok 3, Grok 3 Mini

Newer models appear first. The CLI accepts --model <id> for any model ID your account can call, including custom IDs. If a request fails because the model is unavailable, choose an accessible replacement in Settings or pass --model <id> and retry.

The extension currently requires a model in its catalog. Both the extension and CLI normalize saved model IDs against that catalog when loading settings, so a custom or removed ID can resolve to the provider’s default. In the CLI, an explicit --model <id> takes precedence for that run. Check the active model after restarting or updating. If your chosen model is unavailable, select a replacement deliberately and use Test Connection before retrying.

Test Connection

Use Test Connection on the extension options page. That runs the same provider path as a lightweight health check and surfaces user-safe error messages if the key, model, or network path fails.

In the CLI, structuring the walkthrough with Generate review units (or fixing Settings and retrying) is the practical check — there is no separate Test button in the local UI.

If the test fails, step through Troubleshooting → Provider and API key.

Cost and usage

  • Annotate / Generate review units — one provider call per diff chunk. Small diffs usually cost one call; large ones cost one call per chunk. On the CLI this only runs when you opt in.
  • Not billed to the model — stepping units, searching, drafting comments / notes, submitting to GitHub, or Generate Prompt.
  • Test Connection — a cheap health-check request when you run it from extension Options.

Token usage and cost are entirely between you and your provider. Guided Review does not meter or resell LLM usage. Short version: FAQ → Will this run up my API bill?.

Where settings live

Keys are stored in chrome.storage.local and are only used from the background service worker when annotating a review or testing the connection. Content scripts never hold the key for outbound LLM calls. To remove a key later: Privacy & data → Clear data.

SettingStorageUsed by
Provider, model, API keychrome.storage.localExtension background worker
Automatically Open on Files Changedchrome.storage.localContent script (auto-open)
Diff view (unified / split)chrome.storage.localOverlay (default: unified)
Active review sessionchrome.storage.sessionExtension overlay
Provider, model, API key, agent~/.config/guided-review/config.jsonCLI
Local diff snapshotIn-memory for the running CLI serverCLI server
Local walkthrough and notesBrowser tab sessionStorageLocal browser UI
Local diff view (unified / split)Browser localStorageLocal browser UI

Extension session resume: Your first review → Resume later and Troubleshooting.

Next. Your first review · CLI · Chrome Extension → Options · Privacy & data