Configuration V2 reference

This reference is automatically generated from the CodeRabbit configuration schema. Last updated: November 13, 2026

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. This page documents V2, used when the file omits version or declares version: 2. For eligible organizations using the V3 preview, see the V3 reference and migration guide.

Quick Start

Get started with basic configuration

YAML config examples

Browse example configurations

Configuration sections

General settings

Configure general settings

Code reviews

Configure automatic code reviews, tools, and review behavior

Chat

Configure interactive chat features

Knowledge base

Configure knowledge base features

Code generation

Configure code generation settings

Issue enrichment

Configure automatic Issue enrichment and planning

General settings

enum

default:"en-US"

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, zh-TW, 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, bn

string

default:""

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

Max length: 250

boolean

default:false

Enable early-access features.

boolean

default:true

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

boolean

default:false

Inheritance: Use parent settings for any values not defined here. Inheritance only propagates upward if enabled at each level.Learn more: Configuration inheritance

Reviews

Settings related to reviews.

enum

default:"chill"

Set the review profile: quiet for only the most important feedback, chill for balanced feedback, assertive for more feedback (which may feel nitpicky).One of the following: quiet, chill, assertive

quiet: Posts only the most important comments inline and groups the other review comments in the review summary.
chill: Balanced feedback.
assertive: More feedback, which may feel nitpicky.

string

Merge Risk Instructions: Describe what makes a pull request more or less risky to merge in this codebase. CodeRabbit uses this when rating merge risk, which auto_approvals.max_merge_risk can limit for automatic approval. Up to 3000 characters. Example: Database migrations and billing changes are high risk. Docs-only and test-only changes are low risk.

Max length: 3000

Learn more: Merge Risk

string

Security Risk Instructions: Describe facts about your system that affect security risk, such as which services are internet-facing, where tenant isolation is enforced, or which controls protect a path. CodeRabbit uses this when rating security architecture risk, which auto_approvals.max_security_risk can limit for automatic approval. Security risk assessments require the Advanced plan or above. Unlike Security scan context, which guides security findings in reviews and scans, this only affects the risk rating. Up to 3000 characters. Example:

The admin service is reachable only over the corporate VPN. Changes to tenant isolation in packages/tenancy are high risk.

Max length: 3000

Learn more: Security Architecture Review

boolean

default:true

Generate a high-level summary of the changes in the PR description or walkthrough.Learn more: PR Summaries

string

default:""

By default, CodeRabbit generates release notes in the description. Use this to customize the summary content and format. Example: ‘Create concise release notes as a bullet-point list, followed by a Markdown table showing lines added and removed by each contributing author.’ Note: Use high_level_summary_in_walkthrough to place the summary in the walkthrough instead of the description.Learn more: PR Summaries

string

default:"@coderabbitai summary"

Placeholder in the PR description that CodeRabbit replaces with the high-level summary. If high_level_summary is false, the summary is still generated when this placeholder is present.Learn more: PR Summaries

boolean

default:false

Include the high-level summary in the walkthrough comment.Learn more: PR Summaries

string

default:"@coderabbitai"

Add this keyword to the PR title to auto-generate a title.

string

default:""

Auto Title Instructions: Customize how CodeRabbit generates the PR title.

boolean

default:true

Post review status messages (e.g., when a review is skipped) in the walkthrough summary comment.Learn more: PR Walkthroughs

boolean

default:true

Post review information such as the configuration used, reviewed commits, and skipped files.

boolean

default:false

Post review details (ignored files, extra context used, suppressed comments, etc.).

boolean

default:true

On GitHub with CodeRabbit Cloud, report each review as a check run named CodeRabbit that shows the review’s progress and outcome. When disabled, CodeRabbit posts the CodeRabbit commit status instead, if commit_status is enabled. GitLab, Azure DevOps, Bitbucket, and self-hosted CodeRabbit use the commit status.Learn more: CodeRabbit status check

boolean

default:true

Post a commit status named CodeRabbit on the pull request’s latest commit. It is pending while CodeRabbit reviews and turns successful when the review ends, including when it is skipped or rate limited. Used on GitLab, Azure DevOps, Bitbucket, and self-hosted CodeRabbit, and on GitHub when review_progress is disabled. Require it in branch protection to keep pull requests from merging while a review is in progress.Learn more: CodeRabbit status check

boolean

default:false

Report a review that stops because of an error as failed, so a required CodeRabbit check blocks merging. When disabled, the GitHub check run ends as neutral and the commit status ends as successful, with the error in its description. Rate-limited reviews never fail.Learn more: CodeRabbit status check

boolean

default:true

Wrap the walkthrough in a Markdown collapsible section.Learn more: PR Walkthroughs

boolean

default:true

Include a summary of the changed files in the walkthrough.Learn more: PR Walkthroughs

boolean

default:true

Include sequence diagrams in the walkthrough.Learn more: PR Walkthroughs

boolean

default:true

Include an estimated code review effort in the walkthrough.Learn more: PR Walkthroughs

