> ## 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 IDE extension

> Install the CodeRabbit extension in VS Code, Cursor, Windsurf, Antigravity, or another VS Code-based editor, including remote and dev container setups.

Install CodeRabbit from your editor's extension gallery, or from a VSIX file when the gallery doesn't list it. This page also covers remote and container workspaces and the optional CLI setup. To update or remove the extension, see [Update or uninstall](https://docs.coderabbit.ai/ide/update-uninstall.md).

## Requirements

* Visual Studio Code 1.93.1 or later
* The built-in Git extension (`vscode.git`), enabled

**Untrusted workspaces (Restricted Mode):** In restricted mode, Git subprocesses for worktree grouping and login email lookup are disabled. Branch information uses local Git API reads without contacting remotes. Workspace-provided self-hosted URLs and Fix with AI handoff policy settings are ignored, so the extension uses user-level policies and the default SaaS configuration. Workspace values of `coderabbit.agentType` and `coderabbit.autoStartTask` are ignored, and only your user settings apply. See the [settings reference](https://docs.coderabbit.ai/ide/settings.md#settings-reference).

Git must be installed on the machine where the extension runs, because the built-in Git extension uses it. For the editors that browser sign-in supports, see [Supported editors](https://docs.coderabbit.ai/ide.md#supported-editors).

## Install from your editor

**1. Open the Extensions view**

In VS Code, select the Extensions icon in the activity bar, or press `Cmd+Shift+X` on macOS or `Ctrl+Shift+X` on Windows and Linux. Other editors have an equivalent view.

**2. Search for CodeRabbit**

Type "CodeRabbit" in the search box.

**3. Check the publisher**

Make sure the publisher is CodeRabbit and the extension ID is `coderabbit.coderabbit-vscode`. The same extension is listed on the [VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=coderabbit.coderabbit-vscode) and on [Open VSX](https://open-vsx.org/extension/coderabbit/coderabbit-vscode).

**4. Install it**

Select **Install**.

**5. Sign in**

The CodeRabbit icon appears in the activity bar, and the notification "Log in to CodeRabbit to get started!" offers **Login**. Continue with [Sign in and manage your account](https://docs.coderabbit.ai/ide/sign-in.md).

Each editor installs extensions from its own gallery. The Marketplace listing installs into VS Code only. Cursor, Kiro, VSCodium, and Windsurf install from Open VSX.

If the search finds nothing, see [troubleshooting](https://docs.coderabbit.ai/ide/troubleshooting.md#coderabbit-is-missing-from-the-extensions-view).

## Recommended settings

Set your preferred coding agent right after you install. **Fix with AI** hands findings to the agent in `coderabbit.agentType`. The default, `Native`, uses your editor's built-in chat and [behaves differently in each editor](https://docs.coderabbit.ai/ide/fix-with-ai.md#what-native-does-in-each-editor). If you work with Claude Code, Codex, or another agent, set it now so findings go straight to that agent.

See [Choose your agent](https://docs.coderabbit.ai/ide/fix-with-ai.md#choose-your-agent) for every value and what it does, and [Open the settings](https://docs.coderabbit.ai/ide/settings.md#open-the-settings) for where to change it.

## Other installation options

### Install from a VSIX file

Use this when your editor's extension gallery doesn't list CodeRabbit. With CodeRabbit Cloud, sign-in still works only in the editors under [Supported editors](https://docs.coderabbit.ai/ide.md#supported-editors); other editors can't complete it.

**1. Download the VSIX**

Open the [Open VSX listing](https://open-vsx.org/extension/coderabbit/coderabbit-vscode) and download the latest version.

**2. Install it**

In your editor, open the Command Palette and run **Extensions: Install from VSIX...**, then select the downloaded file.

If your editor's gallery doesn't list CodeRabbit, it can't update the extension either. Install each new version the same way.

### Install in remote, container, and cloud workspaces

In a Remote-SSH, WSL, Dev Containers, or Codespaces window, the extension runs on the machine that hosts the workspace, so install it there, and make sure Git is installed there too. Git commands, the files a review sends, CLI setup, and the terminals that **Fix with AI** opens all run on that machine. The extension's network connections also start there, so that machine's proxy, DNS, and firewall rules apply; see [Network access](https://docs.coderabbit.ai/ide/privacy.md#network-access) for the hosts.

To install the extension in every dev container for a project, add it to `devcontainer.json`:

```json devcontainer.json theme={null}
{
  "customizations": {
    "vscode": {
      "extensions": ["coderabbit.coderabbit-vscode"]
    }
  }
}
```

Browser sign-in opens the browser on your local computer, and the editor passes the result to the extension on the remote machine. Sign-in belongs to the editor profile. If a rebuilt container asks you to sign in again, sign in from the CodeRabbit sidebar.

The link that returns sign-in to the editor opens only in a desktop editor. For a codespace, connect VS Code on your desktop to it rather than using the codespace in a browser tab.

### Set up the CLI and agent skills

This step is optional. The extension reviews code without the CodeRabbit CLI. Set up the CLI if you also want to run reviews from a terminal or let coding agents call CodeRabbit through [skills](https://docs.coderabbit.ai/cli/skills.md).

* When the CodeRabbit CLI isn't installed yet, the extension offers **Install CLI + skills** once, in a trusted workspace. Select **Not now** to skip it. You can run setup at any time with **CodeRabbit: Set up CLI and skills** in the Command Palette.
* Setup installs the [CodeRabbit CLI](https://docs.coderabbit.ai/cli.md) if it's missing. It never updates an existing CLI. It then runs `coderabbit skills` in a terminal, where you choose and approve the skills to install.
* Setup needs a trusted workspace in a desktop editor. In a remote window, it runs on the remote machine. It isn't available in browser-based sessions.
* If the terminal shows "This CLI does not support skills yet", run `coderabbit update`, then run setup again.

## What's next

> **[Sign in](https://docs.coderabbit.ai/ide/sign-in.md)**
>
> Sign in through your browser and pick the organization that CodeRabbit uses for your reviews.

> **[Run a review](https://docs.coderabbit.ai/ide/review.md)**
>
> Choose the changes and base branch to review, then start your first review.

> **[Troubleshooting](https://docs.coderabbit.ai/ide/troubleshooting.md)**
>
> Fix installation, sign-in, and review problems.


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