Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings
This repository was archived by the owner on Aug 16, 2025. It is now read-only.

Commite051a1a

Browse files
committed
Add further VSCode docs
1 parent3ff2069 commite051a1a

File tree

6 files changed

+110
-6
lines changed

6 files changed

+110
-6
lines changed

‎docs/guides/about-vscode.md‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title:Overview
2+
title:VSCode extension overview
33
description:How to review your code with the VSCode extension.
44
---
55

@@ -9,19 +9,23 @@ This page is about the CodeRabbit VSCode extension. For a broader overview of Co
99

1010
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.
1111

12+
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.
13+
1214
##Features
1315

1416
The extension includes the following features:
1517

1618
- Automatic reviews of local Git commmits
1719

18-
- Manually requested reviews of local code changes
20+
- Manually requested reviews of local code changes, either committed or uncommited
1921

2022
##Price and limitations
2123

22-
This extension is free to install and use, and works with any tier of CodeRabbit account. 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.
24+
This extension is free to install and use, and works with any tier of CodeRabbit account. Rate limits apply to the numnber of local reviews that you can request per hour.
25+
26+
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.
2327

24-
Rate limits apply tothenumnber of local reviews that you can request per hour.
28+
As such, the extension makes onlythemost 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.
2529

2630
##What's next
2731

‎docs/guides/install-vscode.md‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
title:Install the VSCode extension
3+
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+
[Overview](/guides/about-vscode).
8+
9+
##Before you begin
10+
11+
Before you can use the CodeRabbit VSCode extension, you need a CodeRabbit account.
12+
13+
If you don't already have an account, you can create one by visiting[the CodeRabbit login page](https://app.coderabbit.ai/login).
14+
15+
##Install the extension
16+
17+
To install the CodeRabbit VSCode extension, follow these steps:
18+
19+
1. Visit[the extension's page on the Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=CodeRabbit.coderabbit-vscode).
20+
21+
1. Click**Install**.
22+
23+
1. If your browser asks you for permission to open VSCode, then click**Allow** or its equivalent control.
24+
25+
1. A summary of the CodeRabbit VSCode extension appears in your VSCode window. If you would like VSCode to automatically check for and apply future updates to the extension, then keep the**Auto Update** checkbox selected.
26+
27+
1. In VSCode, click**Install**.
28+
29+
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:
30+
31+
1. Click the CodeRabbit icon in the VSCode activity bar.
32+
33+
1. Click the**Use CodeRabbit for Free** button.
34+
35+
1. Grant VSCode permission to open your browser, if asked.
36+
37+
1. In your web browser, log into your CodeRabbit account.
38+
39+
This connects your CodeRabbit account with the CodeRabit VSCode extension.
40+
41+
##What's next
42+
43+
-[Use the VSCode extension](/guides/use-vscode)

‎docs/guides/uninstall-vscode.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
title:Uninstall the VSCode extension
3+
description:How to uinstall the CodeRabbit VSCode extension
4+
---
5+
6+
This page is about uninstalling the CodeRabbit VSCode extension. For more information about the extension, see
7+
[Overview](/guides/about-vscode).
8+
9+
##Uninstall the extension
10+
11+
To uninstall the VSCode extension, follow these steps:
12+
13+
1. In the VSCode activity bar, click the CodeRabbit icon.
14+
15+
1. In the CodeRabbit sidebar, click the door-shaped**Logout** icon.
16+
17+
1. In the VSCode activity bar, click the**Extensions** icon.
18+
19+
1. In the Extensions sidebar, click the gear-shaped**Manage** icon next to CodeRabbit in the list of installed extensions.
20+
21+
1. Select**Uninstall**.

‎docs/guides/use-vscode.md‎

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,21 @@ description: How to review your code with the VSCode extension.
66
This page is about using the CodeRabbit VSCode extension. For more information about the extension, see
77
[Overview](/guides/about-vscode). To learn how to install the extension, see[Install the VSCode extension](/guides/install-vscode).
88

9-
##Review your code changes
9+
##Automatically review local commits
10+
11+
You can let CodeRabbit automatically review commits that you make to your local Git repository. These automatic reviews compare all committed changes against the branch that your working branch is based on.
12+
13+
To perform an automatic review, follow these steps:
14+
15+
1. Perform a Git commit using VSCode. After you do this, a dialog appears in your VSCode window, asking**Would you like to start a review?**
16+
17+
1. Click**Yes.** The CodeRabbit sidebar appears in your VSCode window.
18+
19+
1. Wait for the review to complete. This might take several minutes. To cancel a review in progress, click**Stop the review**.
20+
21+
For more options and control of code reviews performed using the CodeRabbit VSCode extension, you can manually request a review, as detailed in the following section.
22+
23+
##Manually request code reviews
1024

1125
To manually review changes in a local Git branch using the CodeRabbit VSCode extension, follow these steps:
1226

@@ -36,4 +50,4 @@ To manually review changes in a local Git branch using the CodeRabbit VSCode ext
3650

3751
##What's next
3852

39-
-The CodeRabbit[Introduction](/overview/introduction) describes how you can complementtheCodeRabbitVSCode extension by setting up automatic, full-featured code reviews on your remote repository's pull requests.
53+
-[Uninstallthe VSCode extension](/guides/install-extension)

‎docs/overview/introduction.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,8 +94,16 @@ Public repositories can use the Pro tier of CodeRabbit at no charge, including a
9494

9595
For private repositories, a number of pricing tiers are available. These range from a Free tier that offers unlimited code-change summaries, to an Enterprise tier with access to advanced features and SLA support. For more information, see[Pricing](https://www.coderabbit.ai/pricing).
9696

97+
##Review local changes from within VSCode
98+
99+
As a separate, free product, CodeRabbit offers a VSCode extension that brings a subset of core CodeRabbit features to VSCode. This lets you use the power of CodeRabbit to tune and tidy your code changes locally before pushing your changes into a formal pull request for more thorough reviews.
100+
101+
For more information, see[About the VSCode extension](/guides/about-vscode).
102+
97103
##What's next
98104

99105
-[Quickstart](/getting-started/quickstart/) lets you experience your first CodeRabbit code review first-hand.
100106

107+
-[About the VSCode extension] guides you through installing and using a subset of CodeRabbit features directly from your code editor.
108+
101109
-[Why CodeRabbit?](/overview/why-coderabbit) dives further into the philosophies and technologies that drive CodeRabbit.

‎sidebars.ts‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,8 @@ const sidebars: SidebarsConfig = {
8585
label:"Review pull requests",
8686
items:[
8787
"guides/commands",
88+
"guides/code-review-best-practices",
89+
"guides/code-review-troubleshooting",
8890
"guides/agent_chat",
8991
{
9092
type:"category",
@@ -108,6 +110,17 @@ const sidebars: SidebarsConfig = {
108110
"guides/linked-issues",
109111
],
110112
},
113+
{
114+
type:"category",
115+
collapsed:false,
116+
label:"Review local changes using the VSCode extension",
117+
items:[
118+
"guides/about-vscode",
119+
"guides/install-vscode",
120+
"guides/use-vscode",
121+
"guides/uninstall-vscode",
122+
],
123+
},
111124
{
112125
type:"category",
113126
collapsed:false,
@@ -128,6 +141,7 @@ const sidebars: SidebarsConfig = {
128141
label:"CodeRabbit API",
129142
href:"https://api.coderabbit.ai/api/swagger/",
130143
},
144+
"reference/review-commands",
131145
{
132146
type:"category",
133147
label:"Supported tools",

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp