This reference guide lists all of the code review configuration options thatCodeRabbit makes available.

For an overview of how configuration works with CodeRabbit, seeConfigure CodeRabbit.

How to use this reference​

Each entry in this reference corresponds to a single CodeRabbit configuration setting, including an informational table and a description of what the setting does. The tables have two views, which you can select with a tab:

• TheWeb UI tab displays the location and default value of the setting in the CodeRabbit web interface, for bothorganization settings andrepository settings.
• Thecoderabbit.yaml tab displays information about the field's location and datatype inyour repository's.coderabbit.yaml file.

Global Settings​

Data retention​

Iftrue, then CodeRabbit is allowed to retain enough data about your codereview history in order to enable the following features:

• Caching: allows CodeRabbit to store data about your repository betweencode reviews, improving the speed of subsequent reviews.
• Knowledge base: allows CodeRabbit to maintain its own database aboutyour repository and your team's code review preferences, which can improvethe quality and specificity of code reviews generated by CodeRabbit.

If your organization operates under strict data-retention policies, then you candisable data retention. Doing so immediately deletes any cache or knowledge-base data that CodeRabbit has collected for your organization, and prevents CodeRabbit fromretaining further cache or knowledge-base data.

If you re-enable data retention, then CodeRabbit re-enables these features, and resumes collecting cache and knowledge-base data.

Early Access​

If enabled, then CodeRabbit lets you use early-access features in yourcode reviews.

Enable Free Tier​

If enabled, then CodeRabbit allows free tier features for users not on a paid plan.

For more information about payment tiers and features, seePricing.

Language​

Defines the written language that CodeRabbit presents its review comments in. Defaultsto U.S. English.

Tone Instructions​

A natural-language description of the tone of voice that CodeRabbit shouldapply to its review instructions, if you want a tone different from itsdefault.

A few possible examples:

• Use an encouraging, supportive tone that celebrates good practices while gently suggesting improvements.
• Adopt a concise, matter-of-fact style that gets straight to the point without unnecessary pleasantries.
• Deliver all review comments in the style of a televised nature documentary, perhaps with David Attenborough hosting.

Review​

Basic Review Settings​

Abort On Close​

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

Assess Linked Issues​

If enabled, then the reviews that CodeRabbit generates include assessments of how well a proposed code change addresses any issues that the pull request refers to. CodeRabbit considers issues referred to by number in the following locations:

• The title of the pull request.
• The description of the pull request.
• (GitHub only) TheDevelopment field of the pull request.

Besides this setting, issue assessment requires at least one of the following:

• You use the built-in issue managemet system of GitHub or GitLab.
• You have integrated CodeRabbit with an external issue manager.

For more information, seeIntegrate issue trackingandLet CodeRabbit read your issue trakcer.

Auto Apply Labels​

Automatically apply the suggested labels to the PR/MR.

Auto Assign Reviewers​

Automatically assign suggested reviewers to the pull request

Auto Title Instructions​

Custom instructions for auto-generating the PR/MR title.

Auto Title Placeholder​

Add this keyword in the PR/MR title to auto-generate the title.

Changed Files Summary​

Generate a summary of the changed files in the walkthrough.

Collapse Walkthrough​

Generate walkthrough in a markdown collapsible section.

Commit Status​

Set the commit status to 'pending' when the review is in progress and 'success' when it is complete.

Disable Cache​

Activate this setting to disallow CodeRabbit from caching your repository's code and dependencies. This forces CodeRabbit to download the code and dependencies fresh from the repository for every code review that it performs.

When caching is allowed, then CodeRabbit stores a cache of code and metadata fromyour repostory for up to seven days after its most recent code review. This cachelets CodeRabbit save time and effort in between subsquent reviews of the samerepository. For more information, seeCaching.

We recommend leaving this setting off, which allows caching, and can speed upcode reviews. For more information, seeTrust the defaults.

Fail Commit Status​

Set the commit status to 'failure' when the PR cannot be reviewed by CodeRabbit for any reason.

High Level Summary​

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

High Level Summary In Walkthrough​

Include the high level summary in the walkthrough comment.

High Level Summary Placeholder​

Placeholder in the PR/MR description that gets replaced with the high level summary.

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.

Path Filters​

Path filters, if defined, restrict the portions of your repository that CodeRabbituses for context when preparing code reviews.

You can define a list of path specifications, relative to the root of yourrepository, to use as path filters.

Paths can beexclude paths, which start with a leading! character, orincludepaths. If the list of paths contains at least one include path, then CodeRabbitincludesonly files that match the provided paths.

For example, the following list of path filters instructs CodeRabbit to limit its reviewsonly to files found in thesrc top-level directory, but exclude any.bin or.csvfiles:

src/**
!**/*.{bin,csv}

We strongly recommend defining path filters for any repositories that containa significant amount of generated files or data that has no contextual bearing on code reviews.CodeRabbit can work faster if it can ignore files that aren't relevant to pull requests.For more information, seeSpeed up reviews by adding path filters.

Path Instructions​

Path instructions are additional sets of instructions, expressed in natural lanaguge,that you provide to CodeRabbit for reveiwing certain files in your repository.

You associate each set of instuctions with a file path relative to the rootof your repository. Your path specification can use extended glob patterns.

The following example defines a set of path instructions for all TypeScriptand JavaScript files in a reposistory'ssrc directory:

path_instructions:
-path: src/**/*.{ts,tsx,js}
instructions:
- Review the React.js/TypeScript/JavaScript code for best practices
-Check for common security vulnerabilities such as:
- SQL Injection
- Insecure dependencies
- Sensitive data exposure

For further examples of path instructions specific to various programming langauges,seetheawesome-coderabbit public repository.

Poem​

Generate a poem in the walkthrough comment.

Profile​

An overall selector for the level of detail that CodeRabbit should apply toits reviews. Valid values are the following:

• Chill: CodeRabbit provides its usual level of commentary.
• Assertive: CodeRabbit provides significantly deeper or more verbose commentary,as much as possible.

TheChill profile is the default setting, and is appropriate for most codingcontexts. TheAssertive profile mode can get quite nitpicky in some circumstances. We recommend leaving this setting inChill, unless a wordier level of code critique would benefit your team's work.

Related Issues​

Include possibly related issues in the walkthrough.

Related PRs​

Include possibly related pull requests in the walkthrough.

Request Changes Workflow​

If enabled, then CodeRabbit marks a pull request as approved once all commentsthat CodeRabbit made have been resolved.

Enable this setting if you want to have CodeRabbit's approval count towardsa minimum number of approvals that your have configured your Git platformto require before a pull request can be merged.

Review Status​

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

Sequence Diagrams​

Generate sequence diagrams in the walkthrough.

Suggested Labels​

Suggest labels based on the changes in the pull request in the walkthrough.

Suggested Reviewers​

Suggest reviewers based on the changes in the pull request in the walkthrough.

Automatic Review​

Enable Automatic Review​

If enabled, then CodeRabbit reviews new and updated pull requests automatically. For more information, seeAutomatically review pull requests.

If disabled, then CodeRabbit performs only reviews that you request manually. For more information on manual review commands, seeManually request code reviews.

Disabling this setting also effectively disables all of the other settings listed in this section.

Automatic Incremental Review​

If enabled, then CodeRabbit performs automatic reviews of existing pull requests when their associated branches have commits pushed to them. These incremental reviews happen in addition to the initial code review that CodeRabbit generates after the pull request is first created.

For more information on manual review commands, seeManually request code reviews.

We recommend leaving this option enabled.

Base Branches​

A list of branches that CodeRabbit performs automatic code reviews on, otherthan the reposiorty's main branch (usuallymain ormaster.)

For example, if you addstaging as a base branch, then CodeRabbit automaticallyreviews pull requests on both your repository's default branch and itsstaging branch.

Drafts​

If defined, then CodeRabbit automatically reviews pull requests marked as a draftin your Git platform.

