Get started
Add CodeRabbit to your repository
Review pull requests
IDE extensions
CLI
Configure
Manage your account
Configure
Configuration via YAML File
Learn how to configure CodeRabbit using a YAML file for advanced customization.
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
.coderabbit.yaml configuration file must be located in the root of therepository. The configuration present in the feature branch under review willbe automatically detected and used by CodeRabbit for that review.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.Example Configuration
.coderabbit.yaml
# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.jsonlanguage:"en-US"early_access:falsereviews: profile:"chill" request_changes_workflow:false high_level_summary:true poem:true review_status:true collapse_walkthrough:false auto_review: enabled:true drafts:falsechat: auto_reply:trueConfiguration Options
The configuration file supports numerous options for customizing CodeRabbit’s behavior. For the complete list of available configuration options and their descriptions, see theconfiguration 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:
remote_config: url:"https://your-config-location/.coderabbit.yaml"Was this page helpful?
⌘I