Skip to main content
Local reviews run from your machine before you open a pull request. The CLI and the IDE extensions read your repository’s configuration file and layer it over your organization’s settings. They read it from different places than hosted pull request reviews do, and the IDE applies only part of it.

How the CLI finds configuration

Without explicit --config files, cr review looks for a configuration file, checks the review directory first and the Git repository root second for each name, and uses the first file it finds. YAML wins over TypeScript. Pass --committed to read the discovered configuration from the Git snapshot instead of the working tree. CodeRabbit applies only .coderabbit.yaml, .coderabbit.yml and .coderabbit.config.ts, the same names as in pull request reviews. The CLI sends only the first file it finds. When that file is coderabbit.yaml or coderabbit.yml, the review runs with your organization’s settings and no repository file, and a .coderabbit.config.ts in the repository isn’t sent. Rename the file to .coderabbit.yaml.

Pass extra instruction files to the CLI

Use -c or --config to give the review more instructions, such as a claude.md file. The CLI reads explicit files from the filesystem.

Remote CLI reviews

cr review --remote reads configuration from the reviewed repository on the server and ignores local --config files. It works with GitHub Cloud only. Self-hosted CodeRabbit doesn’t support it, although you can point the CLI at a self-hosted instance for local reviews.
See CLI with self-hosted CodeRabbit for the instance setup.

Create or edit the file with cr config

cr config creates .coderabbit.yaml at the repository root or updates an existing one. It validates the change, shows a preview and asks before it saves.
1

Run the command in a repository

Run cr config for the standard setup, or cr config --detailed to add path instructions. Use CLI 0.7.7 or later in an interactive terminal.
2

Review the proposed change

The command keeps your existing settings and shows what it adds.
3

Save, commit and push

Commit and push the file so pull request reviews use it.
Guided setup stops when:
  • Both .coderabbit.yaml and .coderabbit.yml exist.
  • The target file is a symbolic link.
  • The repository has only a .coderabbit.config.ts file.
  • The file delegates through remote_config. Resolve the situation or edit the existing source instead.
To draft a change from a script or an agent without prompts, see Automate configuration with the API, MCP and CLI.

Configuration in IDE reviews

Each IDE review uploads one configuration file. The VS Code extension reads it from the root of the workspace folder you opened, which isn’t always the repository root. The JetBrains plugin reads it from the Git repository root. Saved edits count; unsaved edits don’t. CodeRabbit layers the file over your organization’s settings for the repository, following normal inheritance. Free IDE reviews without a seat use the default settings. For setup, see IDE settings. Only .coderabbit.yaml and .coderabbit.yml take effect. A review that finds only .coder.yaml, coderabbit.yaml or coderabbit.yml uses your organization’s settings without a repository file. Neither extension sends .coderabbit.config.ts.

What’s next

CLI

Install and run local reviews.

IDE settings

Configure the IDE extensions.

Automate configuration

Read and change configuration from scripts and agents.