CodeRabbit Documentation - AI code reviews on pull requests, IDE, and CLI

This reference is automatically generated from the CodeRabbit configuration schema. Last updated: October 7, 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.

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

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, bnDefaults to "en-US".

string

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

Max length: 250

boolean

Enable early-access features.Defaults to false.

boolean

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

boolean

Inheritance: Use parent settings for any values not defined here. Inheritance only propagates upward if enabled at each level.Defaults to false.

Reviews

Settings related to reviews.

enum

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.

Defaults to "chill".

boolean

Automatically approve when CodeRabbit’s comments are resolved, the latest commit has been reviewed, and no pre-merge checks are failing. Note: In GitLab, all discussions must be resolved.Defaults to false.

boolean

Allow Author Approval: Controls whether pull request authors can use @coderabbitai approve and @coderabbitai resolve on their own pull requests. When disabled, anyone other than the author can still use them, provided CodeRabbit can identify both the commenter and the author. The pull request’s branch configuration cannot re-enable this setting.Defaults to true.

boolean

Generate a high-level summary of the changes in the PR description or walkthrough.Defaults to true.

string

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.Defaults to "".

string

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.Defaults to "@coderabbitai summary".

boolean

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

string

Add this keyword to the PR title to auto-generate a title.Defaults to "@coderabbitai".

string

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

boolean

Post review status messages (e.g., when a review is skipped) in the walkthrough summary comment.Defaults to true.

boolean

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

boolean

Publish the canonical user-facing review status and progress updates (GitHub progress reports/check runs today; other platform equivalents may follow).Defaults to true.

boolean

Mirror review progress using legacy commit statuses for compatibility with required checks and existing automations. This setting is only used when review_progress is disabled.Defaults to true.

boolean

On review errors, fail the active outward review status surface. When review_progress is enabled this applies to progress reporting; otherwise it applies to the legacy commit-status mirror when enabled.Defaults to false.

boolean

Wrap the walkthrough in a Markdown collapsible section.Defaults to true.

boolean

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

boolean

Include sequence diagrams in the walkthrough.Defaults to true.

boolean

Include an estimated code review effort in the walkthrough.Defaults to true.

boolean

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

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

Related PRs: Include potentially related PRs in the walkthrough.Defaults to true.

boolean

Suggest labels based on the changes, and include them in the walkthrough.Defaults to true.

array of object

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.Defaults to [].

Show Array items

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

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

boolean

Suggest reviewers based on the changes, and include them in the walkthrough.Defaults to true.

boolean

Automatically assign the suggested reviewers to the PR.Defaults to false.

array of object

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.Defaults to [].

Show Array items

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 Array items

string

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

Min length: 1

enum

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

string

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

Min length: 1, Max length: 3000

boolean

Post a fortune message while the review is running.Defaults to true.

boolean

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

boolean

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

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

.coderabbit.yaml

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

array of object

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

Show Array items

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

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

boolean

Disable caching of code and dependencies; fetch them fresh on each run.Defaults to false.

array of object

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).Defaults to [].

Show Array items

boolean

Enabled: Run this action after a PR is merged.Defaults to true.

string

Name: Display name (max 100 characters).Defaults to "".

Min length: 1, Max length: 100

string

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

Min length: 1, Max length: 10000

Anti-Slop

reviews.slop_detection Settings for detecting and managing spam or low-quality PRs on GitHub. Available for public repositories on all plans and private repositories on the Essentials plan and above.

boolean

Enable or disable slop and low-quality PR detection.Defaults to true.

boolean

Run slop detection for all PR authors, including collaborators, contributors, organization members, and repository owners.Defaults to false.

string

Label to apply to the PR when it is classified as slop. Example: slop

Min length: 1

Auto review

reviews.auto_review Learn more: Automatic review controls

boolean

Automatic Review: Review PRs automatically.Defaults to true.

string

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.Defaults to "".

boolean

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

integer

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

Min: 0, Max: 9007199254740991

array of string

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

array of string

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.Defaults to [].

