Configuration Reference

This reference is automatically generated from the CodeRabbit configuration schema. Last updated: 2025-08-16

CodeRabbit’s behavior can be customized using a .coderabbit.yaml file in your repository root. This reference covers all available configuration options with clear property names and examples.

Quick Start

Get started with basic configuration

YAML Template

Download a complete template

Configuration Sections

Code Reviews

Configure automatic code reviews, tools, and review behavior

Chat & Integrations

Set up chat features and third-party integrations

Knowledge Base

Configure learning and knowledge sharing features

Code Generation

Settings for docstrings and unit test generation

Reviews

Settings related to reviews.

Example Configuration

.coderabbit.yaml

reviews:
  profile: chill
  high_level_summary: true
  auto_review:
    enabled: true
    drafts: false
  tools:
    eslint:
      enabled: true
    gitleaks:
      enabled: true

Reference

profile

enum

Set the profile for reviews. Assertive profile yields more feedback, that may be considered nitpicky.One of the following: chill, assertiveDefaults to "chill".

request_changes_workflow

boolean

Approve the review once CodeRabbit’s comments are resolved and no pre-merge checks are in an error state. Note: In GitLab, all discussions must be resolved.Defaults to false.

high_level_summary

boolean

Generate a high level summary of the changes in the PR/MR description.Defaults to true.

high_level_summary_placeholder

string

Placeholder in the PR/MR description that gets replaced with the high level summary.Defaults to "@coderabbitai summary".

high_level_summary_in_walkthrough

boolean

Include the high level summary in the walkthrough comment.Defaults to false.

auto_title_placeholder

string

Add this keyword in the PR/MR title to auto-generate the title.Defaults to "@coderabbitai".

auto_title_instructions

string

Auto Title Instructions | Custom instructions for auto-generating the PR/MR title.Defaults to "".

review_status

boolean

Post review details on each review. Additionally, post a review status when a review is skipped in certain cases.Defaults to true.

commit_status

boolean

Set the commit status to ‘pending’ when the review is in progress and ‘success’ when it is complete.Defaults to true.

fail_commit_status

boolean

Set the commit status to ‘failure’ when the PR cannot be reviewed by CodeRabbit for any reason.Defaults to false.

collapse_walkthrough

boolean

Generate walkthrough in a markdown collapsible section.Defaults to false.

changed_files_summary

boolean

Generate a summary of the changed files in the walkthrough.Defaults to true.

sequence_diagrams

boolean

Generate sequence diagrams in the walkthrough.Defaults to true.

estimate_code_review_effort

boolean

Estimate the code review effort in the walkthrough.Defaults to true.

assess_linked_issues

boolean

Generate an assessment of how well the changes address the linked issues in the walkthrough.Defaults to true.

Include possibly related issues in the walkthrough.Defaults to true.

Related PRs | Include possibly related pull requests in the walkthrough.Defaults to true.

suggested_labels

boolean

Suggest labels based on the changes in the pull request in the walkthrough.Defaults to true.

auto_apply_labels

boolean

Automatically apply the suggested labels to the PR/MR.Defaults to false.

suggested_reviewers

boolean

Suggest reviewers based on the changes in the pull request in the walkthrough.Defaults to true.

auto_assign_reviewers

boolean

Automatically assign suggested reviewers to the pull requestDefaults to false.

poem

boolean

Generate a poem in the walkthrough comment.Defaults to true.

labeling_instructions

array of object

Labeling Instructions | Provide guidelines for suggesting labels for the PR/MR. When specific labels or instructions are provided, only those labels are considered, though previous examples are still used to inform the suggestions. If no such labels are provided, suggestions are based solely on previous PR/MRs.Defaults to [].

Show Array Items

label

string

Label to suggest for the PR/MR. Example: frontend

instructions

string

Instructions for the label. Example: Apply when the PR/MR contains changes to the react components.

Max length: 3000

path_filters

array of string

