1. Configure using CodeRabbit YAML file
  2. Configure using CodeRabbit UI for each repository
  3. Configure using CodeRabbit UI for the organization
In this guide, we will cover the configuration using a YAML file. For reference, you can find curated examples of YAML configurations in our 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.
You can add a .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
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:
  1. Create a .coderabbit.yaml file and host it in a location that is accessible to from the CodeRabbit instance.
  2. Create a .coderabbit.yaml file in the root of your repository with the following content:
remote_config:
  url: "https://your-config-location/.coderabbit.yaml"