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.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.
When cr config refuses
When cr config refuses
Guided setup stops when:
-
Both
.coderabbit.yamland.coderabbit.ymlexist. - The target file is a symbolic link.
-
The repository has only a
.coderabbit.config.tsfile. -
The file delegates through
remote_config. Resolve the situation or edit the existing source instead.
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.