CodeRabbit (SchemaStore) JSON Schema

Type	schema
File match	`.coderabbit.yaml`
Schema URL	https://catalog.lintel.tools/schemas/schemastore/coderabbit/latest.json
Source	https://coderabbit.ai/integrations/schema.v2.json

Validate with Lintel

npx @lintel/lintel check

Type: schema

Definitions

schema object

language string

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

Default: "en-US"

Values: "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" "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

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

Default: ""

maxLength=250

early_access boolean

Enable early-access features.

Default: false

enable_free_tier boolean

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

Default: true

inheritance boolean

Inheritance | Use parent settings for any values not defined here. Inheritance only propagates upward if enabled at each level.

Default: false

reviews object

Settings related to reviews.

Default:

{}

36 nested properties

profile string

Set the review profile: chill for lighter feedback, assertive for more feedback (which may feel nitpicky).

Default: "chill"

Values: "chill" "assertive"

request_changes_workflow boolean

Automatically approve once CodeRabbit’s comments are resolved and no pre-merge checks are failing. Note: In GitLab, all discussions must be resolved.

Default: false

high_level_summary boolean

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

Default: true

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

Default: ""

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

Default: "@coderabbitai summary"

high_level_summary_in_walkthrough boolean

Include the high-level summary in the walkthrough comment.

Default: false

auto_title_placeholder string

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

Default: "@coderabbitai"

auto_title_instructions string

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

Default: ""

review_status boolean

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

Default: true

review_details boolean

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

Default: false

commit_status boolean

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

Default: true

fail_commit_status boolean

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

Default: false

collapse_walkthrough boolean

Wrap the walkthrough in a Markdown collapsible section.

Default: true

changed_files_summary boolean

Include a summary of the changed files in the walkthrough.

Default: true

sequence_diagrams boolean

Include sequence diagrams in the walkthrough.

Default: true

estimate_code_review_effort boolean

Include an estimated code review effort in the walkthrough.

Default: true

assess_linked_issues boolean

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

Default: true

related_issues boolean

Include potentially related issues in the walkthrough.

Default: true

related_prs boolean

Related PRs | Include potentially related PRs in the walkthrough.

Default: true

suggested_labels boolean

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

Default: true

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

Default:

[]

auto_apply_labels boolean

Automatically apply suggested labels to the PR.

Default: false

suggested_reviewers boolean

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

Default: true

auto_assign_reviewers boolean

Automatically assign the suggested reviewers to the PR.

Default: false

in_progress_fortune boolean

Post a fortune message while the review is running.

Default: true

poem boolean

Generate a poem in the walkthrough comment.

Default: true

enable_prompt_for_ai_agents boolean

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

Default: true

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

Default:

[]

path_instructions object[]

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

Default:

[]

abort_on_close boolean

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

Default: true

disable_cache boolean

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

Default: false

slop_detection object

Anti-Slop | Settings for detecting and managing spam or low-quality PRs. Only for public repos, only for GitHub as of now.

Default:

{}

2 nested properties

enabled boolean

Enable or disable slop and low-quality PR detection.

Default: true

label string

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

minLength=1

auto_review object

Default:

{}

9 nested properties

enabled boolean

Automatic Review | Review PRs automatically.

Default: true

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.

Default: ""

auto_incremental_review boolean

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

Default: true

auto_pause_after_reviewed_commits integer

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

Default: 5

min=0

ignore_title_keywords string[]

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

Default:

[]

labels 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'. ['bug', '!wip'] reviews PRs labeled 'bug' but not 'wip'. This setting also triggers a review when enabled is false.

Default:

[]

drafts boolean

Include draft PRs.

Default: false

base_branches string[]

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

Default:

[]

ignore_usernames string[]

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

Default:

[]

finishing_touches object

Default:

{}

4 nested properties

docstrings object

Docstrings | Configure docstring generation.

Default:

{}

unit_tests object

Unit Tests | Configure unit test generation.

Default:

{}

simplify object

Simplify | Configure code simplification.

Default:

{}

custom object[]

Custom Recipes | Define up to 5 custom finishing touch recipes. Trigger a recipe with @coderabbitai run <recipe name>.

Default:

[]

maxItems=5

pre_merge_checks object

Default:

{}

6 nested properties

override_requested_reviewers_only boolean

Override Requested Reviewers Only | When enabled, only requested reviewers (and not the pull request author) can override/ignore failing pre-merge checks.

Default: false

docstrings object

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

Default:

{}

title object

Title Check | Validate the PR title against the requirements.

Default:

{}

description object

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

Default:

{}

issue_assessment object

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

Default:

{}

custom_checks object[]

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

Default:

[]

maxItems=5

tools object

Tools that provide additional context to code reviews.

Default:

{}

50 nested properties

ast-grep 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. | v0.42.1

Default:

{}

shellcheck object

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

Default:

{}

ruff object

Ruff is a Python linter and code formatter.

Default:

{}

markdownlint object

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

Default:

{}

github-checks object

GitHub Checks integration configuration.

Default:

{}

languagetool object

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

Default:

{}

biome object

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

Default:

{}

hadolint object

Hadolint is a Dockerfile linter.

Default:

{}

swiftlint object

SwiftLint integration configuration object.

Default:

{}

phpstan object

PHPStan is a tool to analyze PHP code.

Default:

{}

phpmd object

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

Default:

{}

phpcs object

PHP CodeSniffer is a PHP linter and coding standard checker.

Default:

{}

golangci-lint object

golangci-lint is a fast linters runner for Go.

Default:

{}

yamllint object

YAMLlint is a linter for YAML files.

Default:

{}

gitleaks object

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

Default:

{}

trufflehog object

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

Default:

{}

checkov object

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

Default:

{}