boolean

default:true

Include an assessment of how well the changes address linked issues in the walkthrough.Learn more: PR Walkthroughs

Include potentially related issues in the walkthrough.Learn more: PR Walkthroughs

Related PRs: Include potentially related PRs in the walkthrough.Learn more: PR Walkthroughs

boolean

default:true

Suggest labels based on the changes, and include them in the walkthrough.Learn more: PR Walkthroughs

array of object

default:[]

Labeling Instructions: Define allowed labels and when to suggest them. When provided, CodeRabbit suggests only from this list (still informed by prior PRs); when empty, suggestions rely entirely on prior PRs.

Show options

string

Label to suggest for the PR. Example: frontend

string

Instructions for the label. Example: Apply when the PR contains changes to React components.

Max length: 3000

.coderabbit.yaml

reviews:
  labeling_instructions:
    - label: "frontend"
      instructions: "Apply when the PR contains changes to React components."
    - label: "coderabbit"
      instructions: "Apply if this PR contains changes to `.coderabbit.yaml`."

object

Mutually Exclusive Groups: Define labels that should not coexist. Example: { risk: ['critical', 'high', 'medium', 'low'] }.

boolean

default:false

Automatically apply suggested labels to the PR.

boolean

default:true

Suggest reviewers based on the changes, and include them in the walkthrough.Learn more: PR Walkthroughs

boolean

default:false

Automatically assign the suggested reviewers to the PR.Learn more: PR Walkthroughs

array of object

default:[]

Reviewer Instructions: Map reviewers (users or team) to PR scenarios where they should be assigned. When empty, suggestions rely on prior PRs. Team handles are supported only on GitHub.Learn more: PR Walkthroughs

Show options

array of object

List of reviewers to assign when the PR matches the instructions below. Each entry pairs a handle (username or team slug) with its type (user or group).

Show options

string

Reviewer username or team slug to assign. Example: security-pdl

Min length: 1

enum

default:"user"

Whether the reviewer is an individual user or a team/group.One of the following: user, group

string

Instructions for when to assign these reviewers. Example: Assign when the PR contains Windows registry changes.

Min length: 1, Max length: 3000

boolean

default:true

Post a fortune message while the review is running.Learn more: PR Walkthroughs

boolean

default:false

Generate a poem in the walkthrough comment.Learn more: PR Walkthroughs

boolean

default:true

Prompt for Coding Agents: Include the ’🤖 Prompt for Coding Agents’ section in inline review comments to provide codegen instructions for AI agents.

array of string

default:[]

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.Learn more: Path-based review instructions

.coderabbit.yaml

reviews:
  path_filters:
    - "src/**"
    - "!src/generated/**"

array of object

default:[]

Path Instructions: Add path-specific guidance for code review.Learn more: Path-based review instructions

Show options

string

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

string

Additional review guidance for matching paths.

Max length: 20000

.coderabbit.yaml

reviews:
  path_instructions:
    - path: "src/controllers/**"
      instructions: |
        - Focus on authentication, authorization, and input validation.
        - Flag any direct database queries that bypass the ORM layer.
    - path: "tests/**"
      instructions: |
        Ensure descriptive test names are used and that edge cases and error paths are covered.

boolean

default:true

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

boolean

default:false

Disable caching of code and dependencies; fetch them fresh on each run.Learn more: Caching

array of object

default:[]

Custom Post-merge Actions: Define custom actions to run after merging. Each action needs a unique name (≤100 chars) and a deterministic prompt (≤10,000 chars).Learn more: Post-Merge Actions

Show options

boolean

default:true

Enabled: Run this action after a PR is merged.

string

default:""

Name: Display name (max 100 characters).

Min length: 1, Max length: 100

string

default:""

Prompt: Deterministic instructions describing the action to perform (max 10,000 characters).

Min length: 1, Max length: 10000

Automatic approvals

reviews.auto_approvals Control automatic approval, optional risk limits, and overrides for teams or paths. Limits and disabled overrides apply to approve and resolve commands too. Missing, failed, disabled or stale required assessments withhold approval. Learn more: Approval risk limits

boolean

default:false

Automatic approvals: Request changes for blocking findings. Automatically approve when required threads are resolved, the latest commit is reviewed, pre-merge checks pass, and configured risk limits are satisfied. In GitLab, required discussions must be resolved.Learn more: Automatic Approvals

enum

Maximum merge risk for approval: Highest inclusive merge risk that permits approval. Omitted limits can be inherited; merge risk is unrestricted only when no configuration source sets a limit. A configured limit requires an assessment covering the current commit.One of the following: minimal, low, moderate, high, criticalLearn more: Approval risk limits

boolean

default:true

Allow author approval commands: Allow pull request authors to use top-level @coderabbitai approve and @coderabbitai resolve commands on their own pull requests. When disabled, another reviewer must run them. The pull request’s branch configuration cannot re-enable this permission. Commands still honor approval risk limits. This does not require human review or change automatic approvals after normal review requirements pass.Learn more: Automatic Approvals

enum

Maximum security risk for approval: Highest inclusive security architecture risk that permits approval. Security risk assessments require the Advanced plan or above. Omitted limits can be inherited; security risk is unrestricted only when no configuration source sets a limit. This is separate from Security finding severity. A configured limit requires an assessment covering the current commit.One of the following: minimal, low, moderate, high, criticalLearn more: Approval risk limits

array of object

Overrides: Disable approvals or override risk limits by author team, changed paths, or both. When teams and paths are set, both must match. A matching file applies the override to the whole pull request. Any matching disabled override withholds approval. Otherwise, the strictest explicitly configured value wins for each limit; omitted values inherit the global limit. At most 15 distinct teams may be checked. Unavailable required team membership or changed-file evidence withholds approval.Learn more: Approval risk limits

Show options

boolean

Automatic approvals: Set to false to withhold approval for matching pull requests, regardless of risk. Omit to use the global setting. Any matching disabled override wins. Review comments and requests for changes continue normally; overrides cannot turn on a globally disabled workflow.

array of string

Teams: Apply this override when the pull request author belongs to any listed GitHub team. Use organization/team-slug.

array of string

Paths: Apply this override when any changed file matches these repository-relative globs. Uses the same glob syntax as path_filters, including ! exclusions. Renames match both old and new paths. When teams and paths are set, both must match. Omit to match all paths.

enum

Maximum merge risk for approval: Override the global merge-risk limit for matching pull requests. Omit to inherit the global limit.One of the following: minimal, low, moderate, high, critical

enum

Maximum security risk for approval: Override the global security-risk limit for matching pull requests. Omit to inherit the global limit. Security risk assessments require the Advanced plan or above.One of the following: minimal, low, moderate, high, critical

Anti-Slop

reviews.slop_detection Settings for detecting spam or low-quality pull requests and merge requests. Private repositories require the Essentials plan or higher. Public GitHub, GitLab, and Bitbucket repositories are eligible on all plans. Author exemptions, integration availability, labeling, and rechecks vary by platform. Learn more: Slop Detection

boolean

default:true

Enable or disable slop and low-quality PR detection.

boolean

default:false

Include authors otherwise exempt because of their repository relationship, including same-repository pull requests on Azure DevOps and Bitbucket. Recognized automation accounts remain exempt.Learn more: Slop Detection

string

Label to apply when a request is classified as spam or slop on platforms that support labeling. The label is applied in addition to the warning in the PR Walkthrough comment. When no label is configured, only the warning is added. Requests with this label are eligible for analysis on subsequent reviews on GitHub, GitLab, and Azure DevOps. Bitbucket does not support label-based rechecks.

Min length: 1

Learn more: Slop Detection

Auto review

reviews.auto_review Learn more: Automatic review controls

boolean

default:true

Automatic Review: Review PRs automatically.

string

default:""

Keyword in the PR description that triggers a review when automatic reviews are disabled. If enabled is false and this field is not empty, CodeRabbit reviews the PR only when this keyword is present in the description.

boolean

default:true

Incremental Review: Re-run the review on each push.

integer

default:5

Auto Pause After Reviewed Commits: Pause automatic reviews after this many reviewed commits since the last pause. Set to 0 to disable.

Min: 0, Max: 9007199254740991

array of string

default:[]

Skip reviews when the PR title contains any of these keywords (case-insensitive).

array of string

default:[]

Labels that control which PRs are reviewed. Labels starting with ’!’ are negative matches. Examples: [‘bug’, ‘feature’] reviews PRs with either label. [‘!wip’] reviews all PRs except those labeled ‘wip’ when automatic reviews are enabled. [‘bug’, ‘!wip’] reviews PRs labeled ‘bug’ but not ‘wip’. When enabled is false, a positive label match (for example [‘review-ready’]) triggers a review; negative-only labels such as [‘!wip’] remain exclusion filters and do not opt PRs in by themselves.

.coderabbit.yaml

reviews:
  auto_review:
    enabled: false
    labels:
      - "review-ready"

boolean

default:false

Include draft PRs.

array of string

default:[]

Base branches (other than the default branch) to review. Accepts regex patterns. Use ’.*’ to match all branches.Each entry is a regular expression tested against the target branch name without anchoring, so develop also matches develop-2. Use ^ and $ to match the whole name.

.coderabbit.yaml

reviews:
  auto_review:
    base_branches:
      - "^develop$"
      - "^release/.*$"

array of string

default:[]

Skip reviews for pull requests authored by these usernames. Matching is exact and case-sensitive. Bitbucket Cloud matches the author’s display name, and Azure DevOps matches their unique name, usually the sign-in email, in lowercase.Learn more: Automatic review controls

Finishing touches

reviews.finishing_touches Learn more: Finishing Touches overview

object

Unit Tests: Configure unit test generation.

Show options

boolean

default:true

