> ## Documentation Index
> Fetch the complete documentation index at: https://docs.coderabbit.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Configuration V3 reference

> Reference for the V3 repository configuration schema in preview.

GitHub Cloud (Repository V3 configuration is supported only for eligible GitHub Cloud organizations.) | Cloud Only (This feature is available on CodeRabbit Cloud only. It is not available on self-hosted CodeRabbit deployments.) Preview (V3 file configuration requires an eligible organization. Adding version: 3 does not enroll an organization.)

This reference describes the V3 repository file schema. Use it only after CodeRabbit confirms that your organization is eligible for the preview. Existing V2 configurations continue to use the [V2 configuration reference](https://docs.coderabbit.ai/reference/configuration.md).

An eligible repository selects V3 with the numeric field `version: 3` in its root `.coderabbit.yaml` or `.coderabbit.yml`. See [Migrating to V3](https://docs.coderabbit.ai/guides/migrate-configuration-v3.md) for availability, setting changes, inheritance, and directory requirements. The reference does not describe the separate preferences managed in the web UI.

[Download the V3 JSON Schema](https://docs.coderabbit.ai/schema/schema.v3.json).

> [!NOTE]
>
> This reference is automatically generated from the CodeRabbit V3 configuration schema. **Last updated: November 12, 2026**

## General settings

**version** `enum` *required*

Select the V3 schema with the number 3. A schema URL comment does not select a configuration version.

One of the following: `3`

Learn more: [Migrate configuration to V3](https://docs.coderabbit.ai/guides/migrate-configuration-v3.md)

```yaml .coderabbit.yaml theme={null}
version: 3
```

**language** `enum` (default: en-US)

Set the language used for human-readable review feedback with a supported 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`

**inheritance** `boolean` (default: false)

Allow applicable parent settings to fill values omitted here. Explicit scalar values take precedence; lists follow the inheritance merge rules. Organization and workspace overrides can force inheritance.

Learn more: [Migrate configuration to V3](https://docs.coderabbit.ai/guides/migrate-configuration-v3.md)

## Reviews

### Behavior

`reviews.behavior`

**reviews.behavior.profile** `enum` (default: chill)

Choose the amount of review feedback. Quiet prioritizes the most important feedback, chill provides balanced feedback, and assertive includes more suggestions that can feel nitpicky.

One of the following: `quiet`, `chill`, `assertive`

**reviews.behavior.path\_filters** `array of string`

Include or exclude files from review using repository-relative glob patterns. Prefix an exclusion with `!`, and quote patterns starting with `!` in YAML.

**reviews.behavior.auto\_approvals** `object`

**options**

**reviews.behavior.auto\_approvals.enabled** `boolean` (default: false)

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

**reviews.behavior.auto\_approvals.max\_merge\_risk** `enum`

**Maximum merge risk for approval**: Highest inclusive merge risk that permits approval. Omitted limits can be inherited; merge risk is unrestricted only when no configuration source sets a limit. A configured limit requires an assessment covering the current commit.

One of the following: `minimal`, `low`, `moderate`, `high`, `critical`

**reviews.behavior.auto\_approvals.allow\_author\_approval** `boolean` (default: true)

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

**reviews.behavior.auto\_approvals.max\_security\_risk** `enum`

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

One of the following: `minimal`, `low`, `moderate`, `high`, `critical`

**reviews.behavior.auto\_approvals.overrides** `array of object`

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

**options**

**reviews.behavior.auto\_approvals.overrides\[].enabled** `enum`

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

One of the following: `false`

**reviews.behavior.auto\_approvals.overrides\[].teams** `array of string`

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

**reviews.behavior.auto\_approvals.overrides\[].paths** `array of string`

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

**reviews.behavior.auto\_approvals.overrides\[].max\_merge\_risk** `enum`

**Maximum merge risk for approval**: Override the global merge-risk limit for matching pull requests. Omit to inherit the global limit.

One of the following: `minimal`, `low`, `moderate`, `high`, `critical`

**reviews.behavior.auto\_approvals.overrides\[].max\_security\_risk** `enum`

**Maximum security risk for approval**: Override the global security-risk limit for matching pull requests. Omit to inherit the global limit. Security risk assessments require the Advanced plan or above.

One of the following: `minimal`, `low`, `moderate`, `high`, `critical`

**reviews.behavior.auto\_approvals.override\_requested\_reviewers\_only** `boolean` (default: false)

**reviews.behavior.merge\_risk\_instructions** `string`

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

> [!NOTE]
>
> Max length: 3000

**reviews.behavior.security\_risk\_instructions** `string`

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

> [!NOTE]
>
> Max length: 3000

**reviews.behavior.status** `object`

Defaults to `{"progress_updates":true,"legacy_commit_status":true,"fail_on_error":false}`.

**options**

**reviews.behavior.status.progress\_updates** `boolean` (default: true)

**reviews.behavior.status.legacy\_commit\_status** `boolean` (default: true)

**reviews.behavior.status.fail\_on\_error** `boolean` (default: false)

### Auto review

`reviews.auto_review`

**reviews.auto\_review\.enabled** `boolean` (default: true)

**Automatic Review**: Review PRs automatically.

**reviews.auto\_review\.description\_keyword** `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.

**reviews.auto\_review\.incremental\_review** `boolean` (default: true)

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

**reviews.auto\_review\.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.

> [!NOTE]
>
> Min: 0, Max: 9007199254740991

**reviews.auto\_review\.labels** `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.

**reviews.auto\_review\.drafts** `boolean` (default: false)

Include draft PRs.

**reviews.auto\_review\.base\_branches** `array of string`

Base branches (other than the default branch) to review. Accepts regex patterns. Use '.\*' to match all branches.

### Output

`reviews.output`

**reviews.output.summary** `object`

Defaults to `{"placement":"description","placeholder":"@coderabbitai summary","instructions":""}`.

**options**

**reviews.output.summary.placement** `enum` (default: description)

One of the following: `off`, `description`, `walkthrough`

**reviews.output.summary.placeholder** `string` (default: @coderabbitai summary)

**reviews.output.summary.instructions** `string`

**reviews.output.walkthrough** `object`

Defaults to `{"collapse":true,"review_status":true,"review_info":true,"review_details":false,"changed_files_summary":true,"related_issues":true,"related_prs":true}`.

**options**

**reviews.output.walkthrough.collapse** `boolean` (default: true)

**reviews.output.walkthrough.review\_status** `boolean` (default: true)

**reviews.output.walkthrough.review\_info** `boolean` (default: true)

**reviews.output.walkthrough.review\_details** `boolean` (default: false)

**reviews.output.walkthrough.changed\_files\_summary** `boolean` (default: true)

**reviews.output.walkthrough.related\_issues** `boolean` (default: true)

**reviews.output.walkthrough.related\_prs** `boolean` (default: true)

**reviews.output.chat** `object`

**options**

**reviews.output.chat.allow\_non\_org\_members** `boolean` (default: true)

**reviews.output.metadata** `object`

Defaults to `{"labels":{"mode":"suggest","instructions":[],"mutually_exclusive_groups":{}},"reviewers":{"mode":"suggest","instructions":[]}}`.

**options**

**reviews.output.metadata.labels** `object`

Defaults to `{"mode":"suggest","instructions":[],"mutually_exclusive_groups":{}}`.

**options**

**reviews.output.metadata.labels.mode** `enum` (default: suggest)

One of the following: `off`, `suggest`, `apply`

**reviews.output.metadata.labels.instructions** `array of object`

**options**

**reviews.output.metadata.labels.instructions\[].label** `string` *required*

> [!NOTE]
>
> Min length: 1

**reviews.output.metadata.labels.instructions\[].instructions** `string` *required*

Instructions describing when the label applies.

> [!NOTE]
>
> Max length: 3000

**reviews.output.metadata.labels.mutually\_exclusive\_groups** `object`

**reviews.output.metadata.reviewers** `object`

Defaults to `{"mode":"suggest","instructions":[]}`.

**options**

**reviews.output.metadata.reviewers.mode** `enum` (default: suggest)

One of the following: `off`, `suggest`, `apply`

**reviews.output.metadata.reviewers.instructions** `array of object`

**options**

**reviews.output.metadata.reviewers.instructions\[].reviewers** `array of object` *required*

**options**

**reviews.output.metadata.reviewers.instructions\[].reviewers\[].handle** `string` *required*

> [!NOTE]
>
> Min length: 1

**reviews.output.metadata.reviewers.instructions\[].reviewers\[].type** `enum` (default: user)

One of the following: `user`, `group`

**reviews.output.metadata.reviewers.instructions\[].instructions** `string` *required*

> [!NOTE]
>
> Min length: 1, Max length: 3000

### Tools

`reviews.tools`

Tools that provide additional context to code reviews.

**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.51.1`

**options**

**reviews.tools.ast-grep.enabled** `boolean` (default: true)

**Enable ast-grep**

**reviews.tools.ast-grep.rule\_dirs** `array of string`

List of rules directories.

**reviews.tools.ast-grep.util\_dirs** `array of string`

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`

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`

**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.17.3`

**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.24.0`

**options**

**reviews.tools.markdownlint.enabled** `boolean` (default: true)

**Enable markdownlint**

**reviews.tools.github-checks** `object`

GitHub Checks integration configuration.

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

**options**

**reviews.tools.languagetool.enabled** `boolean` (default: true)

**Enable LanguageTool**: Enable LanguageTool integration.

**reviews.tools.languagetool.enabled\_rules** `array of string`

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

**reviews.tools.languagetool.disabled\_rules** `array of string`

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`

IDs of categories to be enabled.

**reviews.tools.languagetool.disabled\_categories** `array of string`

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

**reviews.tools.languagetool.enabled\_only** `boolean` (default: false)

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

**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.6.3`

**options**

**reviews.tools.biome.enabled** `boolean` (default: true)

**Enable Biome**

**reviews.tools.hadolint** `object`

Hadolint is a Dockerfile linter.

Version: `v2.15.1`

**options**

**reviews.tools.hadolint.enabled** `boolean` (default: true)

**Enable Hadolint**

**reviews.tools.swiftlint** `object`

SwiftLint integration configuration object.

Version: `v0.65.1`

**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.3.3`

**options**

**reviews.tools.phpstan.enabled** `boolean` (default: true)

**Enable PHPStan**: PHPStan requires [config file](https://phpstan.org/config-reference#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](https://phpstan.org/user-guide/rule-levels) 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: `v3.0.0`

**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`

**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.15.0`

**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`

**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`

**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.99.8`

**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.30`

**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.66.0`

**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`

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

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

**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`

**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`

**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.10.0`

**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.92.1`

**options**

**reviews.tools.rubocop.enabled** `boolean` (default: true)

**Enable RuboCop**

**reviews.tools.buf** `object`

Buf offers linting for Protobuf files.

Version: `v1.74.0`

**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`

**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`

**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.31.1`

**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`

**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: `v23.1.4`

**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`

**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.24.0`

**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`

**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.33.0`

**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.183.0`

**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.9.0`

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

**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.4.0`

**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.70.0`

**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.76.2`

**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`

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

**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.89.0`

**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 5.0.0, theme 3.58.2`

**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`

**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.1.0`

**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`

**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`

**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`

**options**

**reviews.tools.stylelint.enabled** `boolean` (default: true)

**Enable Stylelint**

**reviews.tools.checkmake** `object`

checkmake is a linter for Makefiles.

Version: `v0.3.2`

**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.7.0`

**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.34.0`

**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.18`

**options**

**reviews.tools.reactDoctor.enabled** `boolean` (default: true)

**Enable React Doctor**

**reviews.tools.presidio** `object`

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

Version: `v2.2.366`

**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.49`

**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`

**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.4`

**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`

**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`

**options**

**reviews.tools.psscriptanalyzer.enabled** `boolean` (default: true)

**Enable PSScriptAnalyzer**

## Fun

**fun.tone\_instructions** `string`

> [!NOTE]
>
> Max length: 250

**fun.in\_progress\_fortune** `boolean` (default: false)

**fun.art** `boolean` (default: false)

## Related resources

> [card] [Review commands](https://docs.coderabbit.ai/reference/review-commands.md)
>
> Learn about @coderabbitai commands

> [card] [Migrating to V3](https://docs.coderabbit.ai/guides/migrate-configuration-v3.md)
>
> Check eligibility and prepare your configuration


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.