Configure CodeRabbit
After you finishintegrating CodeRabbit with your Git platform,you can configure CodeRabbit to best fit the needs of your Git platform's organization and repositories.
About CodeRabbit configuration
CodeRabbit hasa lot of configuration options, with default settings that are designed to meet most needs. CodeRabbit is designed to work "outof the box": if you don't change any of theconfiguration settings away from the defaults, then CodeRabbit starts automaticallyadding code reviews to new pull requests in your repositories.
However, understanding how to configure CodeRabbit lets you tune its behaviorto the particulars of your team's code. A few advantages of manually configuringCodeRabbit include the following:
- Adjust the level of detail in CodeRabbit code reviews.
- Customize review instructions to meet your specific coding standards.
- Take advantage of agentic workflows that can speed up your review cycles.
Configuration methods
You can configure CodeRabbit in several ways, from global organization settingsdown to configuration directives for specific repositories.
Organization settings
If you want to apply the same CodeRabbit configuration to all of your organization's repositories, thenyou can manage organizational settings using the CodeRabbit web UI.
For more information, seeSet your organization preferences.
Repository settings
If you want to apply separate CodeRabbit configuration to your organization's different repositories, then you canmanage repository-specific CodeRabbit settings in two ways:
- Add a
.coderabbit.yaml
file to the top level of your repository. - Use the CodeRabbit web interface.
For more information, seeSet your repository preferences.
While the web interface provides and easier way to explore the available configuration options for your repository, we recommend using a.coderabbit.yaml
fileas a best practice.
Configuration priority
CodeRabbit follows a specific hierarchy when determining which configuration settings to use. Understanding this priority system helps you manage your configuration effectively:
Priority order (highest to lowest)
- Local
.coderabbit.yaml
file of head branch - Repository settings (web UI)
- Organization settings (web UI)
How priority works
- If you have a local
.coderabbit.yaml
file in your head branch: All repository and organization settings are ignored. Only the local YAML file configuration is used. Anything not defined in that file uses default settings. - If you don't have a local YAML file but have enabled repository settings: Organization settings are ignored. Only repository settings are used.
- If you have organization settings and repository settings are disabled: Only organization settings are used.
Configuration inheritance
When a configuration source is active, it completely overrides all lower-priority sources. For example, if you setreviews.tools.github-checks.timeout_ms
to900000
in organization settings, but you have a local.coderabbit.yaml
file that doesn't define this setting, CodeRabbit will use the default value of90000
instead of the organization setting.
This means that configuration is not merged or inherited - the highest priority source takes complete control over all settings.
Initial configuration
TheInitial configuration guide tours you through several settings that werecommend that you review after you set up CodeRabbit with your organization.