Configuration reference

Complete reference for CodeRabbit configuration options with detailed explanations, types, and examples.

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

language · 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

tone_instructions · 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

early_access · boolean · default: false

Enable early-access features.

enable_free_tier · boolean · default: true

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

inheritance · 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.

reviews.profile · 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.

reviews.request_changes_workflow · boolean · default: false

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.

Learn more: Request changes workflow

reviews.allow_author_approval · boolean · default: true

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.

Learn more: Request changes workflow

reviews.high_level_summary · boolean · default: true

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

Learn more: PR Summaries

reviews.high_level_summary_instructions · 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

reviews.high_level_summary_placeholder · 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

reviews.high_level_summary_in_walkthrough · boolean · default: false

Include the high-level summary in the walkthrough comment.

Learn more: PR Summaries

reviews.auto_title_placeholder · string · default: "@coderabbitai"

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

reviews.auto_title_instructions · string · default: ""

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

reviews.review_status · boolean · default: true

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

Learn more: PR Walkthroughs

reviews.review_info · boolean · default: true

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

reviews.review_details · boolean · default: false

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

reviews.review_progress · boolean · default: true

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

reviews.commit_status · boolean · default: true

Mirror review progress using legacy commit statuses for compatibility with required checks and existing automations. Applies when review_progress is disabled or the newer progress surface is unavailable for the provider or deployment. Azure DevOps currently uses this fallback even when review_progress is enabled.

Learn more: Azure DevOps

reviews.fail_commit_status · boolean · default: false

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.

reviews.collapse_walkthrough · boolean · default: true

Wrap the walkthrough in a Markdown collapsible section.

Learn more: PR Walkthroughs

reviews.changed_files_summary · boolean · default: true

Include a summary of the changed files in the walkthrough.

Learn more: PR Walkthroughs

reviews.sequence_diagrams · boolean · default: true

Include sequence diagrams in the walkthrough.

Learn more: PR Walkthroughs

reviews.estimate_code_review_effort · boolean · default: true

Include an estimated code review effort in the walkthrough.

Learn more: PR Walkthroughs

reviews.assess_linked_issues · boolean · default: true

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

Learn more: PR Walkthroughs

reviews.related_issues · boolean · default: true

Include potentially related issues in the walkthrough.

Learn more: PR Walkthroughs

reviews.related_prs · boolean · default: true

Related PRs: Include potentially related PRs in the walkthrough.

Learn more: PR Walkthroughs

reviews.suggested_labels · boolean · default: true

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

Learn more: PR Walkthroughs

reviews.labeling_instructions · 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

reviews.labeling_instructions[].label · string

Label to suggest for the PR. Example: frontend