Specify file patterns to include or exclude in a review using glob patterns (e.g., !dist/, src/). These patterns also apply to ‘git sparse-checkout’, including specified patterns and ignoring excluded ones (starting with ’!’) when cloning the repository.Defaults to [].

path_instructions

array of object

Path Instructions | Provide specific additional guidelines for code review based on file paths.Defaults to [].

Show Array Items

path

string

File path glob pattern. Example: **/*.js

instructions

string

Provides specific additional guidelines for code review based on file paths.

Max length: 20000

abort_on_close

boolean

Abort the in-progress review if the pull request is closed or merged.Defaults to true.

disable_cache

boolean

Disable caching of code and dependencies. This will force CodeRabbit to download the code and dependencies fresh from the repository each time.Defaults to false.

auto_review

object

Configuration for auto reviewDefaults to {}.

Show Auto review

enabled

boolean

Automatic Review | Automatic code reviewDefaults to true.

auto_incremental_review

boolean

Automatic Incremental Review | Automatic incremental code review on each pushDefaults to true.

ignore_title_keywords

array of string

Ignore reviewing if the title of the pull request contains any of these keywords (case-insensitive).Defaults to [].

labels

array of string

List of labels to control which PRs/MRs to review. Labels starting with ’!’ are negative matches. Examples: [‘bug’, ‘feature’] - reviews PRs with ‘bug’ OR ‘feature’ label. [‘!wip’] - reviews all PRs except those with ‘wip’ label. [‘bug’, ‘!wip’] - reviews PRs with ‘bug’ label but not if they have ‘wip’ label.Defaults to [].

drafts

boolean

Review draft PRs/MRs.Defaults to false.

base_branches

array of string

Base branches (other than the default branch) to review. Accepts regex patterns. Use ’.*’ to match all branches.Defaults to [].

finishing_touches

object

Configuration for finishing touchesDefaults to {}.

Show Finishing touches

docstrings

object

Docstrings | Options for generating Docstrings for your PRs/MRs.Defaults to {}.

Show Docstrings

enabled

boolean

Docstrings | Allow CodeRabbit to generate docstrings for PRs/MRs.Defaults to true.

unit_tests

object

Unit Tests | Options for generating unit tests for your PRs/MRs.Defaults to {}.

Show Unit tests

enabled

boolean

Unit Tests | Allow CodeRabbit to generate unit tests for PRs/MRs.Defaults to true.

pre_merge_checks

object

Configuration for pre merge checksDefaults to {}.

Show Pre merge checks

docstrings

object

Docstring Coverage | Checks if the code has sufficient docstrings.Defaults to {}.

Show Docstrings

mode

enum

Mode | Level of enforcement for docstring coverage check. Warning only generates a warning and does not require the user to resolve the check. While error requires the user to resolve issues before merging pull request.One of the following: off, warning, errorDefaults to "warning".

threshold

number

Percentage threshold for docstring coverage check.Defaults to 80.

Min: 0, Max: 100

title

object

Title Check | Checks if the pull request title is appropriate and follows best practices.Defaults to {}.

Show Title

mode

enum

Mode | Level of enforcement for pull request title check. Warning only generates a warning and does not require the user to resolve the check. While error requires the user to resolve issues before merging pull request.One of the following: off, warning, errorDefaults to "warning".

requirements

string

Requirements | Requirements for the pull request title. Example: ‘Title should be concise and descriptive, ideally under 50 characters.’Defaults to "".

description

object

Description Check | Checks if the pull request description is appropriate and follows best practices.Defaults to {}.

Show Description

mode

enum

Mode | Level of enforcement for pull request description check. Warning only generates a warning and does not require the user to resolve the check. While error requires the user to resolve issues before merging pull request.One of the following: off, warning, errorDefaults to "warning".

issue_assessment

object

Linked Issue Assessment | Checks if the pull request addresses the linked issues. Generate an assessment of how well the changes address the linked issues.Defaults to {}.

Show Issue assessment

mode

enum

Mode | Level of enforcement for linked issue assessment. Warning only generates a warning and does not require the user to resolve the check. While error requires the user to resolve issues before merging pull request.One of the following: off, warning, errorDefaults to "warning".

tools

object

Tools that provide additional context to code reviews.Defaults to {}.

Show Tools

ast-grep

object

Enable ast-grep | ast-grep is a code analysis tool that helps you to find patterns in your codebase using abstract syntax trees patterns. | v0.38.6Defaults to {}.

Show Ast-grep

rule_dirs

array of string

List of rules directories.Defaults to [].

util_dirs

array of string

List of utils directories.Defaults to [].

essential_rules

boolean

Use ast-grep essentials package.Defaults to true.

packages

array of string

Predefined packages to be used.Defaults to [].

shellcheck

object

ShellCheck is a static analysis tool that finds bugs in your shell scripts.Defaults to {}.

Show Shellcheck

enabled

boolean

Enable ShellCheck | ShellCheck is a static analysis tool that finds bugs in your shell. | Enable ShellCheck integration. | v0.10.0Defaults to true.

ruff

object

Ruff is a Python linter and code formatter.Defaults to {}.

Show Ruff

enabled

boolean

Enable Ruff | Ruff is a Python linter and code formatter. | Enable Ruff integration. | v0.12.2Defaults to true.

markdownlint

object

markdownlint-cli2 is a static analysis tool to enforce standards and consistency for Markdown files.Defaults to {}.

Show Markdownlint

enabled

boolean

Enable markdownlint | markdownlint-cli2 is a static analysis tool to enforce standards and consistency for Markdown files. | Enable markdownlint integration. | v0.17.2Defaults to true.

github-checks

object

GitHub Checks integration configuration.Defaults to {}.

Show Github-checks

enabled

boolean

Enable GitHub Checks | Enable integration, defaults to true | Enable GitHub Checks integration.Defaults to true.

timeout_ms

number

Time in milliseconds to wait for all GitHub Checks to conclude. Default 90 seconds, max 15 minutes (900000ms).Defaults to 90000.

Min: 0, Max: 900000

languagetool

object

LanguageTool is a style and grammar checker for 30+ languages.Defaults to {}.

Show Languagetool

enabled

boolean

Enable LanguageTool | Enable LanguageTool integration.Defaults to true.

enabled_rules

array of string

IDs of rules to be enabled. The rule won’t run unless ‘level’ is set to a level that activates the rule.Defaults to [].

disabled_rules

array of string

IDs of rules to be disabled. Note: EN_UNPAIRED_BRACKETS, and EN_UNPAIRED_QUOTES are always disabled.Defaults to [].

enabled_categories

array of string

IDs of categories to be enabled.Defaults to [].

disabled_categories

array of string

IDs of categories to be disabled. Note: TYPOS, TYPOGRAPHY, and CASING are always disabled.Defaults to [].

enabled_only

boolean

Only the rules and categories whose IDs are specified with ‘enabledRules’ or ‘enabledCategories’ are enabled.Defaults to false.

level

enum

If set to ‘picky’, additional rules will be activated, i.e. rules that you might only find useful when checking formal text.One of the following: default, pickyDefaults to "default".

biome

object

Biome is a fast formatter, linter, and analyzer for web projects.Defaults to {}.

Show Biome

enabled

boolean

Enable Biome | Biome is a fast formatter, linter, and analyzer for web projects. | Enable Biome integration. | v2.1.2Defaults to true.

hadolint

object

Hadolint is a Dockerfile linter.Defaults to {}.

Show Hadolint

enabled

boolean

Enable Hadolint | Hadolint is a Dockerfile linter. | Enable Hadolint integration. | v2.12.0Defaults to true.

swiftlint

object

SwiftLint integration configuration object.Defaults to {}.

Show Swiftlint

enabled

boolean

Enable SwiftLint | SwiftLint is a Swift linter. | Enable SwiftLint integration. | v0.57.0Defaults to true.

config_file

string

Optional path to the SwiftLint configuration file relative to the repository. This is useful when the configuration file is named differently than the default ‘.swiftlint.yml’ or ‘.swiftlint.yaml’.

phpstan

object

PHPStan is a tool to analyze PHP code.Defaults to {}.

Show Phpstan

enabled

boolean

Enable PHPStan | PHPStan requires config file in your repository root. Please ensure that this file contains the paths: parameter. | v2.1.17Defaults to true.

level

enum

Level | Specify the rule level to run. This setting is ignored if your configuration file already has a level: parameter.One of the following: default, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, maxDefaults to "default".

phpmd

object

PHPMD is a tool to find potential problems in PHP code.Defaults to {}.

Show Phpmd

enabled

boolean

Enable PHPMD | PHPMD is a tool to find potential problems in PHP code. | v2.15.0Defaults to true.

phpcs

object

PHP CodeSniffer is a PHP linter and coding standard checker.Defaults to {}.

Show Phpcs

enabled

boolean

Enable PHP CodeSniffer | PHP CodeSniffer is a PHP linter and coding standard checker. | v3.7.2Defaults to true.

golangci-lint

object

golangci-lint is a fast linters runner for Go.Defaults to {}.

Show Golangci-lint

enabled

boolean

Enable golangci-lint | golangci-lint is a fast linters runner for Go. | Enable golangci-lint integration. | v2.2.2Defaults to true.

config_file

string

Optional path to the golangci-lint configuration file relative to the repository. Useful when the configuration file is named differently than the default ‘.golangci.yml’, ‘.golangci.yaml’, ‘.golangci.toml’, ‘.golangci.json’.

yamllint

object

YAMLlint is a linter for YAML files.Defaults to {}.

Show Yamllint

enabled

boolean

Enable YAMLlint | YAMLlint is a linter for YAML files. | Enable YAMLlint integration. | v1.37.1Defaults to true.

gitleaks

object

Gitleaks is a secret scanner.Defaults to {}.

Show Gitleaks

enabled

boolean

Enable Gitleaks | Gitleaks is a secret scanner. | Enable Gitleaks integration. | v8.27.2Defaults to true.

checkov

object

Checkov is a static code analysis tool for infrastructure-as-code files.Defaults to {}.

Show Checkov

enabled

boolean

Enable Checkov | Checkov is a static code analysis tool for infrastructure-as-code files. | v3.2.334Defaults to true.

detekt

object

Detekt is a static code analysis tool for Kotlin files.Defaults to {}.

Show Detekt

enabled

boolean

Enable detekt | detekt is a static code analysis tool for Kotlin files. | v1.23.8Defaults to true.

config_file

string

Optional path to the detekt configuration file relative to the repository.

eslint

object

ESLint is a static code analysis tool for JavaScript files.Defaults to {}.

Show Eslint

enabled

boolean

Enable ESLint | ESLint is a static code analysis tool for JavaScript files.Defaults to true.

flake8

object

Flake8 is a Python linter that wraps PyFlakes, pycodestyle and Ned Batchelder’s McCabe script.Defaults to {}.

Show Flake8

enabled

boolean

Enable Flake8 | Flake8 is a Python linter that wraps PyFlakes, pycodestyle and Ned Batchelder’s McCabe script. | v7.2.0Defaults to true.

rubocop

object

RuboCop is a Ruby static code analyzer (a.k.a. linter ) and code formatter.Defaults to {}.

Show Rubocop

enabled

boolean

Enable RuboCop | RuboCop is a Ruby static code analyzer (a.k.a. linter ) and code formatter. | v1.76.1Defaults to true.

buf

object

Buf offers linting for Protobuf files.Defaults to {}.

Show Buf

enabled

boolean

Enable Buf | Buf offers linting for Protobuf files. | v1.55.1Defaults to true.

regal

object

Regal is a linter and language server for Rego.Defaults to {}.

Show Regal

enabled

boolean

Enable Regal | Regal is a linter and language server for Rego. | v0.35.1Defaults to true.

actionlint

object

actionlint is a static checker for GitHub Actions workflow files.Defaults to {}.

Show Actionlint

enabled

boolean

Enable actionlint | is a static checker for GitHub Actions workflow files. | v1.7.7Defaults to true.

pmd

object

PMD is an extensible multilanguage static code analyzer. It’s mainly concerned with Java.Defaults to {}.

Show Pmd

enabled

boolean

Enable PMD | PMD is an extensible multilanguage static code analyzer. It’s mainly concerned with Java. | v7.15.0Defaults to true.

config_file

string

Optional path to the PMD configuration file relative to the repository.

cppcheck

object

Cppcheck is a static code analysis tool for the C and C++ programming languages.Defaults to {}.

Show Cppcheck

enabled

boolean

Enable Cppcheck | Cppcheck is a static code analysis tool for the C and C++ programming languages. | v2.17.1Defaults to true.

semgrep

object

Semgrep is a static analysis tool designed to scan code for security vulnerabilities and code quality issues.Defaults to {}.

Show Semgrep

enabled

boolean

Enable Semgrep | Semgrep is a static analysis tool designed to scan code for security vulnerabilities and code quality issues. | Enable Semgrep integration. | v1.128.1Defaults to true.

config_file

string

Optional path to the Semgrep configuration file relative to the repository.

circleci

object

CircleCI tool is a static checker for CircleCI config files.Defaults to {}.

Show Circleci

enabled

boolean

Enable CircleCI | CircleCI tool is a static checker for CircleCI config files. | v0.1.32638Defaults to true.

clippy

object

Clippy is a collection of lints to catch common mistakes and improve your Rust code.Defaults to {}.

Show Clippy

enabled

boolean

Enable Clippy | Clippy is a collection of lints to catch common mistakes and improve your Rust code. | Enable Clippy integration.Defaults to true.

sqlfluff

object

SQLFluff is an open source, dialect-flexible and configurable SQL linter.Defaults to {}.

Show Sqlfluff

enabled

boolean

Enable SQLFluff | SQLFluff is an open source, dialect-flexible and configurable SQL linter. | v3.4.1Defaults to true.

prismaLint

object

Configuration for Prisma Schema linting to ensure schema file qualityDefaults to {}.

Show Prisma Lint

enabled

boolean

Enable Prisma Schema linting | Prisma Schema linting helps maintain consistent and error-free schema files | v0.10.2Defaults to true.

pylint

object

Pylint is a Python static code analysis tool.Defaults to {}.

Show Pylint

enabled

boolean

Enable Pylint | Pylint is a Python static code analysis tool. | v3.3.7Defaults to true.

oxc

object

Oxlint is a JavaScript/TypeScript linter for OXC written in Rust.Defaults to {}.

Show Oxc

enabled

boolean

Enable Oxlint | Oxlint is a JavaScript/TypeScript linter for OXC written in Rust. | v0.16.10Defaults to true.

shopifyThemeCheck

object

Configuration for Shopify Theme Check to ensure theme quality and best practicesDefaults to {}.

Show Shopify Theme Check

enabled

boolean

Enable Shopify Theme Check | A linter for Shopify themes that helps you follow Shopify theme & Liquid best practices | cli 3.77.1 | theme 3.58.2Defaults to true.

luacheck

object

Configuration for Lua code linting to ensure code qualityDefaults to {}.

Show Luacheck

enabled

boolean

Enable Lua code linting | Luacheck helps maintain consistent and error-free Lua code | v1.2.0Defaults to true.

brakeman

object

Brakeman is a static analysis security vulnerability scanner for Ruby on Rails applications. | v7.0.2Defaults to {}.

Show Brakeman

enabled

boolean

Enable Brakeman | Brakeman is a static analysis security vulnerability scanner for Ruby on Rails applications. | v7.0.2Defaults to true.

dotenvLint

object

dotenv-linter is a tool for checking and fixing .env files for problems and best practicesDefaults to {}.

Show Dotenv Lint

enabled

boolean

Enable dotenv-linter | dotenv-linter is a tool for checking and fixing .env files for problems and best practices | v3.3.0Defaults to true.

htmlhint

object

HTMLHint is a static code analysis tool for HTML files.Defaults to {}.

Show Htmlhint

enabled

boolean

Enable HTMLHint | HTMLHint is a static code analysis tool for HTML files. | Enable HTMLHint integration. | v1.5.0Defaults to true.

checkmake

object

checkmake is a linter for Makefiles.Defaults to {}.

Show Checkmake

enabled

boolean

Enable checkmake | checkmake is a linter for Makefiles. | v0.2.2Defaults to true.

osvScanner

object

OSV Scanner is a tool for vulnerability package scanning.Defaults to {}.

Show Osv Scanner

enabled

boolean

Enable OSV Scanner | OSV Scanner is a tool for vulnerability package scanning | v2.1.0Defaults to true.

Chat

Configuration for chat

Example Configuration

.coderabbit.yaml

chat:
  auto_reply: true
  integrations:
    jira:
      usage: enabled

Reference

art

boolean

Generate art in response to chat messages. CodeRabbit expresses emotions as either ASCII or Emoji art.Defaults to true.

auto_reply

boolean

Enable the bot to reply automatically without requiring the user to tag it.Defaults to true.

integrations

object

Configuration for integrationsDefaults to {}.

Show Integrations

jira

object

Configuration for jiraDefaults to {}.

Show Jira

usage

enum

Jira | Enable the Jira integration for opening issues, etc. ‘auto’ disables the integration for public repositories.One of the following: auto, enabled, disabledDefaults to "auto".

linear

object

Configuration for linearDefaults to {}.

Show Linear

usage

enum

Linear | Enable the Linear integration for opening issues, etc. ‘auto’ disables the integration for public repositories.One of the following: auto, enabled, disabledDefaults to "auto".

Knowledge base

Configuration for knowledge base

Example Configuration

.coderabbit.yaml

knowledge_base:
  opt_out: false
  code_guidelines:
    enabled: true
    filePatterns:
      - "**/.cursorrules"
      - "**/CODING_STANDARDS.md"

