- 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 all available configuration options and their descriptions, see the configuration reference.
.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 the configuration reference. Please note that code reviews commence with new pull requests or incremental commits to existing pull requests once the CodeRabbit app is installed. Should you have any questions or require assistance, our support team is here to help.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.yamlfile and host it in a location that is accessible to from the CodeRabbit instance. - Create a
.coderabbit.yamlfile in the root of your repository with the following content: