> ## Documentation Index
> Fetch the complete documentation index at: https://docs.coderabbit.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Review local changes in your editor

> Choose a review scope and base branch, start CodeRabbit reviews manually or after each commit in VS Code, Cursor, and other editors, and understand the limits, files, and settings a local review uses.

A review sends your changed files to CodeRabbit and streams the results back while it runs. To run your first review:

1. Select the CodeRabbit icon in the activity bar to open the CodeRabbit sidebar.
2. In **Changes to review**, pick a [scope](#pick-a-scope). A new repository starts with **All changes**, which includes the commits on your branch. To review only the work you haven't committed, pick **Uncommitted changes**.
3. Select the review button.

![CodeRabbit Review view showing the current branch, Compare against set to origin/main, Changes to review set to All changes, the Review all changes button, four changed files with Git status letters, and History](https://mintcdn.com/coderabbit/2RIHQao-Fh3bt8gQ/assets/images/ide-review-workspace.png?fit=max\&auto=format\&n=2RIHQao-Fh3bt8gQ\&q=85\&s=03afec4fbafafcdd241bce8477c4233c)

The Review view on a feature branch, ready to review all changes against origin/main

Results appear in the **Findings** and **Nitpicks** views and as comments in the editor; see [Work with review findings](https://docs.coderabbit.ai/ide/findings.md).

## Before you start

You need to be [signed in](https://docs.coderabbit.ai/ide/sign-in.md) and to have a folder with a Git repository open. When something is missing, the **Review** view says so and offers a button:

| The view shows | What to do |
| - | - |
| "No workspace open" | Select **Open Workspace** and open your project folder. |
| "Enable Git to get started" | Select **Enable Git and Refresh**, then **Enable Git** in the dialog that asks "Git is disabled for this workspace. Do you want to enable it?". The extension turns on Git for the workspace and reloads the window. |
| "Git repository required" | Open the folder that contains your repository, or select **Initialize Git** to run `git init` in the workspace folder. |

## The Review view

Select the CodeRabbit icon in the activity bar to open the CodeRabbit sidebar. It holds the **Review** view and, once a review has results, the **Findings** and **Nitpicks** views.

The **Review** view, from top to bottom:

* **Account & usage**: your organization, plan, and usage. CodeRabbit Cloud only; see [Check your plan and usage](https://docs.coderabbit.ai/ide/sign-in.md#check-your-plan-and-usage).
* **Repository**, with **Switch repository** and **Switch worktrees**: shown only when the workspace has more than one Git repository or worktree.
* **Current**: the branch you are on. A detached HEAD shows a short commit hash.
* **Compare against**: the base branch.
* **Changes to review**: the review scope.
* The review button, labeled for the scope, such as **Review all changes**.
* The "N changed files" list, with a Git status letter on each file. Select the count to collapse or expand the list.
* **History**: your earlier reviews of this branch. See [Revisit earlier reviews](https://docs.coderabbit.ai/ide/findings.md#revisit-earlier-reviews).

## Choose what to review

### Pick a scope

Pick the scope in **Changes to review**:

| Scope | What it covers |
| - | - |
| **All changes** | Committed and uncommitted changes together. This is the scope a new repository starts with. |
| **Committed changes** | Commits on the current branch since its merge base with the base branch. When the base branch has a remote-tracking branch, such as `origin/main`, the extension compares against that; a base branch with no remote uses the local branch. |
| **Uncommitted changes** | Changes in your working tree and index. |

A scope with nothing to review is disabled, and the menu shows the reason, such as "No uncommitted changes to review". The extension remembers your scope for each repository.

### Pick the base branch

The base branch is the branch your work merges into, usually `main`. The extension picks the first of these that exists:

1. The base branch you chose earlier for this repository.
2. `origin/HEAD`.
3. The first local branch named `main`, `master`, `develop`, or `development`.
4. The branch Git records as the base of your current branch.

To change it, select **Compare against** and pick a branch. The list shows local branches only. Your choice applies to the whole repository, not only to the current branch.

The extension never fetches. A remote-tracking branch, such as `origin/main`, is only as current as your last `git fetch`, so fetch first if the base branch has moved on the remote.

A review always covers the branch you have checked out. To review a different branch, check it out first.

### Select files

In the **Uncommitted changes** scope, each file has a checkbox, and the button reads "Review N selected files":

* Use **Search files** to filter the list, and **Select all** or **Clear all** to change every checkbox. While a search is active, these become **Select shown** and **Clear shown**.
* New files are selected when they appear. Files you cleared stay cleared.
* Select a file name to open its diff, titled "Changes being reviewed:" followed by the file name.

**All changes** and **Committed changes** have no checkboxes. To review fewer files in those scopes, pick a closer base branch or add [path filters](#what-gets-reviewed). Path filters keep a file out of the review but not out of the upload; to keep a file such as `.env` from being sent, see [Keep secrets out of reviews](https://docs.coderabbit.ai/ide/privacy.md#keep-secrets-out-of-reviews).

## Start a review

Select the review button, or run **CodeRabbit: Start Review** from the Command Palette. Both review the scope selected in the **Review** view. In **Uncommitted changes**, the button reviews only the files you selected, while the command reviews every uncommitted file.

Before the review starts, the extension may stop to ask you something:

* "The organization is still updating. Try the review again shortly." appears while the extension matches your repository to an organization. Start the review again after a moment. See [Choose the organization for reviews](https://docs.coderabbit.ai/ide/sign-in.md#choose-the-organization-for-reviews).
* If a review is already running, "A review is already in progress. What would you like to do?" offers **Continue with existing review** and **Cancel existing review and start new one**.
* If you don't have a seat in the organization, a dialog offers **Start free review**. See [Seats and limits](#seats-and-limits).

## Seats and limits

This section applies to CodeRabbit Cloud.

### Without a seat

If your organization's plan uses seats and you don't have one, starting a review opens this dialog:

> Your account does not have an active CodeRabbit seat for the "…" organization. Start a free review? Free reviews are limited to 3 per hour and do not use the organization's plan, settings, or credits.

Select **Start free review** to continue, or ask an organization administrator for a seat; see [Seat assignment](https://docs.coderabbit.ai/management/seat-assignment.md).

A free review without a seat is not the Free plan. On the Free plan, you don't need a seat, and this dialog doesn't appear.

If every seat in the organization is assigned, the review doesn't start; see [All seats in the organization are assigned](https://docs.coderabbit.ai/ide/troubleshooting.md#all-seats-in-the-organization-are-assigned).

### Hourly limits

IDE reviews have their own hourly limit per developer, set by your plan and counted separately from pull request reviews and CLI reviews. The **IDE** column in [Rate limits](https://docs.coderabbit.ai/management/plans.md#rate-limits) lists the number for each plan, including Free. Automatic reviews after a commit count toward it.

The hour is rolling, so the limit doesn't reset all at once on the hour: each review counts for one hour after it starts, then frees its place. The adaptive limits that can lower the pull request review allowance after heavy use don't apply to IDE reviews.

When you reach the limit, the review doesn't run, and "Rate limit exceeded. Wait … before making another request." appears with the waiting time.

If your organization uses [usage-based reviews](https://docs.coderabbit.ai/management/usage-based-addon.md) and lets members choose when to use them, the message also gives the number of billable files and the most the review can cost, and offers **Review with credits**. Selecting it runs the review right away and bills it to your organization's usage. During a promotion, the button reads **Run review for free** instead. If the organization changed since the offer, the extension asks you to check the selected organization and start the review again. Free reviews without a seat can't use credits.

### File limits

A review can include up to 300 files with a paid seat or a trial, and up to 150 files on the Free plan and for free reviews without a seat. The count is the files left after [path filters](#what-gets-reviewed), which CodeRabbit applies after the upload: only the files changed since the last review for a [follow-up review](#review-again-after-more-changes), and only the files you selected in **Uncommitted changes**.

The extension doesn't warn you before it sends the files. A review over the limit is skipped with "Too many files!"; see [troubleshooting](https://docs.coderabbit.ai/ide/troubleshooting.md#too-many-files-in-the-review) for ways to fit.

## Review automatically after each commit

`coderabbit.autoReviewMode` controls what happens when a new commit lands on your branch:

| Value | What happens after a commit |
| - | - |
| `prompt` (default) | A notification quotes the start of the commit message and asks "Would you like to start a review?" with **Yes** and **No**. If you don't answer within 30 seconds, it counts as **No**. |
| `auto` | A notification "Starting review for commit:" with the commit message counts down 10 seconds. Cancel it to skip the review; otherwise the review starts. |
| `disabled` | Nothing. |

Any change to the current commit of the repository selected in the **Review** view counts, whoever makes it: the Source Control view, a terminal, a coding agent, or another Git tool. Amending, rebasing, and cherry-picking count too. Only commits dated within the last 30 seconds trigger a review, so checking out or pulling older commits doesn't start one.

An automatic review always covers committed changes, whatever **Changes to review** shows, and is labeled "Automatic" in the **Review** view and in **History**. Each one counts toward your [hourly limit](#hourly-limits).

Change the setting in the [settings reference](https://docs.coderabbit.ai/ide/settings.md#settings-reference).

## Follow a review in progress

While a review runs, a bar at the top of the **Review** view shows "Review in progress" and a **Stop Review** button. Progress steps appear as CodeRabbit reaches them, such as "Setting up", "Preparing sandbox", "Building code graph", "Processing tool runs", "Analyzing changes", and "Reviewing files".

Findings arrive while the review runs, so you can start reading before it finishes. The first one shows a notification, with **Show Review** when the CodeRabbit sidebar is hidden.

A review ends in one of these states:

* "Review complete".
* Completed with warnings: the view shows the warning and "Files reviewed: X/Y".
* "Review failed": the view shows the reason. Findings received before the failure stay in the results.

These actions cancel a running review:

* **Stop Review**.
* Reloading the editor window.
* Switching branches. The review appears as cancelled in that branch's **History**, and its results aren't added to the editor.

A review that doesn't get past "Setting up" within 5 minutes is cancelled with "Review setup timed out. Please try again." See [troubleshooting](https://docs.coderabbit.ai/ide/troubleshooting.md#review-is-stuck-on-setting-up).

If the repository isn't connected to CodeRabbit for pull request reviews, a one-time notification after you start a review offers **Open repository settings** in the CodeRabbit app. Reviews in the editor continue either way.

### Get notified when a review finishes

Turn these on in the [settings reference](https://docs.coderabbit.ai/ide/settings.md#settings-reference) if you switch to other work while a review runs:

* `coderabbit.completionNotifications`: shows "CodeRabbit review completed" with **Show Review** when a review finishes. On a local macOS desktop, you also get a Notification Center alert, which macOS may attribute to Script Editor; allow notifications for Script Editor if you don't see it.
* `coderabbit.reviewCompletionSound`: plays a chime when a review completes. It plays only if you opened the CodeRabbit sidebar in that window.

## Review again after more changes

After a review completes on a branch, the next review on that branch is an incremental review, which covers only what changed since the last commit that review covered:

* In **All changes** and **Committed changes**, the changed-file list shrinks to match.
* In **Uncommitted changes**, the list still shows every uncommitted file, but the review sends only the files whose content changed since the last review.

If nothing changed since the last review, you see "No changes to review".

The next review is a full review of the whole branch when the last reviewed commit is no longer in the branch's history, for example after you amend that commit, rebase, or reset to an earlier commit. It's also a full review when the base branch has commits that your branch doesn't contain yet, for example after a fetch moved `origin/main` ahead.

To run a full review at any other time, clear the branch's earlier reviews in **History**, then start a review. Clearing deletes those reviews and their findings. See [Revisit earlier reviews](https://docs.coderabbit.ai/ide/findings.md#revisit-earlier-reviews).

A new review doesn't close the findings of earlier reviews. Their unresolved findings stay in **History** and as comment threads in the editor until you resolve them, while **Findings** and **Nitpicks** show the new review's results. **Ignore** isn't sent to CodeRabbit, so a later review can raise an ignored finding again when it reviews that code, for example after you change the file or in a full review.

## What gets reviewed

The extension reviews the changes Git reports, with paths relative to the workspace folder you opened. Opening a folder inside a larger repository works.

Some files are never reviewed:

* Built-in exclusions that you can't change: build output and dependency folders such as `dist/` and `node_modules/`, lockfiles, minified and source map files, generated code folders, and binary, media, archive, and data files.
* Untracked files that Git ignores, while `coderabbit.respectGitIgnore` is on. Tracked and staged files stay eligible whatever their ignore status. See the [settings reference](https://docs.coderabbit.ai/ide/settings.md#settings-reference).
* Files larger than 5 MB, and files whose diff is empty. They are skipped without a message.

After the upload, CodeRabbit applies the [default ignored paths](https://docs.coderabbit.ai/configuration/path-instructions.md#default-ignored-paths) and your [path filters](https://docs.coderabbit.ai/configuration/path-instructions.md#path-filters), as it does for pull request reviews. A file they exclude isn't reviewed, but it was still sent. If they exclude every file, the review stops with "All files are ignored". Path filters in the repository's `.coderabbit.yaml` also apply to its pull request reviews.

Files that hold secrets, such as `.env`, aren't excluded by name; see [Keep secrets out of reviews](https://docs.coderabbit.ai/ide/privacy.md#keep-secrets-out-of-reviews). The [data and privacy page](https://docs.coderabbit.ai/ide/privacy.md#what-a-review-sends) lists what a review uploads.

## Which review configuration applies

This section covers the CodeRabbit configuration that shapes the review itself. For the extension's own editor settings, see [Settings and commands](https://docs.coderabbit.ai/ide/settings.md).

Each review uploads the first of `.coderabbit.yaml`, `.coderabbit.yml`, or `.coder.yaml` at the root of the workspace folder you opened, even when you haven't changed it. When you open a folder inside a larger repository, that is the folder's root, not the repository's. The extension reads it from disk when the review starts, so saved edits count and unsaved ones don't. CodeRabbit layers it over your organization's settings for the repository, or over the organization-level settings when CodeRabbit doesn't know the repository. This follows the usual Configuration Inheritance (A setting that merges configuration values across multiple levels — repository YAML, central YAML, and UI settings — instead of using only the highest-priority source.).

IDE reviews use a subset of that configuration:

| Configuration | In IDE reviews |
| - | - |
| [`reviews.path_filters`](https://docs.coderabbit.ai/reference/configuration#param-reviews-path-filters) | Applied after the upload, before the review |
| [`reviews.path_instructions`](https://docs.coderabbit.ai/reference/configuration#param-reviews-path-instructions), [`reviews.profile`](https://docs.coderabbit.ai/reference/configuration#param-reviews-profile), and other review behavior | Applied, as for pull request reviews |
| [Tools](https://docs.coderabbit.ai/tools.md) and codebase context | Used with the Essentials plan or higher, a Git remote, and the repository connected to the selected organization. CodeRabbit then clones the repository for context and runs the tools enabled in your settings. Otherwise, it reviews the uploaded files only. See [feature availability](https://docs.coderabbit.ai/management/plans.md#feature-availability). |
| [`knowledge_base.linked_repositories`](https://docs.coderabbit.ai/reference/configuration#param-knowledge-base-linked-repositories) for [Multi-Repo Analysis](https://docs.coderabbit.ai/knowledge-base/multi-repo-analysis.md) | Taken only from your organization's settings, never from the uploaded file |
| [Pre-Merge Checks](https://docs.coderabbit.ai/pr-reviews/pre-merge-checks.md) | Not run |
| Pull request settings, such as walkthroughs, summaries, labels, `auto_review`, and Automatic Approvals | Don't apply; an IDE review posts nothing to a pull request |

Free reviews without a seat ignore all of these and use CodeRabbit's default configuration.

## What's next

> **[Work with findings](https://docs.coderabbit.ai/ide/findings.md)**
>
> Read findings in the sidebar and editor, apply suggestions, and revisit earlier reviews.

> **[Fix with AI](https://docs.coderabbit.ai/ide/fix-with-ai.md)**
>
> Hand findings to GitHub Copilot, Claude Code, Codex, or another coding agent.

> **[Settings and commands](https://docs.coderabbit.ai/ide/settings.md)**
>
> Look up every extension setting and Command Palette command.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.