Reference

opt_out

boolean

Opt Out | Disable all knowledge base features that require data retention. If you opt out after opting in, all of your existing knowledge base data will be removed from the system.Defaults to false.

web_search

object

Configuration for web searchDefaults to {}.

Show Web search

enabled

boolean

Web Search | Enable the web search integration.Defaults to true.

code_guidelines

object

CodeRabbit will analyse and learn from your organization’s code guidelines, which you can mention in the file patterns section. These guidelines will then be used to conduct thorough code reviews.Defaults to {}.

Show Code guidelines

enabled

boolean

Enabled | Enable CodeRabbit to enforce your organization’s coding standards during reviews.Defaults to true.

filePatterns

array of string

File Patterns | Specify files for your coding guideline documents in this section. CodeRabbit will scan these files to understand your team’s standards and apply them during code reviews. Multiple files supported. File names are case-sensitive. Common files like: (**/.cursorrules, .github/copilot-instructions.md, **/CLAUDE.md, **/GEMINI.md, **/.cursor/rules/, **/.windsurfrules, **/.clinerules/, **/.rules/*, **/AGENT.md) are included by default.Defaults to [].

learnings

object

Configuration for learningsDefaults to {}.

Show Learnings

scope

enum

Learnings | Specify the scope of learnings to use for the knowledge base. ‘local’ uses the repository’s learnings, ‘global’ uses the organization’s learnings, and ‘auto’ uses repository’s learnings for public repositories and organization’s learnings for private repositories.One of the following: local, global, autoDefaults to "auto".

