Skip to main content
In this guide, we will cover the configuration using a YAML file. For the complete list of available options, see the Configuration Reference. For ready-to-use examples tailored to specific frameworks and languages, see Configuration Examples.
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.

ā€‹
Configure CodeRabbit using a YAML File

.coderabbit.yaml configuration file must be located in the root of the repository. The configuration present in the feature branch under review will be automatically detected and used by CodeRabbit for that review.

ā€‹
Example Configuration

.coderabbit.yaml
# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json
language: "en-US"
early_access: false
reviews:
  profile: "chill"
  request_changes_workflow: false
  high_level_summary: true
  poem: true
  review_status: true
  review_details: false
  auto_review:
    enabled: true
    drafts: false
chat:
  auto_reply: true

ā€‹
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.

Configuration Reference

Complete documentation of all options

Configuration Examples

Ready-to-use examples for popular frameworks and languages
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

Shared configuration is not recommended, as it may expose sensitive configuration details. Please use Central Configuration for managing configurations across multiple repositories and Configuration Inheritance for reusing configurations across different layers.
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 publicly accessible (e.g., a web server, a public GitHub Gist).
  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"