Ignore Title Keywords​

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

Labels​

If defined with at least one label, then CodeRabbit automatically reviewsonly pull requests that have at least one of the labels in this list.

In this case, you can manually request reviews of pull requests lacking a qualifying label. For more information on manual review commands, seeManually request code reviews.

Finishing Touches​

Docstrings​

If enabled, then CodeRabbit can generate inline documentation for functionsadded in a pull request. For more information, seeDocstrings.

Unit Tests​

If enabled, then CodeRabbit can generate unit tests for codeadded in a pull request. For more information, seeUnit Test Generation.

Chat​

Auto Reply​

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

Integrations​

Jira​

Enable the Jira integration for opening issues, etc. 'auto' disables the integration for public repositories.

Linear​

Enable the Linear integration for opening issues, etc. 'auto' disables the integration for public repositories.

Knowledge Base​

Basic settings​

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.

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.

Web Search​

Enable the web search integration.

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.

Jira​

Enable Jira​

Enable the Jira knowledge base integration. 'auto' disables the integration for public repositories.

Project Keys​

Specify the Jira project keys to use for the knowledge base.

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.

Linear​

Enable Linear​

Enable the Linear knowledge base integration. 'auto' disables the integration for public repositories.

Team Keys​

Specify the Linear team keys (identifiers) to use for the knowledge base. E.g. 'ENG'

Code Generation​

Code Generation Language​

Set the language for docstrings by using the corresponding ISO language code.

Docstring Path Instructions​

Provide additional guidelines for docstring generation based on file paths.

Unit Test Path Instructions​

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

Tools​

CodeRabbit integrates with various third-party tools for enhanced code analysis.

actionlint​

actionlint is a static checker for GitHub Actions workflow files.

Enable actionlint​

is a static checker for GitHub Actions workflow files.

ast-grep​

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.1

Essential Rules​

Use ast-grep essentials package.

Packages​

Predefined packages to be used.

Rule Dirs​

List of rules directories.

Util Dirs​

List of utils directories.

Biome​

Biome is a fast formatter, linter, and analyzer for web projects.

Enable Biome​

Biome is a fast formatter, linter, and analyzer for web projects.

Brakeman​

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

Enable Brakeman​

Brakeman is a static analysis security vulnerability scanner for Ruby on Rails applications.

Buf​

Buf offers linting for Protobuf files.

Enable Buf​

Buf offers linting for Protobuf files.

checkmake​

checkmake is a linter for Makefiles.

Enable checkmake​

checkmake is a linter for Makefiles.

Checkov​

Checkov is a static code analysis tool for infrastructure-as-code files.

Enable Checkov​

Checkov is a static code analysis tool for infrastructure-as-code files.

CircleCI​

CircleCI tool is a static checker for CircleCI config files.

Enable CircleCI​

CircleCI tool is a static checker for CircleCI config files.

Clippy​

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

Enable Clippy​

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

Cppcheck​

Cppcheck is a static code analysis tool for the C and C++ programming languages.

Enable Cppcheck​

Cppcheck is a static code analysis tool for the C and C++ programming languages.

detekt​

Detekt is a static code analysis tool for Kotlin files.

Enable detekt​

Enable detekt.

Config File​

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

dotenv-linter​

dotenv-linter is a tool for checking and fixing .env files for problems and best practices

Enable dotenv-linter​

dotenv-linter is a tool for checking and fixing .env files for problems and best practices

ESLint​

ESLint is a static code analysis tool for JavaScript files.

Enable ESLint​

ESLint is a static code analysis tool for JavaScript files.

Flake8​

Flake8 is a static code analysis tool for Python files.

Enable Flake8​

Flake8 is a static code analysis tool for Python files.

GitHub Checks​

GitHub Checks integration configuration.

Enable GitHub Checks​

Enable integration, defaults to true

Timeout Ms​

Time in milliseconds to wait for all GitHub Checks to conclude.

Gitleaks​

Gitleaks is a secret scanner.

Enable Gitleaks​