issues

object

Configuration for issuesDefaults to {}.

Show Issues

scope

enum

Issues | Specify the scope of git platform (GitHub/GitLab) issues to use for the knowledge base. ‘local’ uses the repository’s issues, ‘global’ uses the organization’s issues, and ‘auto’ uses repository’s issues for public repositories and organization’s issues for private repositories.One of the following: local, global, autoDefaults to "auto".

jira

object

Configuration for jiraDefaults to {}.

Show Jira

usage

enum

Jira | Enable the Jira knowledge base integration. ‘auto’ disables the integration for public repositories.One of the following: auto, enabled, disabledDefaults to "auto".

project_keys

array of string

Jira Project Keys | Specify the Jira project keys to use for the knowledge base.Defaults to [].

linear

object

Configuration for linearDefaults to {}.

Show Linear

usage

enum

Linear | Enable the Linear knowledge base integration. ‘auto’ disables the integration for public repositories.One of the following: auto, enabled, disabledDefaults to "auto".

team_keys

array of string

Linear Team Keys | Specify the Linear team keys (identifiers) to use for the knowledge base. E.g. ‘ENG’Defaults to [].

pull_requests

object

Configuration for pull requestsDefaults to {}.

Show Pull requests

scope

enum

Pull Requests | Specify the scope of pull requests to use for the knowledge base. ‘local’ uses the repository’s pull requests, ‘global’ uses the organization’s pull requests, and ‘auto’ uses repository’s pull requests for public repositories and organization’s pull requests for private repositories.One of the following: local, global, autoDefaults to "auto".