.coderabbit.yaml

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

boolean

Include draft PRs.Defaults to false.

array of string

Base branches (other than the default branch) to review. Accepts regex patterns. Use ’.*’ to match all branches.Defaults to [].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

Skip reviews for PRs authored by these usernames (exact match; not email addresses).Defaults to [].

Finishing touches

reviews.finishing_touches Learn more: Finishing Touches overview

object

Docstrings: Configure docstring generation.

Show Docstrings

boolean

Docstrings: Enable the docstrings finishing touch (trigger via the 📝 Generate docstrings checkbox or @coderabbitai generate docstrings). CodeRabbit generates or improves docstrings for functions changed in the PR and opens a follow-up PR containing the docstring edits.Defaults to true.

object

Unit Tests: Configure unit test generation.

Show Unit Tests

boolean

Unit Tests: Generate unit tests for changes in PRs.Defaults to true.

object

Simplify: Configure code simplification.

Show Simplify

boolean

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.Defaults to false.

object

Autofix: Configure autofix behavior.

Show Autofix

boolean

Autofix: Enable the autofix finishing touch (trigger via the 🪄 Autofix checkboxes under review comments or the @coderabbitai autofix command). When disabled, the autofix checkboxes are hidden, the command is removed from help, and CodeRabbit declines @coderabbitai autofix requests.Defaults to true.

object

Fix Failing CI: Configure the CI fixer.

Show Fix Failing CI

boolean

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.Defaults to true.

object

Resolve Merge Conflicts: Configure the merge-conflict resolver.

Show Resolve Merge Conflicts

boolean

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.Defaults to true.

array of object

Custom Recipes: Define custom finishing touch recipes up to your plan limit. Trigger a recipe with @coderabbitai run <recipe name>.Defaults to [].

Show Array items

boolean

Enabled: Enable this custom finishing touch recipe.Defaults to true.

string

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

Min length: 1, Max length: 100

string

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.Defaults to "".

Min length: 1, Max length: 10000

Pre-Merge Checks

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

boolean

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.Defaults to false.

object

Docstring Coverage: Check that docstring coverage meets the configured threshold.

Show Docstring Coverage

enum

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, errorDefaults to "warning".

number

Threshold: Minimum docstring coverage (%) required to pass.Defaults to 80.

Min: 0, Max: 100

object

Title Check: Validate the PR title against the requirements.

Show Title Check

enum

string

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

object

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

Show Description Check

enum

object

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

Show Linked Issue Assessment

enum

array of object

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).Defaults to [].Learn more: Custom checks

Show Array items

enum

string

Name: Display name (max 50 characters).Defaults to "".

Min length: 1, Max length: 50

string

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

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.

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.Version: v0.45.3

Show Enable ast-grep

boolean

Enable ast-grepDefaults to true.

array of string

List of rules directories.Defaults to [].

array of string

List of utils directories.Defaults to [].

boolean

Use ast-grep essentials package.Defaults to true.

array of string

Predefined packages to be used.Defaults to [].

object

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

Show Shellcheck

boolean

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

object

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

Show Ruff

boolean

Enable RuffDefaults to true.

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

Show Markdownlint

boolean

Enable markdownlintDefaults to true.

object

GitHub Checks integration configuration.

Show Github-checks

boolean

Enable GitHub Checks: Enable integration, defaults to trueDefaults to true.

object

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

Show Languagetool

boolean

Enable LanguageTool: Enable LanguageTool integration.Defaults to true.

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 [].

array of string

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

array of string

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

array of string

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

boolean

Run only the rules and categories listed in enabled_rules or enabled_categories, instead of the default set.Defaults to false.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

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

object

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

Show Biome

boolean

Enable BiomeDefaults to true.

object

Hadolint is a Dockerfile linter.Version: v2.15.1

Show Hadolint

boolean

Enable HadolintDefaults to true.

object

SwiftLint integration configuration object.Version: v0.65.1

Show Swiftlint

boolean