Unit Tests: Generate unit tests for changes in PRs.

object

Simplify: Configure code simplification.

Show options

boolean

default:false

Simplify: Enable the simplify finishing touch (trigger via the ✨ Simplify code checkbox). CodeRabbit reviews changed code for reuse, quality, and efficiency, then applies targeted improvements.

object

Fix comments: Configure the Fix comments finishing touch for one-off review repairs.Learn more: Fix comments: apply CodeRabbit code fixes to pull requests

Show options

boolean

default:true

Fix comments: Enable the Fix comments finishing touch (trigger via the Fix comments checkbox in a GitHub review comment or the @coderabbitai fix comments command). When disabled, the review checkbox and command instructions are hidden, the command is removed from help, and CodeRabbit declines one-off repair requests, including compatibility aliases, with or without stacked pr.

object

Fix Failing CI: Configure the CI fixer.Learn more: Fix CI failures

Show options

boolean

default:true

Fix Failing CI: Enable the fix-ci finishing touch on GitHub and Azure DevOps; requires a Team plan. When CI failures are attributed to the current pull request, Finishing Touches offers the delivery modes supported by the repository. Where both modes are available, it offers mutually exclusive stacked-pull-request and direct-commit options; where stacked-pull-request delivery is unavailable but direct commits are supported, it offers direct commit only. The @coderabbitai fix-ci command requests a stacked pull request by default, but commits in place on a CodeRabbit-authored pull request to avoid creating another stacked pull request. Use @coderabbitai fix-ci commit to request a direct commit. When disabled, both commands are removed from help and CodeRabbit declines fix-ci requests.

object

Resolve Merge Conflicts: Configure the merge-conflict resolver.Learn more: Resolve Merge Conflicts

Show options

boolean

default:true

Resolve Merge Conflicts: Enable the merge-conflict resolver (trigger via @coderabbitai resolve merge conflict). CodeRabbit analyzes the intent behind both sides of a conflict and commits a resolution to your branch. When disabled, the command is removed from help and CodeRabbit declines resolution requests. Available on GitHub and GitLab; requires a Team plan.

array of object

default:[]

Custom Recipes: Define custom finishing touch recipes up to your plan limit. Trigger a recipe with @coderabbitai run <recipe name>.Learn more: Custom Finishing Touch recipes

Show options

boolean

default:true

Enabled: Enable this custom finishing touch recipe.

string

default:""

Name: Recipe name used in commands (for example: @coderabbitai run cleanup stale imports). Run with @coderabbitai run <recipe name>.

Min length: 1, Max length: 100

string

default:""

Instructions: Describe what this recipe should do. Trigger with @coderabbitai run <recipe name> or the checkbox under ”✨ Finishing Touches”. CodeRabbit provides PR context and runs this with an agent.

Min length: 1, Max length: 10000

Pre-Merge Checks

reviews.pre_merge_checks Learn more: Built-in Pre-Merge Checks

boolean

default:false

Override Requested Reviewers Only: When enabled, the pull request author cannot override/ignore failing pre-merge checks. Eligible actors are individually requested reviewers and, on GitHub, members of requested reviewer teams or submitted reviewers whose author association is OWNER, MEMBER, or COLLABORATOR.

object

Title Check: Validate the PR title against the requirements.

Show options

enum

default:"warning"

Mode: Enforcement level: off disables the check, warning posts a warning, and error requires resolution before merging. If the request-changes workflow is enabled, error can block the PR until the check passes.One of the following: off, warning, error

string

default:""

Requirements: Describe title requirements. Example: ‘Title should be concise and descriptive, ideally under 50 characters.’

object

Description Check: Check that the PR description follows best practices.

Show options

enum

default:"warning"

object

Linked Issue Assessment: Assess how well the PR addresses linked issues.

Show options

enum

default:"warning"

array of object

default:[]

Custom Pre-merge Checks: Define custom checks that must pass before merging. Each check needs a unique name (≤50 chars) and deterministic instructions (≤10,000 chars).Learn more: Custom checks

Show options

enum

default:"warning"

string

default:""

Name: Display name (max 50 characters).

Min length: 1, Max length: 50

string

default:""

Instructions: Deterministic pass/fail criteria (max 10,000 characters).

Min length: 1, Max length: 10000

.coderabbit.yaml

reviews:
  pre_merge_checks:
    custom_checks:
      - name: "Undocumented Breaking Changes"
        mode: "warning"
        instructions: |
          All breaking changes to public APIs, CLI flags, environment variables, or database schemas must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md.

Tools

reviews.tools Tools that provide additional context to code reviews. Learn more: Third-party tools overview

object

ast-grep is a code analysis tool that helps you to find patterns in your codebase using abstract syntax trees patterns.Version: v0.51.1

Show options

boolean

default:true

Enable ast-grep

array of string

default:[]

List of rules directories.

array of string

default:[]

List of utils directories.

boolean

default:true

Use ast-grep essentials package.

array of string

default:[]