tflint object

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

Default:

{}

detekt object

Detekt is a static code analysis tool for Kotlin files.

Default:

{}

eslint object

ESLint is a static code analysis tool for JavaScript files.

Default:

{}

flake8 object

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

Default:

{}

fortitudeLint object

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

Default:

{}

rubocop object

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

Default:

{}

buf object

Buf offers linting for Protobuf files.

Default:

{}

regal object

Regal is a linter and language server for Rego.

Default:

{}

actionlint object

actionlint is a static checker for GitHub Actions workflow files.

Default:

{}

pmd object

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

Default:

{}

clang object

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

Default:

{}

cppcheck object

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

Default:

{}

opengrep object

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

Default:

{}

semgrep object

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

Default:

{}

circleci object

CircleCI tool is a static checker for CircleCI config files.

Default:

{}

clippy object

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

Default:

{}

sqlfluff object

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

Default:

{}

trivy object

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

Default:

{}

prismaLint object

Configuration for Prisma Schema linting to ensure schema file quality

Default:

{}

pylint object

Pylint is a Python static code analysis tool.

Default:

{}

oxc object

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

Default:

{}

shopifyThemeCheck object

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

Default:

{}

luacheck object

Configuration for Lua code linting to ensure code quality

Default:

{}

brakeman object

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

Default:

{}

dotenvLint object

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

Default:

{}

htmlhint object

HTMLHint is a static code analysis tool for HTML files.

Default:

{}

stylelint object

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

Default:

{}

checkmake object

checkmake is a linter for Makefiles.

Default:

{}

osvScanner object

OSV Scanner is a tool for vulnerability package scanning.

Default:

{}

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.

Default:

{}

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.

Default:

{}

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.

Default:

{}

psscriptanalyzer object

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

Default:

{}

chat object

Default:

{}

4 nested properties

art boolean

Generate art in chat responses (ASCII or emoji).

Default: true

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

Default: true

auto_reply boolean

Let CodeRabbit reply automatically without requiring a mention/tag.

Default: true

integrations object

Default:

{}

2 nested properties

jira object

Default:

{}

linear object

Default:

{}

knowledge_base object

Default:

{}

10 nested properties

opt_out boolean

Opt Out | Disable knowledge base features that require data retention. Opting out removes any existing stored knowledge base data.

Default: false

web_search object

Default:

{}

1 nested properties

enabled boolean

Web Search | Use web search to gather additional context.

Default: true

code_guidelines object

Use your coding guideline documents (see File Patterns) as review criteria.

Default:

{}

2 nested properties

enabled boolean

Enabled | Apply your organization's coding standards during reviews.

Default: true

filePatterns string[]

File Patterns | Patterns for your coding guideline documents. CodeRabbit scans these files to learn your standards and apply them during reviews. Multiple files supported; file names are case-sensitive. Defaults include: (**/.cursorrules, .github/copilot-instructions.md, .github/instructions/.instructions.md, **/CLAUDE.md, **/GEMINI.md, **/.cursor/rules/, **/.windsurfrules, **/.clinerules/, **/.rules/, **/AGENT.md, **/AGENTS.md).

Default:

[]

learnings object

Default:

{}

1 nested properties

scope string

Learnings | Choose scope: 'local' (repo), 'global' (org), or 'auto' (local for public repos, global for private repos).

Default: "auto"

Values: "local" "global" "auto"

issues object

Default:

{}

1 nested properties

scope string

Issues | Choose scope for GitHub/GitLab issues: 'local' (repo), 'global' (org), or 'auto' (local for public repos, global for private repos).

Default: "auto"

Values: "local" "global" "auto"

jira object

Default:

{}

2 nested properties

usage string

Jira | Use Jira as a knowledge source. 'auto' disables the integration for public repositories.

Default: "auto"

Values: "auto" "enabled" "disabled"

project_keys string[]

Jira Project Keys | Restrict Jira context to these projects.

Default:

[]

linear object

Default:

{}

2 nested properties

usage string

Linear | Use Linear as a knowledge source. 'auto' disables the integration for public repositories.

Default: "auto"

Values: "auto" "enabled" "disabled"

team_keys string[]

Linear Team Keys | Restrict Linear context to these teams (e.g. 'ENG').

Default:

[]

pull_requests object

Default:

{}

1 nested properties

scope string

PRs | Choose scope: 'local' (repo), 'global' (org), or 'auto' (local for public repos, global for private repos).

Default: "auto"

Values: "local" "global" "auto"

mcp object

Default:

{}

2 nested properties

usage string

MCP | Use MCP servers as a knowledge source. 'auto' disables the integration for public repositories.

Default: "auto"

Values: "auto" "enabled" "disabled"

disabled_servers string[]

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

Default:

[]

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

Default:

[]

maxItems=10

code_generation object

Default:

{}

2 nested properties

docstrings object

Docstring Generation | Settings for generating docstrings.

Default:

{
  "path_instructions": []
}

2 nested properties

language string

Language for generated docstrings (ISO language code).

Default: "en-US"

path_instructions object[]

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

Default:

[]

unit_tests object

Unit Test Generation | Settings for generating unit tests.

Default:

{
  "path_instructions": []
}

1 nested properties

path_instructions object[]

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

Default:

[]

issue_enrichment object

Default:

{}

3 nested properties

auto_enrich object

Settings for automatic issue enrichment.

Default:

{}

1 nested properties

enabled boolean

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

Default: false

planning object

Settings for issue planning.

Default:

{}

2 nested properties

enabled boolean

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

Default: true

auto_planning object

Default:

{}

labeling object

Settings for issue labeling.

Default:

{}

2 nested properties

labeling_instructions object[]

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

Default:

[]

auto_apply_labels boolean

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

Default: false