mcp

object

Configuration for mcpDefaults to {}.

Show Mcp

usage

enum

MCP | Enable the MCP knowledge base integration. ‘auto’ disables the integration for public repositories.One of the following: auto, enabled, disabledDefaults to "auto".

disabled_servers

array of string

MCP Disabled Servers | Specify MCP server labels to disable (case-insensitive). These servers will be excluded from reviews and knowledge base queries.Defaults to [].

Code generation

Configuration for code generation

Example Configuration

.coderabbit.yaml

code_generation:
  docstrings:
    language: en-US
  unit_tests:
    path_instructions: []

Reference

docstrings

object

Settings related to the generation of docstrings.Defaults to {"path_instructions":[]}.

Show Docstrings

language

enum

Set the language for docstrings by using the corresponding ISO language code.One of the following: de, de-DE, de-AT, de-CH, en, en-US, en-AU, en-GB, en-CA, en-NZ, en-ZA, es, es-AR, fr, fr-CA, fr-CH, fr-BE, nl, nl-BE, pt-AO, pt, pt-BR, pt-MZ, pt-PT, ar, ast-ES, ast, be-BY, be, br-FR, br, ca-ES, ca, ca-ES-valencia, ca-ES-balear, da-DK, da, de-DE-x-simple-language, el-GR, el, eo, fa, ga-IE, ga, gl-ES, gl, it, ja-JP, ja, km-KH, km, ko-KR, ko, pl-PL, pl, ro-RO, ro, ru-RU, ru, sk-SK, sk, sl-SI, sl, sv, ta-IN, ta, tl-PH, tl, tr, uk-UA, uk, zh-CN, zh, crh-UA, crh, cs-CZ, cs, nb, no, nl-NL, de-DE-x-simple-language-DE, es-ES, it-IT, fa-IR, sv-SE, de-LU, fr-FR, bg-BG, bg, he-IL, he, hi-IN, hi, vi-VN, vi, th-TH, th, bn-BD, bnDefaults to "en-US".

