Complete reference for CodeRabbit configuration options with detailed explanations, types, and examples.
This reference is automatically generated from the CodeRabbit configuration
schema. Last updated: 2025-11-22
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.
Set the profile for reviews. Assertive profile yields more feedback, that may be considered nitpicky.One of the following: chill, assertiveDefaults to "chill".
Approve the review once CodeRabbit’s comments are resolved and no pre-merge checks are in an error state. Note: In GitLab, all discussions must be resolved.Defaults to false.
By default, CodeRabbit generates release notes in the description. This setting lets you customize the summary and format—for 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 if you prefer the high-level summary to appear in the walkthrough instead of the description.Defaults to "".
Labeling Instructions | Provide guidelines for suggesting labels for the PR/MR. When specific labels or instructions are provided, only those labels are considered, though previous examples are still used to inform the suggestions. If no such labels are provided, suggestions are based solely on previous PR/MRs.Defaults to [].
Specify file patterns to include or exclude in a review using glob patterns (e.g., !dist/, src/). These patterns also apply to ‘git sparse-checkout’, including specified patterns and ignoring excluded ones (starting with ’!’) when cloning the repository.Defaults to [].
Disable caching of code and dependencies. This will force CodeRabbit to download the code and dependencies fresh from the repository each time.Defaults to false.
List of labels to control which PRs/MRs to review. Labels starting with ’!’ are negative matches. Examples: [‘bug’, ‘feature’] - reviews PRs with ‘bug’ OR ‘feature’ label. [‘!wip’] - reviews all PRs except those with ‘wip’ label. [‘bug’, ‘!wip’] - reviews PRs with ‘bug’ label but not if they have ‘wip’ label.Defaults to [].
Mode | Determines how strictly the docstring coverage check is enforced. Warning will only generate a warning and does not require the user to resolve the check. Error requires the user to resolve issues before merging the pull request. If set to error and the request changes workflow is enabled, the pull request will be blocked until the issues are resolved.One of the following: off, warning, errorDefaults to "warning".
Mode | Determines how strictly the title check is enforced. Warning will only generate a warning and does not require the user to resolve the check. Error requires the user to resolve issues before merging the pull request. If set to error and the request changes workflow is enabled, the pull request will be blocked until the issues are resolved.One of the following: off, warning, errorDefaults to "warning".
Requirements | Requirements for the pull request title. Example: ‘Title should be concise and descriptive, ideally under 50 characters.’Defaults to "".
Mode | Determines how strictly the description check is enforced. Warning will only generate a warning and does not require the user to resolve the check. Error requires the user to resolve issues before merging the pull request. If set to error and the request changes workflow is enabled, the pull request will be blocked until the issues are resolved.One of the following: off, warning, errorDefaults to "warning".
Linked Issue Assessment | Checks if the pull request addresses the linked issues. Generate an assessment of how well the changes address the linked issues.Defaults to {}.
Mode | Determines how strictly the issue assessment check is enforced. Warning will only generate a warning and does not require the user to resolve the check. Error requires the user to resolve issues before merging the pull request. If set to error and the request changes workflow is enabled, the pull request will be blocked until the issues are resolved.One of the following: off, warning, errorDefaults to "warning".
Custom Pre-merge Checks | Add unique checks to enforce your team’s standards before merging a pull request. Each check must have a unique name (up to 50 characters) and clear instructions (up to 10000 characters). Use these to automatically verify coding, security, documentation, or business rules and maintain code quality.Defaults to [].
Mode | Determines how strictly the custom check is enforced. Warning will only generate a warning and does not require the user to resolve the check. Error requires the user to resolve issues before merging the pull request. If set to error and the request changes workflow is enabled, the pull request will be blocked until the issues are resolved.One of the following: off, warning, errorDefaults to "warning".
Instructions | Please ensure that the instructions specify conditions that deterministically result in a clear pass or fail outcome. The maximum length for this field is 10,000 characters.Defaults to "".
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.40.0Defaults to {}.
Enable markdownlint | markdownlint-cli2 is a static analysis tool to enforce standards and consistency for Markdown files. | Enable markdownlint integration. | v0.18.1Defaults to true.
If set to ‘picky’, additional rules will be activated, i.e. rules that you might only find useful when checking formal text.One of the following: default, pickyDefaults to "default".
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’.
Enable PHPStan | PHPStan requires config file in your repository root. Please ensure that this file contains the paths: parameter. | v2.1.32Defaults to true.
Level | Specify the rule level to run. This setting is ignored if your configuration file already has a level: parameter.One of the following: default, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, maxDefaults to "default".
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’.
Enable Semgrep | Semgrep is a static analysis tool designed to scan code for security vulnerabilities and code quality issues. | Enable Semgrep integration. | v1.143.0Defaults to true.
Enable Shopify Theme Check | A linter for Shopify themes that helps you follow Shopify theme & Liquid best practices | cli 3.84.2 | theme 3.58.2Defaults to true.
Jira | Enable the Jira integration for opening issues, etc. ‘auto’ disables the integration for public repositories.One of the following: auto, enabled, disabledDefaults to "auto".
Linear | Enable the Linear integration for opening issues, etc. ‘auto’ disables the integration for public repositories.One of the following: auto, enabled, disabledDefaults to "auto".
Opt Out | Disable all knowledge base features that require data retention. If you opt out after opting in, all of your existing knowledge base data will be removed from the system.Defaults to false.
CodeRabbit will analyse and learn from your organization’s code guidelines, which you can mention in the file patterns section. These guidelines will then be used to conduct thorough code reviews.Defaults to {}.
File Patterns | Specify files for your coding guideline documents in this section. CodeRabbit will scan these files to understand your team’s standards and apply them during code reviews. Multiple files supported. File names are case-sensitive. Common files like: (**/.cursorrules, .github/copilot-instructions.md, .github/instructions/.instructions.md, **/CLAUDE.md, **/GEMINI.md, **/.cursor/rules/, **/.windsurfrules, **/.clinerules/, **/.rules/, **/AGENT.md, **/AGENTS.md) are included by default.Defaults to [].
Learnings | Specify the scope of learnings to use for the knowledge base. ‘local’ uses the repository’s learnings, ‘global’ uses the organization’s learnings, and ‘auto’ uses repository’s learnings for public repositories and organization’s learnings for private repositories.One of the following: local, global, autoDefaults to "auto".
Issues | Specify the scope of git platform (GitHub/GitLab) issues to use for the knowledge base. ‘local’ uses the repository’s issues, ‘global’ uses the organization’s issues, and ‘auto’ uses repository’s issues for public repositories and organization’s issues for private repositories.One of the following: local, global, autoDefaults to "auto".
Jira | Enable the Jira knowledge base integration. ‘auto’ disables the integration for public repositories.One of the following: auto, enabled, disabledDefaults to "auto".
Linear | Enable the Linear knowledge base integration. ‘auto’ disables the integration for public repositories.One of the following: auto, enabled, disabledDefaults to "auto".
Pull Requests | Specify the scope of pull requests to use for the knowledge base. ‘local’ uses the repository’s pull requests, ‘global’ uses the organization’s pull requests, and ‘auto’ uses repository’s pull requests for public repositories and organization’s pull requests for private repositories.One of the following: local, global, autoDefaults to "auto".
MCP | Enable the MCP knowledge base integration. ‘auto’ disables the integration for public repositories.One of the following: auto, enabled, disabledDefaults to "auto".
MCP Disabled Servers | Specify MCP server labels to disable (case-insensitive). These servers will be excluded from reviews and knowledge base queries.Defaults to [].