Enable SwiftLint: SwiftLint is a Swift linter.Defaults to true.

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

Show Phpstan

boolean

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

enum

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, maxDefaults to "default".

object

PHPMD is a tool to find potential problems in PHP code.Version: v2.15.0

Show Phpmd

boolean

Enable PHPMDDefaults to true.

object

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

Show Phpcs

boolean

Enable PHP CodeSnifferDefaults to true.

object

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

Show Golangci-lint

boolean

Enable golangci-lintDefaults to true.

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 Yamllint

boolean

Enable YAMLlintDefaults to true.

object

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

Show Gitleaks

boolean

Enable BetterleaksDefaults to true.

object

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

Show Trufflehog

boolean

Enable TruffleHog: TruffleHog is a secret scanner with verification capabilities.Defaults to true.

object

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

Show Checkov

boolean

Enable CheckovDefaults to true.

object

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

Show Tflint

boolean

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

object

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

Show Detekt

boolean

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

string

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

object

ESLint is a static code analysis tool for JavaScript files.

Show Eslint

boolean

Enable ESLintDefaults to true.

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 E18e

boolean

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

object

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

Show Flake8

boolean

Enable Flake8Defaults to true.

object

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

Show Fbinfer

boolean

Enable Infer for static bug analysis in Java and C/C++ codeDefaults to true.

boolean

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

object

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

Show Fortitude Lint

boolean

Enable Fortitude: Fortitude is a Fortran linter that checks for code quality and style issuesDefaults to true.

object

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

Show Rubocop

boolean

Enable RuboCopDefaults to true.

object

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

Show Buf

boolean

Enable BufDefaults to true.

object

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

Show Regal

boolean

Enable RegalDefaults to true.

object

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

Show Actionlint

boolean

Enable actionlintDefaults to true.

object

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

Show Zizmor

boolean

Enable zizmorDefaults to true.

object

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

Show Pmd

boolean

Enable PMDDefaults to true.

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: v14.0.6

Show Clang

boolean

Enable Clang for C/C++ static analysis and code quality checksDefaults to true.

object

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

Show Cppcheck

boolean

Enable CppcheckDefaults to true.

object

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

Show Vale

boolean

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

object

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

Show Verilator

boolean

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

object

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

Show Opengrep

boolean

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

object

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

Show Semgrep

boolean

Enable SemgrepDefaults to true.

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

Show Circleci

boolean

Enable CircleCIDefaults to true.

object

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

Show Clippy

boolean

Enable ClippyDefaults to true.

object

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

Show Sqlfluff

boolean

Enable SQLFluffDefaults to true.

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

Show Squawk

boolean

Enable Squawk for Postgres migration linting: Detects unsafe schema changes that can cause downtime or blocking locksDefaults to true.

object

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

Show Trivy

boolean

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

object

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

Show Prisma Lint

boolean

Enable Prisma Schema linting: Prisma Schema linting helps maintain consistent and error-free schema filesDefaults to true.

object

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

Show Pylint

boolean

Enable PylintDefaults to true.

object

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

Show Oxc

boolean

Enable OxlintDefaults to true.

object

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

Show Shopify Theme Check

boolean

Enable Shopify Theme Check: A linter for Shopify themes that helps you follow Shopify theme & Liquid best practicesDefaults to true.

object

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

Show Luacheck

boolean

Enable Lua code linting: Luacheck helps maintain consistent and error-free Lua codeDefaults to true.

object

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

Show Brakeman

boolean

Enable BrakemanDefaults to true.

object

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

Show Dotenv Lint

boolean

Enable dotenv-linterDefaults to true.

object

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

Show Htmlhint

boolean

Enable HTMLHintDefaults to true.

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 Stylelint

boolean

Enable StylelintDefaults to true.

object

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

Show Checkmake

boolean

Enable checkmakeDefaults to true.

object

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

Show Osv Scanner

boolean

Enable OSV Scanner: OSV Scanner is a tool for vulnerability package scanningDefaults to true.

object

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

Show Oasdiff

boolean