path_instructions

array of object

Path Instructions | Provide additional guidelines for docstring generation based on file paths.Defaults to [].

Show Array Items

path

string

File path glob pattern. Example: **/*.js

instructions

string

Provides additional guidelines for docstring generation based on file paths.

Max length: 20000

unit_tests

object

Settings related to the generation of unit tests.Defaults to {"path_instructions":[]}.

Show Unit tests

path_instructions

array of object

Unit Test Generation | Provide additional guidelines for unit test generation based on file paths.Defaults to [].

Show Array Items

path

string

File path glob pattern. Example: **/*.js

instructions

string

Provides additional guidelines for unit test generation based on file paths.

Max length: 20000

Global Settings

These settings apply to your entire CodeRabbit configuration across all repositories.

Example Configuration

.coderabbit.yaml

language: en-US
tone_instructions: "Be concise and focus on critical issues only"
early_access: false

Reference

language

enum

Set the language for reviews by using the corresponding ISO language code.One of the following: de, de-DE, de-AT, de-CH, en, en-US, en-AU, en-GB, en-CA, en-NZ, en-ZA, es, es-AR, fr, fr-CA, fr-CH, fr-BE, nl, nl-BE, pt-AO, pt, pt-BR, pt-MZ, pt-PT, ar, ast-ES, ast, be-BY, be, br-FR, br, ca-ES, ca, ca-ES-valencia, ca-ES-balear, da-DK, da, de-DE-x-simple-language, el-GR, el, eo, fa, ga-IE, ga, gl-ES, gl, it, ja-JP, ja, km-KH, km, ko-KR, ko, pl-PL, pl, ro-RO, ro, ru-RU, ru, sk-SK, sk, sl-SI, sl, sv, ta-IN, ta, tl-PH, tl, tr, uk-UA, uk, zh-CN, zh, crh-UA, crh, cs-CZ, cs, nb, no, nl-NL, de-DE-x-simple-language-DE, es-ES, it-IT, fa-IR, sv-SE, de-LU, fr-FR, bg-BG, bg, he-IL, he, hi-IN, hi, vi-VN, vi, th-TH, th, bn-BD, bnDefaults to "en-US".

tone_instructions

string

Set the tone of reviews and chat. Example: ‘You must use talk like Mr. T. I pity the fool who doesn’t!’Defaults to "".

Max length: 250

early_access

boolean

Enable early-access features.Defaults to false.

enable_free_tier

boolean

Enable free tier features for users not on a paid plan.Defaults to true.

Configuration Examples

Perfect for getting started with CodeRabbit.

.coderabbit.yaml

language: en-US
reviews:
  profile: chill
  high_level_summary: true
  auto_review:
    enabled: true
    drafts: false

Review Commands

Learn about @coderabbitai commands

Supported Tools

Browse all supported linters and analyzers

Best Practices

Configuration tips and recommendations

Get started

Add CodeRabbit to your repository

Review pull requests

Create and resolve issues

IDE extensions

Configure

Manage your account

Generate reports

Best practices

Reference

Resources

Configuration Reference

Quick Start

YAML Template

Configuration Sections

Code Reviews

Chat & Integrations

Knowledge Base

Code Generation

Reviews

Example Configuration

Reference

Chat

Example Configuration

Reference

Knowledge base

Example Configuration

Reference

Code generation

Example Configuration

Reference

Global Settings

Example Configuration

Reference

Configuration Examples

Review Commands

Supported Tools

Best Practices

Get started

Add CodeRabbit to your repository

Review pull requests

Create and resolve issues

IDE extensions

Configure

Manage your account

Generate reports

Best practices

Reference

Resources

Quick Start

YAML Template

​Configuration Sections

Code Reviews

Chat & Integrations

Knowledge Base

Code Generation

​Reviews

​Example Configuration

​Reference

​Chat

​Example Configuration

​Reference

​Knowledge base

​Example Configuration

​Reference

​Code generation

​Example Configuration

​Reference

​Global Settings

​Example Configuration

​Reference

​Configuration Examples

​Related Resources

Review Commands

Supported Tools

Best Practices

Configuration Sections

Reviews

Example Configuration

Reference

Chat

Example Configuration

Reference

Knowledge base

Example Configuration

Reference

Code generation

Example Configuration

Reference

Global Settings

Example Configuration

Reference

Configuration Examples

Related Resources