Before you start
- Decide whether teams may change the settings. If they must not, use global overrides.
- Know how inheritance and merging combine layers.
Choose an approach
Use Organization defaults when admins manage the baseline in the web app. Use central configuration when the baseline should be reviewed and versioned like code, or when youâre on self-hosted CodeRabbit. Use workspace settings when several organizations in one workspace share a baseline. Use global overrides only for the few values teams must not change. A shared remote file suits a group of repositories that shares one file without a central repository for the whole organization.
Set Organization defaults
Organization defaults apply to every repository whose Use organization settings toggle is on, which is the default. A repository file or a central file takes priority over them.- Open Review > Review settings.
- In Select repositories, select the Organization defaults row.
- Change settings in the form, or set View mode to YAML editor.
- Select Apply changes, then Apply changes again in the confirmation dialog.
Set up central configuration
- Create a repository named
coderabbitin your organization. - Add
.coderabbit.yamlor.coderabbit.config.tsat its root. - Install CodeRabbit on the repository.
- Open a pull request in a repository that has no file of its own and run
@coderabbitai configuration. Values from the file showCentral YAML.
Let repositories customize with inheritance
Addinheritance: true to a repository file so it keeps the central values it doesnât set. Without it, the repositoryâs omitted keys resolve to schema defaults.
- Central file
- Repository file
- Result
.coderabbit.yaml in the coderabbit repository
Use workspace settings
Enterprise customers with an SSO workspace can set a shared baseline for every organization in it. A workspace admin turns on Use workspace settings as defaults on Workspace management > General. Workspace settings then fill only the keys that no other layer sets. See Workspace settings.Enforce values instead
Use global overrides for values that no repository may change. Donât use them as general defaults.Share one file across repositories
A repository file that contains onlyremote_config is replaced by the file it points to. CodeRabbit follows the pointer once. Prefer central configuration for many repositories, and point remote_config at a repository rather than a URL, because repository sharing is more secure. See Configuration file.
A TypeScript configuration canât use remote_config. It uses includeRemote to pull a shared fragment and combine it with its own settings in code. See Share TypeScript fragments.
Change many repositories in the web app
- In Select repositories, check each repository, or All.
- Select the Edit button below the list.
- Change settings and apply them.
Check the result
Open a pull request in a repository without its own file and post@coderabbitai configuration. Each valueâs # Source: comment names the layer that applies. See Check which configuration a review used.
Whatâs next
Enforce settings teams can't change
Pin values with global overrides and lock the configuration branch.
Inheritance and merging
See how CodeRabbit combines layers, lists, and nested values.
Central configuration
Set up the
coderabbit repository on your Git platform.