You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
description: How to review your code with the VSCode extension.
4
+
slug: /code-editors
5
+
sidebar_label: Overview
6
+
---
7
+
8
+
This page is about the CodeRabbit VSCode extension. For a broader overview of CodeRabbit, see [Introduction](/).
9
+
10
+
## About the VSCode extension
11
+
12
+
The CodeRabbit VSCode extension lets you apply a limited subset of CodeRabbit’s code-review features to your local development environment, directly from the VSCode IDE. It also works with other text editors that are able to install and use VSCode extensions, such as Cursor and Windsurf.
13
+
14
+
You can use the extension on its own, or you can use it to complement your local development on a repository whose remote has CodeRabbit installed.
15
+
16
+
The extension is intended to let you use the power of CodeRabbit to rapidly tune and tidy your code changes locally, before you publish your changes to your team's remote repository and start a more thorough code review.
17
+
18
+
## Features
19
+
20
+
The extension includes the following features:
21
+
22
+
- Automatic code reviews on every local Git commit.
23
+
- Manually requested reviews of local code changes.
24
+
- One-click application of simpler suggested code fixes.
25
+
- Integration with AI coding agents, including Copilot and Claude Code, to help you resolve more complex suggestions.
26
+
- Full compatibility with text editors derived from VSCode, including Cursor and Windsurf.
27
+
28
+
## Price and limitations
29
+
30
+
This extension is free to install and use, and works with any tier of CodeRabbit account. Rate limits apply to the number of local reviews that you can request per hour.
31
+
32
+
The extension makes only basic CodeRabbit review features available, with default settings applied. Advanced CodeRabbit features, such as interactive chat and project learnings, aren't available through the VSCode extension. These features are available only by [integrating CodeRabbit on your remote repository](/platforms), and then allowing CodeRabbit to review pull requests.
33
+
34
+
## What's next
35
+
36
+
-[Install the VSCode extension](/guides/install-vscode)
description: How to configure the CodeRabbit VSCode extension
4
+
---
5
+
6
+
This page is about configuring the CodeRabbit VSCode extension. For more information about the extension, see
7
+
[Review local changes](/code-editors).
8
+
9
+
:::note
10
+
The instructions on this page are specific to using the extension with VSCode. If you are instead using a VSCode-compatible editor such as Cursor or Windsurf, then the steps that you need to follow are similar, but might require some adaptation.
11
+
:::
12
+
13
+
## Find the settings screen {#find}
14
+
15
+
To navigate to the settings screen for the CodeRabbit VSCode extension, follow these steps:
16
+
17
+
1. In the activity bar, click the Extensions icon.
18
+
19
+
1. In the sidebar, under **Installed**, click the gear-shaped **Manage** icon in the CodeRabbit row.
20
+
21
+
1. In the menu that appears, select **Settings**.
22
+
23
+
The settings screen contains the following configuration controls.
24
+
25
+
## Configure AI agent integration {#agent}
26
+
27
+
The **Agent Type** setting lets you choose the extension's response to using the **Fix with AI** feature during code reviews. Your options are the following:
28
+
29
+
-**Native**: The extension prompts the AI agent associated with your IDE to apply the suggested fix.
30
+
31
+
This works only with VSCode, using Copilot. If you have this option selected when using a different IDE, then the extension instead copies the prompt to your clipboard.
32
+
33
+
-**Claude Code**: The extension opens the Terminal pane of your IDE and tries to use the `claude` command-line program to apply the suggested fix to your code. You need to have Claude Code installed for this option to be effective.
34
+
35
+
-**Clipboard**: The extension copies prompt text describing the suggested fix to your clipboard. From there, you can manually paste the prompt into the coding AI agent that you use with your IDE.
36
+
37
+
For more information about the **Fix with AI** feature, see [Request help from your AI coding agent](/guides/use-vscode#agent).
The **Auto Review Mode** setting lets you control the behavior of the automatic code reviews that the extension can perform after you make commits to your local Git repository. Your options are the following:
42
+
43
+
-**Disabled**: The extension doesn't perform automatic code reviews.
44
+
45
+
-**Prompt**: After every commit, the extension displays a dialog asking if you'd like it to perform a code review.
46
+
47
+
-**Auto**: The extension always performs a review after every commit.
48
+
49
+
For more information about this feature, see [Automatically review local commits](/guides/use-vscode#auto-reviews).
50
+
51
+
## Set a review timeout {#timeout}
52
+
53
+
The **Review Timeout** setting lets you specify how long the extension waits for a response from CodeRabbit remote servers before timing out a code review. The default value is `20`.
54
+
55
+
To turn off timeouts, set this value to `0`.
56
+
57
+
## What's next {#whats-next}
58
+
59
+
-[Use the VSCode extension](/guides/use-vscode)
60
+
61
+
-[Uninstall the VSCode extension](/guides/uninstall-vscode)
Copy file name to clipboardExpand all lines: docs/guides/custom-reports.md
+33-23
Original file line number
Diff line number
Diff line change
@@ -76,6 +76,11 @@ Contained within the `<pr_details>` tag.
76
76
-`State`: string ("open"/"closed") - Current state of the PR
77
77
-`Mergeable`: boolean (true/false) - Whether the PR can be merged
78
78
-`Is stale`: boolean - Whether PR has been inactive for over 168 hours
79
+
-`PR Stage`: string - The current stage of open PRs in Open or Draft state, can be one of:
80
+
- "Needs Author Action" - PR requires author attention due to merge conflicts, draft status, or requested changes
81
+
- "Waiting for Author to Merge" - PR has approvals and is ready for author to merge
82
+
- "Waiting for Code Reviews" - PR is waiting for reviewers to approve
83
+
- undefined - PR is not in an open state (is merged or closed)
79
84
80
85
#### Basic Information
81
86
@@ -124,60 +129,65 @@ Generate a summary of each pull request in the following bullet point format:
124
129
- If 'Merged: true' set 'PR State: 🔀 Merged'
125
130
- Else If 'Draft: true' set 'PR State: 📝 Draft'
126
131
- Else If 'State: open' or 'State: active' set 'PR State: 💬 Open'
127
-
- Else If 'State: closed' and 'Merged: false' set 'PR State: 🔒 Closed'
132
+
- Else If 'State: closed' or 'State: DECLINED' and 'Merged: false' set 'PR State: 🔒 Closed'
128
133
- Else set 'PR State: ❓ Unknown'
129
134
- If the PR is stale, add '⚠️ Stale' at the end of the PR State.
130
-
- Mergeable (if PR State if not 'Merged'): Provide the mergeable status of the PR as 'Mergeable' or 'Not Mergeable'.
135
+
- Mergeable (if PR State is not 'Merged'): Provide the mergeable status of the PR as 'Mergeable' or 'Not Mergeable' based on the "Mergeable: " value.
136
+
- PR Stage (if PR State is not 'Merged'): Provide the stage of the PR based on the "PR Stage: " value.
131
137
- Summary: In under 50 words provide a short summary of the PR.
132
138
- Comments: In under 50 words provide a short summary of all comments found within <pr_comments>, including each comments author username from <comment_author_username>. If there are no comments available, output 'No comments'.
description: How to install the CodeRabbit VSCode extension
4
+
---
5
+
6
+
This page is about installing the CodeRabbit VSCode extension. For more information about the extension, see
7
+
[Review local changes](/code-editors).
8
+
9
+
:::note
10
+
The instructions on this page are specific to using the extension with VSCode. If you are instead using a VSCode-compatible editor such as Cursor or Windsurf, then the steps that you need to follow are similar, but might require some adaptation.
11
+
:::
12
+
13
+
## Before you begin
14
+
15
+
Before you can use the CodeRabbit VSCode extension, you need a CodeRabbit account.
16
+
17
+
If you don't already have an account, you can create one by visiting [the CodeRabbit login page](https://app.coderabbit.ai/login).
18
+
19
+
## Install the extension
20
+
21
+
To install the CodeRabbit extension, follow these steps:
22
+
23
+
1. In the editor activity bar, click **Extensions**.
24
+
25
+
1. In sidebar, type `coderabbit` into the **Search Extensions in Marketplace** search bar. After a moment, **CodeRabbit** appears in the sidebar as a search result.
26
+
27
+
1. Select **CodeRabbit**. A summary of the CodeRabbit VSCode extension appears in the window's main pane, along with installation controls.
28
+
29
+
1. If you would like your editor to automatically check for and apply future updates to the extension, then keep the **Auto Update** checkbox selected. Otherwise, clear the checkbox.
30
+
31
+
1. Click **Install**.
32
+
33
+
1. A **Log in to CodeRabbit to get started** dialog appears. Click **Login**. If the dialog gets dismissed or times out first, then you can follow these alternate steps:
34
+
35
+
1. Click the CodeRabbit icon in the VSCode activity bar.
36
+
37
+
1. Click the **Use CodeRabbit for Free** button.
38
+
39
+
1. Grant VSCode permission to open your browser, if asked.
40
+
41
+
1. In your web browser, log into your CodeRabbit account.
42
+
43
+
This connects your CodeRabbit account with the CodeRabbit VSCode extension.
44
+
45
+
## Install using the marketplace website
46
+
47
+
If you are using the VSCode IDE, and not an IDE that derives from it such as Cursor or Windsurf, then you can alternatively obtain and install the CodeRabbit VSCode extension by visiting [the extension's page on the Visual Studio Marketplace](https://coderabbit.link/vscode-docs).
48
+
49
+
If you do install the extension this way, then you still need to connect your CodeRabbit account to the extension after installing it, as described in the previous section.
50
+
51
+
## What's next
52
+
53
+
-[Use the VSCode extension](/guides/use-vscode)
54
+
55
+
-[Configure the VSCode extension](/guides/config-vscode)
description: How to uninstall the CodeRabbit VSCode extension
4
+
---
5
+
6
+
This page is about uninstalling the CodeRabbit VSCode extension. For more information about the extension, see
7
+
[Review local changes](/code-editors).
8
+
9
+
:::note
10
+
The instructions on this page are specific to using the extension with VSCode. If you are instead using a VSCode-compatible editor such as Cursor or Windsurf, then the steps that you need to follow are similar, but might require some adaptation.
11
+
:::
12
+
13
+
## Uninstall the extension
14
+
15
+
To uninstall the VSCode extension, follow these steps:
16
+
17
+
1. In the VSCode activity bar, click the CodeRabbit icon.
18
+
19
+
1. In the CodeRabbit sidebar, click the door-shaped **Logout** icon.
20
+
21
+
1. In the VSCode activity bar, click the **Extensions** icon.
22
+
23
+
1. In the Extensions sidebar, click the gear-shaped **Manage** icon next to CodeRabbit in the list of installed extensions.
0 commit comments