.coderabbit.yaml file in the repository.
Start here
One repository or a small team
One repository or a small team
Add a
.coderabbit.yaml file to the repository, or use the web app if you prefer a UI. Set how strict reviews are, add your teamâs rules, and skip files that donât need review. A file is reviewed like code and makes it easy to try settings on a branch.Start with Create your first configuration.Many repositories
Many repositories
Set a baseline once instead of in every repository: in , reviewed like code, or in Organization defaults in the web app. Repositories without a file of their own use it automatically, including new ones. If a team later adds a
.coderabbit.yaml to its repository, that file replaces the baseline for that repository. To keep the baseline and change only a few values, the file turns on with inheritance: true. Several organizations under one SSO workspace can share workspace settings.See Apply settings to every repository.Settings teams must not change
Settings teams must not change
Use . They replace the same settings from every other place, including a repositoryâs own file. To also stop a pull request from changing how itâs reviewed, on GitHub Cloud pin the branch CodeRabbit reads the configuration from.See Enforce settings teams canât change.
Self-hosted CodeRabbit
Self-hosted CodeRabbit
Set instance-wide defaults with the
YAML_CONFIG environment variable. Repository files and central configuration work as on CodeRabbit Cloud; the web app settings donât exist.See Configuration on self-hosted CodeRabbit.Which settings win
When several places set the same setting, CodeRabbit starts from the first of these that exists: the repositoryâs own file, central configuration, the repositoryâs web settings, then Organization defaults. It doesnât combine them unless inheritance is on. Global overrides then replace anything they set, and built-in defaults fill the rest. Each of these places is called a layer. To see what a review used and where each value came from, comment@coderabbitai configuration on the pull request, or open Run configuration in the reviewâs Review info.
Common tasks
Reduce review noise
Get fewer, more useful comments.
Choose which files are reviewed
Skip generated code, third-party code and other noise.
Teach CodeRabbit your rules
Add guidance for specific paths and conventions.
Control when reviews run
Choose branches, drafts, authors and incremental reviews.
Check which configuration a review used
See each value and the layer it came from.
Validate and test a change
Catch mistakes before a configuration change merges.
Automate configuration
Read and change settings with the API, MCP server and CLI.
Configuration reference
Every setting, with its default.
What you can configure
Some examples of what teams change:- How strict reviews are, and the language and tone of comments. See Review style.
- Your teamâs rules, such as âevery API endpoint checks authorizationâ for
src/api/**. CodeRabbit also reads guideline files you already have, such asAGENTS.md. See Review instructions and Code guidelines. - Which linters and security scanners run, and with which of your configuration files. See Review tools.
- What the summary and walkthrough include. See Summaries and Walkthroughs.
- Checks a pull request must pass, written in plain language. See Pre-merge checks.
- What context CodeRabbit uses, such as learnings and linked issues. See Knowledge Base.
How CodeRabbit builds the configuration for a review
Each review uses exactly one configuration. CodeRabbit builds it in five steps:1
Pick the file revision
CodeRabbit reads the repository file from a revision it trusts: the pull request branch or the base branch.
2
Choose the starting layer
The highest layer that exists becomes the starting point, for example the repository file or central configuration.
3
Merge parent layers
Only when is on, CodeRabbit merges the layers below the starting layer into it.
4
Apply global overrides
Organization and workspace overrides replace whatever the earlier steps set.
5
Fill unset keys
Workspace defaults, then built-in defaults, fill every key thatâs still unset.
Compare every place settings can live
Platform and security teams often need the full picture: who can edit each place, whether changes are version-controlled, and what each place reaches.Show the comparison table
Show the comparison table
A form save in the web interface stores every value, including defaults you didnât change. A save from the YAML editor stores only the values you wrote. Stored values count as set, so after a form save, inherited Organization defaults canât change any single value in Repository settings. Only lists still combine. See Why saved Repository settings can hide organization values.
Configuration schema V2 and V3
Configuration files use schema V2. Schema V3 is a limited preview that regroups the review settings and moves instructions and checks into Markdown documents. See Migrate configuration to V3.Configuration and learnings
are preferences CodeRabbit records when you chat with it on pull requests. They arenât a configuration layer: use configuration for documented standards and learnings for preferences that come up during review.Whatâs next
Create your first configuration
Decide between the web app and a file, then set the five settings that matter most.
Apply settings to every repository
Share one baseline across an organization or workspace.
How CodeRabbit resolves configuration
Follow each step CodeRabbit takes to build the configuration for a review.