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

# Install the VS Code extension

> Install the CodeRabbit VS Code extension to review code changes locally in your editor.

Install the CodeRabbit VS Code extension to review code changes directly in your editor. For more information about using the extension, see [Review local changes](/ide).

<Note>
  These instructions are specific to VS Code. If you're using a VS Code-compatible
  editor like Cursor or Windsurf, the steps are similar but may require some
  adaptation.
</Note>

## Before you begin

Before you can use the CodeRabbit VS Code extension, you need a CodeRabbit account.

<Info>
  Don't have an account yet? Create one by visiting [the CodeRabbit login
  page](https://app.coderabbit.ai/login?free-trial).
</Info>

## Install the extension

<Steps>
  <Step title="Open Extensions">
    In the editor activity bar, click **Extensions**.
  </Step>

  <Step title="Search for CodeRabbit">
    In the sidebar, type `coderabbit` into the **Search Extensions in
    Marketplace** search bar. **CodeRabbit** will appear as a search result.
  </Step>

  <Step title="Select the extension">
    Select **CodeRabbit**. A summary of the CodeRabbit VS Code extension appears in
    the main pane with installation controls.
  </Step>

  <Step title="Configure auto-update (optional)">
    If you want your editor to automatically check for and apply future updates to
    the extension, keep the **Auto Update** checkbox selected. Otherwise, clear
    the checkbox.
  </Step>

  <Step title="Install the extension">Click **Install**.</Step>

  <Step title="Log in to CodeRabbit">
    A **Log in to CodeRabbit to get started** dialog appears. Click **Login**.

    <Accordion title="If the login dialog is dismissed or times out">
      1. Click the CodeRabbit icon in the VS Code activity bar
      2. Click the **Use CodeRabbit for Free** button
    </Accordion>
  </Step>

  <Step title="Grant browser permission">
    Grant VS Code permission to open your browser, if asked.
  </Step>

  <Step title="Complete authentication">
    In your web browser, log into your CodeRabbit account.
  </Step>

  <Step title="Handle redirect (if needed)">
    After signing in, the browser will redirect you back to VS Code. If the redirect doesn't occur:

    1. Copy the code displayed in the success window
    2. Click **Paste code from browser** in VS Code
    3. Paste the code into the input field that appears
  </Step>
</Steps>

This connects your CodeRabbit account with the CodeRabbit VS Code extension.

## Install using the marketplace website

If you're using the VS Code IDE (not a derived IDE like Cursor or Windsurf), you can alternatively install the CodeRabbit extension by visiting [the extension's page on the Visual Studio Marketplace](https://coderabbit.link/vscode-docs).

<Warning>
  If you install the extension this way, you still need to connect your
  CodeRabbit account to the extension after installing it, as described in the
  previous section.
</Warning>

## What's next

<CardGroup cols={3}>
  <Card title="Use the VS Code extension" href="/ide/vscode-use">
    Learn how to review code changes with the extension
  </Card>

  <Card title="Configure the VS Code extension" href="/ide/vscode-config">
    Customize the extension settings for your workflow
  </Card>

  <Card title="Use with Self-hosted CodeRabbit" href="/ide/vscode-selfhosted">
    Set up the extension with your self-hosted instance
  </Card>
</CardGroup>