Predefined packages to be used.

object

ShellCheck is a static analysis tool that finds bugs in your shell scripts.Version: v0.11.0

Show options

boolean

default:true

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

object

Ruff is a Python linter and code formatter.Version: v0.17.4

Show options

boolean

default:true

Enable Ruff

string

Optional path to a Ruff configuration file relative to the repository. When set, this configuration is used for every reviewed file instead of Ruff’s closest-config discovery.

object

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

Show options

boolean

default:true

Enable markdownlint

object

GitHub Checks integration configuration.

Show options

boolean

default:true

Enable GitHub Checks: Enable integration, defaults to true

object

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

Show options

boolean

default:true

Enable LanguageTool: Enable LanguageTool integration.

array of string

default:[]

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

array of string

default:[]

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

array of string

default:[]

IDs of categories to be enabled.

array of string

default:[]

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

boolean

default:false

Run only the rules and categories listed in enabled_rules or enabled_categories, instead of the default set.With enabled_only: true, at least one rule or category is required. If both lists are empty, CodeRabbit skips LanguageTool and reports an error.

enum

default:"default"

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, picky

object

Biome is a fast formatter, linter, and analyzer for web projects.Version: v2.6.3

Show options

boolean

default:true

Enable Biome

object

Hadolint is a Dockerfile linter.Version: v2.15.1

Show options

boolean

default:true

Enable Hadolint

object

SwiftLint integration configuration object.Version: v0.65.1

Show options

boolean

default:true

Enable SwiftLint: SwiftLint is a Swift linter.

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

object

PHPStan is a tool to analyze PHP code.Version: v2.3.3

Show options

boolean

default:true

Enable PHPStan: PHPStan requires config file in your repository root. Please ensure that this file contains the paths: parameter.

enum

default:"default"

Level: Specify the rule level to run. When set to default, the level is determined by the review profile: chill uses level 3 (real bugs only — return/property type mismatches, array offset errors) and assertive uses level 8 (adds dead code detection, argument type checking, null safety, and typehint checks). This setting is ignored if your configuration file already has a level: parameter.One of the following: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, default, max

object

PHPMD is a tool to find potential problems in PHP code.Version: v3.0.0

Show options

boolean

default:true

Enable PHPMD

object

PHP CodeSniffer is a PHP linter and coding standard checker.Version: v3.13.6

Show options

boolean

default:true

Enable PHP CodeSniffer

object

golangci-lint is a fast linters runner for Go.Version: v2.15.0

Show options

boolean

default:true

Enable golangci-lint

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

object

YAMLlint is a linter for YAML files.Version: v1.37.1

Show options

boolean

default:true

Enable YAMLlint

object

Betterleaks is a secret scanner (an improved version of Gitleaks).Version: v1.9.0

Show options

boolean

default:true

Enable Betterleaks

object

TruffleHog is a secret scanner with verification capabilities that can detect and verify secrets in code.Version: v3.99.8

Show options

boolean

default:true

Enable TruffleHog: TruffleHog is a secret scanner with verification capabilities.

object

Checkov is a static code analysis tool for infrastructure-as-code files.Version: v3.3.30

Show options

boolean

default:true

Enable Checkov

object

TFLint is a Terraform linter for finding potential errors and enforcing best practices.Version: v0.66.0

Show options

boolean

default:true

Enable TFLint: TFLint is a Terraform linter for finding potential errors.

object

Detekt is a static code analysis tool for Kotlin files.Version: v1.23.8

Show options

boolean

default:true

Enable detekt: detekt is a static code analysis tool for Kotlin files.

string

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

object

ESLint is a static code analysis tool for JavaScript files.

Show options

boolean

default:true

Enable ESLint

string

Optional path to an ESLint configuration file relative to the repository. When set, this configuration is used for every file instead of discovering ESLint configurations recursively.

object

@e18e/eslint-plugin modernization, performance, and dependency replacement checks.

Show options

boolean

default:true

Enable @e18e/eslint-plugin: Detects dependencies with modern replacements, flags unmaintained packages, and suggests native API alternatives or lighter replacementsVersion: v0.8.1

object

Flake8 is a Python linter that wraps PyFlakes, pycodestyle and Ned Batchelder’s McCabe script.Version: v7.4.1

Show options

boolean

default:true

Enable Flake8

object

Configuration for Infer to find bugs in Java and C/C++ codeVersion: v1.3.0

Show options

boolean

default:true

Enable Infer for static bug analysis in Java and C/C++ code

boolean

default:false

Enable Java analysis: Disabled by default because Java analysis may require compiling more than the changed files.

object

Fortitude is a Fortran linter that checks for code quality and style issues.Version: v0.10.0

Show options

boolean

default:true

Enable Fortitude: Fortitude is a Fortran linter that checks for code quality and style issues

object

RuboCop is a Ruby static code analyzer (a.k.a. linter) and code formatter.Version: v1.92.1

Show options

boolean

default:true

Enable RuboCop

