Skip to content

Modify the IDE installation instructions to prefer using the IDE's marketplace UI #341

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 16, 2025
Merged

Modify the IDE installation instructions to prefer using the IDE's marketplace UI #341

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
da46090
Modify the installation instructions to prefer
jmacdotorg May 14, 2025
47d254c
Apply suggestions from code review
jmacdotorg May 15, 2025
e1862d0
Merge branch 'main' into install
jmacdotorg May 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 12 additions & 6 deletions docs/guides/install-vscode.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,17 +18,17 @@ If you don't already have an account, you can create one by visiting [the CodeRa

## Install the extension

To install the CodeRabbit VSCode extension, follow these steps:
To install the CodeRabbit extension, follow these steps:

1. Visit [the extension's page on the Visual Studio Marketplace](https://coderabbit.link/vscode-docs).
1. In the editor activity bar, click **Extensions**.

1. Click **Install**.
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.

1. If your browser asks you for permission to open VSCode, then click **Allow** or its equivalent control.
1. Select **CodeRabbit**. A summary of the CodeRabbit VSCode extension appears in the window's main pane, along with installation controls.

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

1. In VSCode, click **Install**.
1. Click **Install**.

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:

Expand All @@ -42,6 +42,12 @@ To install the CodeRabbit VSCode extension, follow these steps:

This connects your CodeRabbit account with the CodeRabbit VSCode extension.

## Install using the marketplace website

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).

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.

## What's next

- [Use the VSCode extension](/guides/use-vscode)
Expand Down