Gitleaks is a secret scanner.

golangci-lint​

golangci-lint is a fast linters runner for Go.

Enable golangci-lint​

Enable golangci-lint.

Config File​

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'.

Hadolint​

Hadolint is a Dockerfile linter.

Enable Hadolint​

Hadolint is a Dockerfile linter.

HTMLHint​

HTMLHint is a static code analysis tool for HTML files.

Enable HTMLHint​

Enable HTMLHint.

Config File​

Optional path to the HTMLHint configuration file relative to the repository. This is useful when the configuration file is named differently than the default '.htmlhintrc'.

LanguageTool​

LanguageTool is a style and grammar checker for 30+ languages.

Disabled Categories​

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

Disabled Rules​

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

Enable LanguageTool​

Enable LanguageTool

Enabled Categories​

IDs of categories to be enabled.

Enabled Only​

Only the rules and categories whose IDs are specified with 'enabledRules' or 'enabledCategories' are enabled.

Enabled Rules​

IDs of rules to be enabled. The rule won't run unless 'level' is set to a level that activates the rule.

Level​

If set to 'picky', additional rules will be activated, i.e. rules that you might only find useful when checking formal text.

Luacheck​

Configuration for Lua code linting to ensure code quality

Enable Luacheck​

Luacheck helps maintain consistent and error-free Lua code

markdownlint​

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

Enable markdownlint​

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

Oxlint​

Oxlint is a JavaScript/TypeScript linter for OXC written in Rust.

Enable Oxlint​

Oxlint is a JavaScript/TypeScript linter for OXC written in Rust.

PHPStan​

PHPStan is a tool to analyze PHP code.

Enable PHPStan​

PHPStan requiresconfig file in your repository root. Please ensure that this file contains thepaths: parameter.

Level​

Specify therule level to run. This setting is ignored if your configuration file already has alevel: parameter.

PMD​

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

Enable PMD​

Enable PMD.

Config File​

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

PHPMD​

PHPMD is a static code analysis tool for PHP files.

Enable PHPMD​

PHPMD is a static code analysis tool for PHP files.

PHPCS​

PHPCS is a static code analysis and coding-standard checker for PHP (plus JS/CSS) files.

Enable PHPCS​

PHPCS is a static code analysis tool for PHP, JavaScript and CSS files.

Prisma Schema Linting​

Configuration for Prisma Schema linting to ensure schema file quality

Enable Prisma Schema Linting​

Prisma Schema linting helps maintain consistent and error-free schema files

Pylint​

Pylint is a Python static code analysis tool.

Enable Pylint​

Pylint is a Python static code analysis tool.

Regal​

Regal is a linter and language server for Rego.

Enable Regal​

Regal is a linter and language server for Rego.

RuboCop​

RuboCop is a Ruby static code analyzer (a.k.a. linter ) and code formatter.

Enable RuboCop​

RuboCop is a Ruby static code analyzer (a.k.a. linter ) and code formatter.

Ruff​

Ruff is a Python linter and code formatter.

Enable Ruff​

Ruff is a Python linter and code formatter.

Semgrep​

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

Enable Semgrep​

Enable Semgrep.

Config File​

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

ShellCheck​

ShellCheck is a static analysis tool that finds bugs in your shell scripts.

Enable ShellCheck​

ShellCheck is a static analysis tool that finds bugs in your shell.

Shopify Theme Check​

Configuration for Shopify Theme Check to ensure theme quality and best practices

Enable Shopify Theme Check​

A linter for Shopify themes that helps you follow Shopify theme & Liquid best practices

SQLFluff​

SQLFluff is an open source, dialect-flexible and configurable SQL linter.

Enable SQLFluff​

SQLFluff is an open source, dialect-flexible and configurable SQL linter.

SwiftLint​

SwiftLint integration configuration object.

Enable SwiftLint​

Enable SwiftLint.

Config File​

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'.

YAMLlint​

YAMLlint is a linter for YAML files.

Enable YAMLlint​

YAMLlint is a linter for YAML files.