Enable oasdiffDefaults to true.

object

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

Show React Doctor

boolean

Enable React DoctorDefaults to true.

object

Microsoft Presidio Analyzer 2.2.364 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.364

Show Presidio

boolean

Enable Microsoft Presidio Analyzer for high-signal PII in changed filesDefaults to true.

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

Show Blinter

boolean

Enable BlinterDefaults to true.

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 Smarty Lint

boolean

Enable smarty-lintDefaults to true.

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

Show Ember Template Lint

boolean

Enable ember-template-lintDefaults to true.

object

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

Show Skillspector

boolean

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.Defaults to true.

object

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

Show Psscriptanalyzer

boolean

Enable PSScriptAnalyzerDefaults to true.

Chat

boolean

Generate art in chat responses (ASCII or emoji).Defaults to true.

boolean

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.Defaults to true.

boolean

Let CodeRabbit reply automatically without requiring a mention/tag.Defaults to true.

Integrations

chat.integrations

object

Show Jira

enum

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

string

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.Defaults to "".

Max length: 3000

object

Show Linear

enum

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

Knowledge base

boolean

Opt Out: Disable knowledge base features that require data retention. Opting out removes any existing stored knowledge base data.Defaults to false.

enum

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, disabledDefaults to "disabled".

boolean

Automatic Repository Linking: Deprecated. This setting has no effect. Use knowledge_base.automatic_linking_mode instead.Defaults to false.

array of object

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.Defaults to [].Learn more: Multi-Repo Analysis

Show Array items

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

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

Max length: 2000

Web search

knowledge_base.web_search Learn more: Web Search

boolean

Web Search: Use web search to gather additional context.Defaults to true.

Code guidelines

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

boolean

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

array of object

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. Supplements the default patterns; does not replace them. File names are case-sensitive.Defaults to [].

Learnings

knowledge_base.learnings Learn more: Learnings

enum

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.

Defaults to "auto".

integer

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.Defaults to 0.

Min: 0, Max: 30

Issues

knowledge_base.issues Learn more: Knowledge Base overview

enum

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, autoDefaults to "auto".

Jira

knowledge_base.jira Learn more: Knowledge Base overview

enum

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

array of string

Jira Project Keys: Restrict Jira context to these projects.Defaults to [].

array of string

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.Defaults to [].

Linear

knowledge_base.linear Learn more: Knowledge Base overview

enum

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

array of string

Linear Team Keys: Restrict Linear context to these teams (e.g. ‘ENG’).Defaults to [].

Pull requests

knowledge_base.pull_requests Learn more: Knowledge Base overview

enum

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

MCP

knowledge_base.mcp Learn more: MCP Servers

enum

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.

Defaults to "auto".

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

Docstring Generation

code_generation.docstrings Settings for generating docstrings.

enum

Language for generated docstrings (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, bnDefaults to "en-US".

array of object

Path Instructions: Add path-specific guidelines for docstring generation.Defaults to [].

Show Array items

string

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

string

Additional docstring-generation guidelines for matching paths.

Max length: 20000

Unit Test Generation

code_generation.unit_tests Settings for generating unit tests.

array of object

Path Instructions: Add path-specific guidelines for unit test generation.Defaults to [].

Show Array items

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.

boolean

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

Planning

issue_enrichment.planning Settings for issue planning.

boolean

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

object

Show Auto planning

boolean

Automatic Planning: Trigger issue planning based on labels.Defaults to true.

array of string

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’.Defaults to [].

Labeling

issue_enrichment.labeling Settings for issue labeling.

array of object

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

Show Array items

string

Label to suggest for the issue. Example: enhancement

string

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

Max length: 3000

boolean

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

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

​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

​Docstring Generation

​Unit Test Generation

​Issue enrichment

​Auto enrich

​Planning

​Labeling

​Related resources

Review commands

Tools reference

Configuration sections

General settings

Reviews

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

Docstring Generation

Unit Test Generation

Issue enrichment

Auto enrich

Planning

Labeling

Related resources