object

Buf offers linting for Protobuf files.Version: v1.74.0

Show options

boolean

default:true

Enable Buf

object

Regal is a linter and language server for Rego.Version: v0.43.0

Show options

boolean

default:true

Enable Regal

object

actionlint is a static checker for GitHub Actions workflow files.Version: v1.7.12

Show options

boolean

default:true

Enable actionlint

object

zizmor is a static security analyzer for GitHub Actions workflow files.Version: v1.31.1

Show options

boolean

default:true

Enable zizmor

object

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

Show options

boolean

default:true

Enable PMD

string

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

object

Configuration for Clang to perform static analysis on C and C++ codeVersion: v23.1.4

Show options

boolean

default:true

Enable Clang for C/C++ static analysis and code quality checks

object

Cppcheck is a static code analysis tool for the C and C++ programming languages.Version: v2.22.0

Show options

boolean

default:true

Enable Cppcheck

object

Vale lints prose using the repository’s checked-in style rules.Version: v3.24.0

Show options

boolean

default:true

Enable Vale: Vale checks prose against repository-defined editorial style rules. It runs only when a supported root Vale configuration is present.

object

Verilator statically analyzes Verilog and SystemVerilog source files.Version: v5.052

Show options

boolean

default:true

Enable Verilator: Verilator lints Verilog and SystemVerilog for syntax, width, connectivity, and behavioral correctness issues.

object

OpenGrep is a high-performance static code analysis engine, compatible with Semgrep configurations.Version: v1.33.0

Show options

boolean

default:true

Enable OpenGrep: OpenGrep is a high-performance static code analysis engine for finding security vulnerabilities and bugs across 17+ languages.

object

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

Show options

boolean

default:true

Enable Semgrep

string

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

object

CircleCI tool is a static checker for CircleCI config files.Version: v1.9.0

Show options

boolean

default:true

Enable CircleCI

object

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

Show options

boolean

default:true

Enable Clippy

object

SQLFluff is an open source, dialect-flexible and configurable SQL linter.Version: v4.4.0

Show options

boolean

default:true

Enable SQLFluff

string

Optional path to the SQLFluff configuration file relative to the repository. Use this when the config file is not named one of SQLFluff’s default filenames.

object

Configuration for Squawk to lint Postgres migrations and SQL for safe schema changesVersion: v2.70.0

Show options

boolean

default:true

Enable Squawk for Postgres migration linting: Detects unsafe schema changes that can cause downtime or blocking locks

object

Trivy is a comprehensive security scanner that detects misconfigurations and secrets in Infrastructure as Code filesVersion: v0.76.2

Show options

boolean

default:true

Enable Trivy for security scanning of IaC files (Terraform, Kubernetes, Docker, etc.)

object

Configuration for Prisma Schema linting to ensure schema file qualityVersion: v0.13.1

Show options

boolean

default:true

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

object

Pylint is a Python static code analysis tool.Version: v4.1.3

Show options

boolean

default:true

Enable Pylint

object

Oxlint is a JavaScript/TypeScript linter for OXC written in Rust.Version: v1.89.0

Show options

boolean

default:true

Enable Oxlint

object

Configuration for Shopify Theme Check to ensure theme quality and best practicesVersion: cli 5.0.0, theme 3.58.2

Show options

boolean

default:true

Enable Shopify Theme Check: A linter for Shopify themes that helps you follow Shopify theme & Liquid best practices

object

Configuration for Lua code linting to ensure code qualityVersion: v1.2.0

Show options

boolean

default:true

Enable Lua code linting: Luacheck helps maintain consistent and error-free Lua code

object

Brakeman is a static analysis security vulnerability scanner for Ruby on Rails applications.Version: v8.1.0

Show options

boolean

default:true

Enable Brakeman

object

dotenv-linter is a tool for checking and fixing .env files for problems and best practicesVersion: v4.0.0

Show options

boolean

default:true

Enable dotenv-linter

object

HTMLHint is a static code analysis tool for HTML files.Version: v1.9.2

Show options

boolean

default:true

Enable HTMLHint

object

Stylelint is a linter for stylesheets (CSS, SCSS, Sass, Less, SugarSS, Stylus) that helps avoid errors and enforce conventions.Version: v17.14.0

Show options

boolean

default:true

Enable Stylelint

object

checkmake is a linter for Makefiles.Version: v0.3.2

Show options

boolean

default:true

Enable checkmake

object

OSV Scanner is a tool for vulnerability package scanning.Version: v2.7.0

Show options

boolean

default:true

Enable OSV Scanner: OSV Scanner is a tool for vulnerability package scanning

object

oasdiff detects breaking changes between OpenAPI specifications.Version: v1.34.0

Show options

boolean

default:true

Enable oasdiff

object

React Doctor scans React codebases for security, performance, correctness, and accessibility issues.Version: v0.9.18

Show options

boolean

default:true

Enable React Doctor

object

Microsoft Presidio Analyzer 2.2.366 detects sensitive identifiers (including payment cards, US SSN, cryptocurrency wallets, and phone numbers) in changed files. Tune entities, thresholds, and languages in repository Presidio configuration (for example .presidiocli or AnalyzerEngineProvider YAML); the built-in scan uses fixed defaults and is skipped when that configuration is present.Version: v2.2.366

Show options

boolean

default:true

Enable Microsoft Presidio Analyzer for high-signal PII in changed files

object

Blinter is a linter for Windows batch files that provides comprehensive static analysis to identify syntax errors, security vulnerabilities, performance issues, and style problems.Version: v1.1.49

Show options

boolean

default:true

Enable Blinter

object

smarty-lint is a linter for Smarty 3 template files that checks for common issues such as incorrect operator usage, naming conventions, empty blocks, and unquoted strings.Version: v0.3.3

Show options

boolean

default:true

Enable smarty-lint

object

ember-template-lint is a linter for Handlebars template files that checks for common issues such as accessibility violations, deprecated patterns, and template anti-patterns.Version: v7.9.4

Show options

boolean

default:true

Enable ember-template-lint

object

SkillSpector is a security scanner for AI agent skills that detects vulnerabilities, malicious patterns, and security risksVersion: v2.12.0

Show options

boolean

default:true

Enable SkillSpector: SkillSpector is a security scanner for AI agent skills. It detects vulnerabilities, malicious patterns, and security risks in SKILL.md manifests and MCP configurations.

object

PSScriptAnalyzer is a static code checker for PowerShell scripts and modules.Version: v1.25.0

Show options

boolean

default:true

Enable PSScriptAnalyzer

Chat

boolean

default:true

Generate art in chat responses (ASCII or emoji).

boolean

default:true

Allow non-organization members to interact with CodeRabbit in comment chat. Set to false to restrict issue/review comment interactions to organization members on GitHub organization repositories. This does not affect automatic PR review eligibility.

boolean

default:true

Let CodeRabbit reply automatically without requiring a mention/tag.

Integrations

chat.integrations

object

Learn more: Jira Integration

Show options

enum

default:"auto"

Jira: Allow creating Jira issues from chat. ‘auto’ disables the integration for public repositories.One of the following: auto, enabled, disabled

string

default:""

Jira Issue Template: Structure to use for the description of Jira issues created from chat. Provide the headings your team expects, one per line, for example ’## Goal’, ’## Description’, ’## Acceptance Criteria’. Leave empty to let CodeRabbit choose the structure.

Max length: 3000

object

Learn more: Linear Integration

Show options

enum

default:"auto"

Linear: Allow creating Linear issues from chat. ‘auto’ disables the integration for public repositories.One of the following: auto, enabled, disabled

Knowledge base

boolean

default:false

Opt Out: Disable knowledge base features that require data retention. Opting out removes any existing stored knowledge base data.Learn more: Knowledge Base overview

enum

default:"disabled"

Automatic Linking Mode: For Auto, private repositories may automatically link to public or private repositories, while public repositories may automatically link only to public repositories. Enabled uses context from any eligible repository in the organization, whether public or private. Disabled creates no automatic repository links. Manual repository links configured below are unaffected.One of the following: auto, enabled, disabledLearn more: Multi-Repo Analysis

boolean

default:false

Automatic Repository Linking: Deprecated. This setting has no effect. Use knowledge_base.automatic_linking_mode instead.Learn more: Multi-Repo Analysis

array of object

default:[]

Linked Repositories: Repositories that CodeRabbit should consider when reviewing PRs in this repo. Use this to surface cross-repo dependencies and catch breaking changes across related codebases.Learn more: Multi-Repo Analysis

Show options

string

Repository name in owner/repo format (e.g., GitHub: myorg/backend-api, Azure DevOps: My Project/backend-api, GitLab: group/subgroup/repo, Bitbucket: workspace/repo)

string

default:""

Optionally provide description and guidance on what this repository contains for CodeRabbit to consider during reviews. Example: ‘Contains REST API endpoints and database models.’

Max length: 2000

Web search

knowledge_base.web_search Learn more: Web Search

boolean

default:true

Web Search: Use web search to gather additional context.

Code guidelines

knowledge_base.code_guidelines Use your coding guideline documents (see File Patterns) as review criteria. Learn more: Code Guidelines

boolean

default:true

Enabled: Apply your organization’s coding standards during reviews.

array of object

default:[]

File Patterns: Additional guideline files, as glob strings or { files, applyTo } objects. A string entry such as **/CODING_STANDARDS.md locates guideline files. An object entry sets files (the guideline documents) and applyTo (the source files they govern, for example **/*.ts), each a comma-separated list of globs. Either form can name a file in another repository of your organization as repo:path or owner/repo:path (for example engineering-standards:frontend/react.md), read from that repository’s default branch. On Azure DevOps Services, use repo:path within the reviewed project or org/project/repo:path for another project in the same organization; write project names with literal spaces. Supplements the default patterns; does not replace them. File names are case-sensitive.

Learnings

knowledge_base.learnings Learn more: Learnings

enum

default:"auto"

Learnings: Choose scope: ‘local’ (repo), ‘global’ (org), or ‘auto’ (local for public repos, global for private repos).One of the following: local, global, auto

auto: When reviewing a public repository, uses only that repository’s learnings. When reviewing a private repository, uses all of your organization’s learnings.
global: Uses all of your organization’s learnings in every review.
local: Uses only the learnings of the repository being reviewed.

integer

default:0

Days admins have to approve or reject a learning before it is automatically applied. Must be an integer between 0 and 30. Set to 0 to apply learnings immediately without approval.

Min: 0, Max: 30

Issues

knowledge_base.issues Learn more: Knowledge Base overview

enum

default:"auto"

Issues: Choose scope for GitHub/GitLab issues: ‘local’ (repo), ‘global’ (org), or ‘auto’ (local for public repos, global for private repos).One of the following: local, global, auto

Jira

knowledge_base.jira Learn more: Knowledge Base overview

enum

default:"auto"

Jira: Use Jira as a knowledge source. ‘auto’ disables the integration for public repositories.One of the following: auto, enabled, disabled

array of string

default:[]

Jira Project Keys: Restrict Jira context to these projects.Learn more: Jira Integration

array of string

default:[]

Jira Excluded Project Keys: Never use these Jira projects as CodeRabbit context, regardless of repository allowlists. Managed at the workspace level as a security policy; exclusions always take precedence over any allowlist.Learn more: Jira Integration

Linear

knowledge_base.linear Learn more: Knowledge Base overview

enum

default:"auto"

Linear: Use Linear as a knowledge source. ‘auto’ disables the integration for public repositories.One of the following: auto, enabled, disabled

array of string

default:[]

Linear Team Keys: Restrict Linear context to these teams (e.g. ‘ENG’).Learn more: Linear Integration

Pull requests

knowledge_base.pull_requests Learn more: Knowledge Base overview

enum

default:"auto"

PRs: Choose scope: ‘local’ (repo), ‘global’ (org), or ‘auto’ (local for public repos, global for private repos).One of the following: local, global, auto

MCP

knowledge_base.mcp Learn more: MCP Servers

enum

default:"auto"

MCP: Use MCP servers as a knowledge source. ‘auto’ disables the integration for public repositories.One of the following: auto, enabled, disabled

auto: Uses MCP servers as a knowledge source on private repositories and skips them on public repositories.
enabled: Uses MCP servers on all repositories, including public ones.
disabled: Never uses MCP servers as a knowledge source.

array of string

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

Code generation

Unit Test Generation

code_generation.unit_tests Settings for generating unit tests. Learn more: Generate unit tests

array of object

default:[]

Path Instructions: Add path-specific guidelines for unit test generation.Learn more: Generate unit tests

Show options

string

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

string

Additional unit-test-generation guidelines for matching paths.

Max length: 20000

Issue enrichment

Auto enrich

issue_enrichment.auto_enrich Settings for automatic issue enrichment. Learn more: Issue Enrichment

boolean

default:false

Automatic Issue Enrichment: Analyze and enrich issues with additional context (related code, potential solutions, complexity assessment).

Planning

issue_enrichment.planning Settings for issue planning. Learn more: Issue Planner

boolean

default:true

Issue Planning: Generate an implementation plan for issues (early preview).

object

Show options

boolean

default:true

Automatic Planning: Trigger issue planning based on labels.

array of string

default:[]

Labels that trigger automatic issue planning. Labels starting with ’!’ are negative matches. Examples: [‘feature’, ‘enhancement’] plans issues with either label. [‘!wip’] plans all issues except those labeled ‘wip’. [‘feature’, ‘!wip’] plans issues labeled ‘feature’ but not ‘wip’.

Labeling

issue_enrichment.labeling Settings for issue labeling. Learn more: Issue Enrichment

array of object

default:[]

Labeling Instructions: Define issue labels to suggest and when to suggest them.

Show options

string

Label to suggest for the issue. Example: enhancement

string

Instructions for the label. Example: New feature or request.

Max length: 3000

boolean

default:false

Automatically apply suggested labels to the issue. When enabled without labeling instructions, labels are auto-suggested based on similar issues.

Review commands

Learn about @coderabbitai commands

Tools reference

Browse all supported linters and analyzers

Quick Start

YAML config examples

Configuration sections

General settings

Code reviews

Chat

Knowledge base

Code generation

Issue enrichment

General settings

Reviews

Automatic approvals

Anti-Slop

Auto review

Finishing touches

Pre-Merge Checks

Tools

Chat

Integrations

Knowledge base

Web search

Code guidelines

Learnings

Issues

Jira

Linear

Pull requests

MCP

Code generation

Unit Test Generation

Issue enrichment

Auto enrich

Planning

Labeling

Related resources

Review commands

Tools reference