reviews.labeling_instructions[].instructions · 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`."

reviews.mutually_exclusive_groups · object

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

reviews.auto_apply_labels · boolean · default: false

Automatically apply suggested labels to the PR.

reviews.suggested_reviewers · boolean · default: true

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

Learn more: PR Walkthroughs

reviews.auto_assign_reviewers · boolean · default: false

Automatically assign the suggested reviewers to the PR.

Learn more: PR Walkthroughs

reviews.suggested_reviewers_instructions · 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

reviews.suggested_reviewers_instructions[].reviewers · 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

reviews.suggested_reviewers_instructions[].reviewers[].handle · string

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

Min length: 1

reviews.suggested_reviewers_instructions[].reviewers[].type · enum · default: "user"

Whether the reviewer is an individual user or a team/group.

One of the following: user, group

reviews.suggested_reviewers_instructions[].instructions · string

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

Min length: 1, Max length: 3000

reviews.in_progress_fortune · boolean · default: true

Post a fortune message while the review is running.

Learn more: PR Walkthroughs

reviews.poem · boolean · default: false

Generate a poem in the walkthrough comment.

Learn more: PR Walkthroughs

reviews.enable_prompt_for_ai_agents · boolean · default: true

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

reviews.path_filters · 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/**"

reviews.path_instructions · array of object · default: []

Path Instructions: Add path-specific guidance for code review.

Learn more: Path-based review instructions

Show options

reviews.path_instructions[].path · string

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

reviews.path_instructions[].instructions · 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.

reviews.abort_on_close · boolean · default: true

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

reviews.disable_cache · boolean · default: false

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

Learn more: Caching

reviews.post_merge_actions · 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

reviews.post_merge_actions[].enabled · boolean · default: true

Enabled: Run this action after a PR is merged.

reviews.post_merge_actions[].name · string · default: ""

Name: Display name (max 100 characters).

Min length: 1, Max length: 100

reviews.post_merge_actions[].prompt · string · default: ""

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

Min length: 1, Max length: 10000

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

reviews.slop_detection.enabled · boolean · default: true

Enable or disable slop and low-quality PR detection.

reviews.slop_detection.include_all_authors · 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

reviews.slop_detection.label · string

Label to apply when a request is classified as spam or slop on platforms that support labeling. 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

reviews.auto_review.enabled · boolean · default: true

Automatic Review: Review PRs automatically.

reviews.auto_review.description_keyword · 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.

reviews.auto_review.auto_incremental_review · boolean · default: true

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

reviews.auto_review.auto_pause_after_reviewed_commits · 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

reviews.auto_review.ignore_title_keywords · array of string · default: []

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

reviews.auto_review.labels · 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"

reviews.auto_review.drafts · boolean · default: false

Include draft PRs.

reviews.auto_review.base_branches · 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/.*$"

reviews.auto_review.ignore_usernames · 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

reviews.finishing_touches.docstrings · object

Docstrings: Configure docstring generation.

Show options

reviews.finishing_touches.docstrings.enabled · boolean · default: true

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.

reviews.finishing_touches.unit_tests · object

Unit Tests: Configure unit test generation.

Show options

reviews.finishing_touches.unit_tests.enabled · boolean · default: true

Unit Tests: Generate unit tests for changes in PRs.

reviews.finishing_touches.simplify · object

Simplify: Configure code simplification.

Show options

reviews.finishing_touches.simplify.enabled · 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.

reviews.finishing_touches.autofix · 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

reviews.finishing_touches.autofix.enabled · 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.

reviews.finishing_touches.fix_ci · object

Fix Failing CI: Configure the CI fixer.

Learn more: Fix CI failures

Show options

reviews.finishing_touches.fix_ci.enabled · 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.

reviews.finishing_touches.resolve_merge_conflict · object

Resolve Merge Conflicts: Configure the merge-conflict resolver.

Learn more: Resolve Merge Conflicts

Show options

reviews.finishing_touches.resolve_merge_conflict.enabled · 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.

reviews.finishing_touches.custom · 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

reviews.finishing_touches.custom[].enabled · boolean · default: true

Enabled: Enable this custom finishing touch recipe.

reviews.finishing_touches.custom[].name · 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

reviews.finishing_touches.custom[].instructions · 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

reviews.pre_merge_checks.override_requested_reviewers_only · 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.

reviews.pre_merge_checks.docstrings · object

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

Show options

reviews.pre_merge_checks.docstrings.mode · 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

reviews.pre_merge_checks.docstrings.threshold · number · default: 80

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

Min: 0, Max: 100

reviews.pre_merge_checks.title · object

Title Check: Validate the PR title against the requirements.

Show options

reviews.pre_merge_checks.title.mode · 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

reviews.pre_merge_checks.title.requirements · string · default: ""

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

reviews.pre_merge_checks.description · object

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

Show options

reviews.pre_merge_checks.description.mode · 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

reviews.pre_merge_checks.issue_assessment · object

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

Show options

reviews.pre_merge_checks.issue_assessment.mode · 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

reviews.pre_merge_checks.custom_checks · 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

reviews.pre_merge_checks.custom_checks[].mode · 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

reviews.pre_merge_checks.custom_checks[].name · string · default: ""

Name: Display name (max 50 characters).

Min length: 1, Max length: 50

reviews.pre_merge_checks.custom_checks[].instructions · 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

reviews.tools.ast-grep · object

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 options

reviews.tools.ast-grep.enabled · boolean · default: true

Enable ast-grep

reviews.tools.ast-grep.rule_dirs · array of string · default: []

List of rules directories.

reviews.tools.ast-grep.util_dirs · array of string · default: []

List of utils directories.

reviews.tools.ast-grep.essential_rules · boolean · default: true

Use ast-grep essentials package.

reviews.tools.ast-grep.packages · array of string · default: []

Predefined packages to be used.

reviews.tools.shellcheck · object

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

Version: v0.11.0

Show options

reviews.tools.shellcheck.enabled · boolean · default: true

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

reviews.tools.ruff · object

Ruff is a Python linter and code formatter.

Version: v0.16.9

Show options

reviews.tools.ruff.enabled · boolean · default: true

Enable Ruff

reviews.tools.ruff.config_file · 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.

reviews.tools.markdownlint · object

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

Version: v0.23.3

Show options

reviews.tools.markdownlint.enabled · boolean · default: true

Enable markdownlint

reviews.tools.github-checks · object

GitHub Checks integration configuration.

Show options

reviews.tools.github-checks.enabled · boolean · default: true

Enable GitHub Checks: Enable integration, defaults to true

reviews.tools.languagetool · object

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

Show options

reviews.tools.languagetool.enabled · boolean · default: true

Enable LanguageTool: Enable LanguageTool integration.

reviews.tools.languagetool.enabled_rules · 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.

reviews.tools.languagetool.disabled_rules · array of string · default: []

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

reviews.tools.languagetool.enabled_categories · array of string · default: []

IDs of categories to be enabled.

reviews.tools.languagetool.disabled_categories · array of string · default: []

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

reviews.tools.languagetool.enabled_only · 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.

reviews.tools.languagetool.level · 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

reviews.tools.biome · object

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

Version: v2.5.14

Show options

reviews.tools.biome.enabled · boolean · default: true

Enable Biome

reviews.tools.hadolint · object

Hadolint is a Dockerfile linter.

Version: v2.15.1

Show options

reviews.tools.hadolint.enabled · boolean · default: true

Enable Hadolint

reviews.tools.swiftlint · object

SwiftLint integration configuration object.

Version: v0.65.1

Show options

reviews.tools.swiftlint.enabled · boolean · default: true

Enable SwiftLint: SwiftLint is a Swift linter.

reviews.tools.swiftlint.config_file · string

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

reviews.tools.phpstan · object

PHPStan is a tool to analyze PHP code.

Version: v2.2.16

Show options

reviews.tools.phpstan.enabled · boolean · default: true

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

reviews.tools.phpstan.level · 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

reviews.tools.phpmd · object

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

Version: v2.15.0

Show options

reviews.tools.phpmd.enabled · boolean · default: true

Enable PHPMD

reviews.tools.phpcs · object

PHP CodeSniffer is a PHP linter and coding standard checker.

Version: v3.13.6

Show options

reviews.tools.phpcs.enabled · boolean · default: true

Enable PHP CodeSniffer

reviews.tools.golangci-lint · object

golangci-lint is a fast linters runner for Go.

Version: v2.14.0

Show options

reviews.tools.golangci-lint.enabled · boolean · default: true

Enable golangci-lint

reviews.tools.golangci-lint.config_file · string

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

reviews.tools.yamllint · object

YAMLlint is a linter for YAML files.

Version: v1.37.1

Show options

reviews.tools.yamllint.enabled · boolean · default: true

Enable YAMLlint

reviews.tools.gitleaks · object

Betterleaks is a secret scanner (an improved version of Gitleaks).

Version: v1.9.0

Show options

reviews.tools.gitleaks.enabled · boolean · default: true

Enable Betterleaks

reviews.tools.trufflehog · object

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

Version: v3.96.0

Show options

reviews.tools.trufflehog.enabled · boolean · default: true

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

reviews.tools.checkov · object

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

Version: v3.3.20

Show options

reviews.tools.checkov.enabled · boolean · default: true

Enable Checkov

reviews.tools.tflint · object

TFLint is a Terraform linter for finding potential errors and enforcing best practices.

Version: v0.64.0

Show options

reviews.tools.tflint.enabled · boolean · default: true

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

reviews.tools.detekt · object

Detekt is a static code analysis tool for Kotlin files.

Version: v1.23.8

Show options

reviews.tools.detekt.enabled · boolean · default: true

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

reviews.tools.detekt.config_file · string

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

reviews.tools.eslint · object

ESLint is a static code analysis tool for JavaScript files.

Show options

reviews.tools.eslint.enabled · boolean · default: true

Enable ESLint

reviews.tools.eslint.config_file · 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.

reviews.tools.eslint.e18e · object

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

Show options

reviews.tools.eslint.e18e.enabled · boolean · default: true

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

Version: v0.8.1

reviews.tools.flake8 · object

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

Version: v7.4.1

Show options

reviews.tools.flake8.enabled · boolean · default: true

Enable Flake8

reviews.tools.fbinfer · object

Configuration for Infer to find bugs in Java and C/C++ code

Version: v1.3.0

Show options

reviews.tools.fbinfer.enabled · boolean · default: true

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

reviews.tools.fbinfer.enable_java · boolean · default: false

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

reviews.tools.fortitudeLint · object

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

Version: v0.9.2

Show options

reviews.tools.fortitudeLint.enabled · boolean · default: true

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

reviews.tools.rubocop · object

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

Version: v1.91.0

Show options

reviews.tools.rubocop.enabled · boolean · default: true

Enable RuboCop

reviews.tools.buf · object

Buf offers linting for Protobuf files.

Version: v1.73.0

Show options

reviews.tools.buf.enabled · boolean · default: true

Enable Buf

reviews.tools.regal · object

Regal is a linter and language server for Rego.

Version: v0.43.0

Show options

reviews.tools.regal.enabled · boolean · default: true

Enable Regal

reviews.tools.actionlint · object

actionlint is a static checker for GitHub Actions workflow files.

Version: v1.7.12

Show options

reviews.tools.actionlint.enabled · boolean · default: true

Enable actionlint

reviews.tools.zizmor · object

zizmor is a static security analyzer for GitHub Actions workflow files.

Version: v1.30.1

Show options

reviews.tools.zizmor.enabled · boolean · default: true

Enable zizmor

reviews.tools.pmd · object

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

Version: v7.28.0

Show options

reviews.tools.pmd.enabled · boolean · default: true

Enable PMD

reviews.tools.pmd.config_file · string

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

reviews.tools.clang · object

Configuration for Clang to perform static analysis on C and C++ code

Version: v14.0.6

Show options

reviews.tools.clang.enabled · boolean · default: true

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

reviews.tools.cppcheck · object

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

Version: v2.22.0

Show options

reviews.tools.cppcheck.enabled · boolean · default: true

Enable Cppcheck

reviews.tools.vale · object

Vale lints prose using the repository’s checked-in style rules.

Version: v3.23.0

Show options

reviews.tools.vale.enabled · 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.

reviews.tools.verilator · object

Verilator statically analyzes Verilog and SystemVerilog source files.

Version: v5.052

Show options

reviews.tools.verilator.enabled · boolean · default: true

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

reviews.tools.opengrep · object

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

Version: v1.30.1

Show options

reviews.tools.opengrep.enabled · boolean · default: true

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

reviews.tools.semgrep · object

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

Version: v1.179.0

Show options

reviews.tools.semgrep.enabled · boolean · default: true

Enable Semgrep

reviews.tools.semgrep.config_file · string

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

reviews.tools.circleci · object

CircleCI tool is a static checker for CircleCI config files.

Version: v1.0.51648

Show options

reviews.tools.circleci.enabled · boolean · default: true

Enable CircleCI

reviews.tools.clippy · object

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

Show options

reviews.tools.clippy.enabled · boolean · default: true

Enable Clippy

reviews.tools.sqlfluff · object

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

Version: v4.3.0

Show options

reviews.tools.sqlfluff.enabled · boolean · default: true

Enable SQLFluff

reviews.tools.sqlfluff.config_file · 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.

reviews.tools.squawk · object

Configuration for Squawk to lint Postgres migrations and SQL for safe schema changes

Version: v2.66.0

Show options

reviews.tools.squawk.enabled · boolean · default: true

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

reviews.tools.trivy · object

Trivy is a comprehensive security scanner that detects misconfigurations and secrets in Infrastructure as Code files

Version: v0.74.0

Show options

reviews.tools.trivy.enabled · boolean · default: true

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

reviews.tools.prismaLint · object

Configuration for Prisma Schema linting to ensure schema file quality

Version: v0.13.1

Show options

reviews.tools.prismaLint.enabled · boolean · default: true

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

reviews.tools.pylint · object

Pylint is a Python static code analysis tool.

Version: v4.1.1

Show options

reviews.tools.pylint.enabled · boolean · default: true

Enable Pylint

reviews.tools.oxc · object

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

Version: v1.86.0

Show options

reviews.tools.oxc.enabled · boolean · default: true

Enable Oxlint

reviews.tools.shopifyThemeCheck · object

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

Version: cli 4.8.3, theme 3.58.2

Show options

reviews.tools.shopifyThemeCheck.enabled · boolean · default: true

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

reviews.tools.luacheck · object

Configuration for Lua code linting to ensure code quality

Version: v1.2.0

Show options

reviews.tools.luacheck.enabled · boolean · default: true

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

reviews.tools.brakeman · object

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

Version: v8.0.6

Show options

reviews.tools.brakeman.enabled · boolean · default: true

Enable Brakeman

reviews.tools.dotenvLint · object

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

Version: v4.0.0

Show options

reviews.tools.dotenvLint.enabled · boolean · default: true

Enable dotenv-linter

reviews.tools.htmlhint · object

HTMLHint is a static code analysis tool for HTML files.

Version: v1.9.2

Show options

reviews.tools.htmlhint.enabled · boolean · default: true

Enable HTMLHint

reviews.tools.stylelint · 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

reviews.tools.stylelint.enabled · boolean · default: true

Enable Stylelint

reviews.tools.checkmake · object

checkmake is a linter for Makefiles.

Version: v0.3.2

Show options

reviews.tools.checkmake.enabled · boolean · default: true

Enable checkmake

reviews.tools.osvScanner · object

OSV Scanner is a tool for vulnerability package scanning.

Version: v2.6.0

Show options

reviews.tools.osvScanner.enabled · boolean · default: true

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

reviews.tools.oasdiff · object

oasdiff detects breaking changes between OpenAPI specifications.

Version: v1.32.1

Show options

reviews.tools.oasdiff.enabled · boolean · default: true

Enable oasdiff

reviews.tools.reactDoctor · object

React Doctor scans React codebases for security, performance, correctness, and accessibility issues.

Version: v0.9.14

Show options

reviews.tools.reactDoctor.enabled · boolean · default: true

Enable React Doctor

reviews.tools.presidio · 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 options

reviews.tools.presidio.enabled · boolean · default: true

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

reviews.tools.blinter · 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.31

Show options

reviews.tools.blinter.enabled · boolean · default: true

Enable Blinter

reviews.tools.smartyLint · 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

reviews.tools.smartyLint.enabled · boolean · default: true

Enable smarty-lint

reviews.tools.emberTemplateLint · 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 options

reviews.tools.emberTemplateLint.enabled · boolean · default: true

Enable ember-template-lint

reviews.tools.skillspector · object

SkillSpector is a security scanner for AI agent skills that detects vulnerabilities, malicious patterns, and security risks

Version: v2.12.0

Show options

reviews.tools.skillspector.enabled · 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.

reviews.tools.psscriptanalyzer · object

PSScriptAnalyzer is a static code checker for PowerShell scripts and modules.

Version: v1.25.0

Show options

reviews.tools.psscriptanalyzer.enabled · boolean · default: true

Enable PSScriptAnalyzer

Chat

chat.art · boolean · default: true

Generate art in chat responses (ASCII or emoji).

chat.allow_non_org_members · 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.

chat.auto_reply · boolean · default: true

Let CodeRabbit reply automatically without requiring a mention/tag.

Integrations

chat.integrations

chat.integrations.jira · object

Learn more: Jira Integration

Show options

chat.integrations.jira.usage · enum · default: "auto"

Jira: Allow creating Jira issues from chat. ‘auto’ disables the integration for public repositories.

One of the following: auto, enabled, disabled

chat.integrations.jira.issue_template · 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

chat.integrations.linear · object

Learn more: Linear Integration

Show options

chat.integrations.linear.usage · 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

knowledge_base.opt_out · 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

knowledge_base.automatic_linking_mode · 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, disabled

Learn more: Multi-Repo Analysis

knowledge_base.automatic_repository_linking · boolean · default: false

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

Learn more: Multi-Repo Analysis

knowledge_base.linked_repositories · 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

knowledge_base.linked_repositories[].repository · 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)

knowledge_base.linked_repositories[].instructions · 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

knowledge_base.web_search.enabled · 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

knowledge_base.code_guidelines.enabled · boolean · default: true

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

knowledge_base.code_guidelines.filePatterns · 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. Supplements the default patterns; does not replace them. File names are case-sensitive.

Learnings

knowledge_base.learnings

Learn more: Learnings

knowledge_base.learnings.scope · 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.

knowledge_base.learnings.approval_delay · 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

knowledge_base.issues.scope · 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

knowledge_base.jira.usage · enum · default: "auto"

Jira: Use Jira as a knowledge source. ‘auto’ disables the integration for public repositories.

One of the following: auto, enabled, disabled

knowledge_base.jira.project_keys · array of string · default: []

Jira Project Keys: Restrict Jira context to these projects.

Learn more: Jira Integration

knowledge_base.jira.excluded_project_keys · 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

knowledge_base.linear.usage · enum · default: "auto"

Linear: Use Linear as a knowledge source. ‘auto’ disables the integration for public repositories.

One of the following: auto, enabled, disabled

knowledge_base.linear.team_keys · 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

knowledge_base.pull_requests.scope · 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

knowledge_base.mcp.usage · 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.

knowledge_base.mcp.disabled_servers · 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.

Learn more: Generate docstrings

code_generation.docstrings.language · enum · default: "en-US"

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

code_generation.docstrings.path_instructions · array of object · default: []

Path Instructions: Add path-specific guidelines for docstring generation.

Learn more: Generate docstrings

Show options

code_generation.docstrings.path_instructions[].path · string

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

code_generation.docstrings.path_instructions[].instructions · string

Additional docstring-generation guidelines for matching paths.

Max length: 20000

Unit Test Generation

code_generation.unit_tests

Settings for generating unit tests.

Learn more: Generate unit tests

code_generation.unit_tests.path_instructions · array of object · default: []

Path Instructions: Add path-specific guidelines for unit test generation.

Learn more: Generate unit tests

Show options

code_generation.unit_tests.path_instructions[].path · string

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

code_generation.unit_tests.path_instructions[].instructions · 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

issue_enrichment.auto_enrich.enabled · 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

issue_enrichment.planning.enabled · boolean · default: true

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

issue_enrichment.planning.auto_planning · object

Show options

issue_enrichment.planning.auto_planning.enabled · boolean · default: true

Automatic Planning: Trigger issue planning based on labels.

issue_enrichment.planning.auto_planning.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

issue_enrichment.labeling.labeling_instructions · array of object · default: []

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

Show options

issue_enrichment.labeling.labeling_instructions[].label · string

Label to suggest for the issue. Example: enhancement

issue_enrichment.labeling.labeling_instructions[].instructions · string

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

Max length: 3000

issue_enrichment.labeling.auto_apply_labels · boolean · default: false

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

Related resources

Review commands

Learn about @coderabbitai commands

Tools reference

Browse all supported linters and analyzers