- Configure using CodeRabbit YAML file
- Configure using CodeRabbit UI for each repository
- Configure using CodeRabbit UI for the organization
awesome-coderabbit
repository.
Configure CodeRabbit using a YAML File
Move existing UI configuration to a YAML file?Use the
@coderabbitai configuration
command on any PR to get the current configuration in a YAML format. You can then copy the configuration to a .coderabbit.yaml
file in the root of your repository..coderabbit.yaml
configuration file to the root of your repositories. For a complete sample .coderabbit.yaml
file which you can add to your repository and update as needed, see Configuration file template.
.coderabbit.yaml
configuration file should exist in the feature branch for CodeRabbit review.Configuration Options
The configuration file supports numerous options for customizing CodeRabbit’s behavior. For the complete list of available configuration options and their descriptions, see our comprehensive YAML template.Quick Start Templates
Pre-configured templates for different use cases
Configuration Reference
Complete documentation of all options
Shared configuration
If you are self-hosting CodeRabbit in an air-gapped environment, you can use the shared configuration feature to share the configuration across multiple repositories. To use shared configuration, you need to:- Create a
.coderabbit.yaml
file and host it in a location that is accessible to from the CodeRabbit instance. - Create a
.coderabbit.yaml
file in the root of your repository with the following content: