Hi! 👋 We are doing a big documentation refresh. Help us improve - what's missing or could be better? Let us know! Join the Discord channel or simply send an email!
Complete reference for CodeRabbit configuration options with detailed explanations, types, and examples.
This reference is automatically generated from the CodeRabbit configuration schema.
Last updated: 2026-03-17
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 review profile: chill for lighter feedback, assertive for more feedback (which may feel nitpicky).One of the following: chill, assertiveDefaults to "chill".
Automatically approve once CodeRabbit’s comments are resolved and no pre-merge checks are failing. Note: In GitLab, all discussions must be resolved.Defaults to false.
By default, CodeRabbit generates release notes in the description. Use this to customize the summary content and format. Example: ‘Create concise release notes as a bullet-point list, followed by a Markdown table showing lines added and removed by each contributing author.’ Note: Use high_level_summary_in_walkthrough to place the summary in the walkthrough instead of the description.Defaults to "".
Placeholder in the PR description that CodeRabbit replaces with the high-level summary. If high_level_summary is false, the summary is still generated when this placeholder is present.Defaults to "@coderabbitai summary".
Labeling Instructions | Define allowed labels and when to suggest them. When provided, CodeRabbit suggests only from this list (still informed by prior PRs); when empty, suggestions rely entirely on prior PRs.Defaults to [].
Prompt for AI Agents | Include the ’🤖 Prompt for AI Agents’ section in inline review comments to provide codegen instructions for AI agents.Defaults to true.
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 [].
Keyword in the PR description that triggers a review when automatic reviews are disabled. If enabled is false and this field is not empty, CodeRabbit reviews the PR only when this keyword is present in the description.Defaults to "".
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.Defaults to [].
Docstrings | Enable the docstrings finishing touch (trigger via the 📝 Generate docstrings checkbox or @coderabbitai generate docstrings). CodeRabbit generates or improves docstrings for functions changed in the PR and opens a follow-up PR containing the docstring edits.Defaults to true.
Simplify | Enable the simplify finishing touch (trigger via the ✨ Simplify code checkbox). CodeRabbit reviews changed code for reuse, quality, and efficiency, then applies targeted improvements.Defaults to false.
Instructions | Describe what this recipe should do. Trigger with @coderabbitai run <recipe name> or the checkbox under ”✨ Finishing Touches”. CodeRabbit provides PR context and runs this with an agent.Defaults to "".
Override Requested Reviewers Only | When enabled, only requested reviewers (and not the pull request author) can override/ignore failing pre-merge checks.Defaults to false.
Mode | Enforcement level: off disables the check, warning posts a warning, and error requires resolution before merging. If the request-changes workflow is enabled, error can block the PR until the check passes.One of the following: off, warning, errorDefaults to "warning".
Mode | Enforcement level: off disables the check, warning posts a warning, and error requires resolution before merging. If the request-changes workflow is enabled, error can block the PR until the check passes.One of the following: off, warning, errorDefaults to "warning".
Mode | Enforcement level: off disables the check, warning posts a warning, and error requires resolution before merging. If the request-changes workflow is enabled, error can block the PR until the check passes.One of the following: off, warning, errorDefaults to "warning".
Mode | Enforcement level: off disables the check, warning posts a warning, and error requires resolution before merging. If the request-changes workflow is enabled, error can block the PR until the check passes.One of the following: off, warning, errorDefaults to "warning".
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).Defaults to [].
Mode | Enforcement level: off disables the check, warning posts a warning, and error requires resolution before merging. If the request-changes workflow is enabled, error can block the PR until the check passes.One of the following: off, warning, errorDefaults to "warning".
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.41.1Defaults to {}.
Enable markdownlint | markdownlint-cli2 is a static analysis tool to enforce standards and consistency for Markdown files. | Enable markdownlint integration. | v0.21.0Defaults 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.40Defaults 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 OpenGrep | OpenGrep is a high-performance static code analysis engine for finding security vulnerabilities and bugs across 17+ languages. | v1.16.4Defaults to true.
Enable Semgrep | Semgrep is a static analysis tool designed to scan code for security vulnerabilities and code quality issues. | Enable Semgrep integration. | v1.155.0Defaults to true.
Enable Shopify Theme Check | A linter for Shopify themes that helps you follow Shopify theme & Liquid best practices | cli 3.90.0 | theme 3.58.2Defaults to true.
Enable Stylelint | Stylelint is a linter for stylesheets (CSS, SCSS, Sass, Less, SugarSS, Stylus) that helps avoid errors and enforce conventions. | Enable Stylelint integration. | v17.4.0Defaults to true.
Blinter is a linter for Windows batch files that provides comprehensive static analysis to identify syntax errors, security vulnerabilities, performance issues, and style problems.Defaults to {}.
Enable Blinter | Blinter is a linter for Windows batch files that provides comprehensive static analysis to identify syntax errors, security vulnerabilities, performance issues, and style problems. | v1.0.112Defaults to true.
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.Defaults to {}.
Enable smarty-lint | 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. | v0.3.3Defaults to true.
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.Defaults to {}.
Enable ember-template-lint | 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. | v7.9.3Defaults to 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.Defaults to true.
Jira | Allow creating Jira issues from chat. ‘auto’ disables the integration for public repositories.One of the following: auto, enabled, disabledDefaults to "auto".
Linear | Allow creating Linear issues from chat. ‘auto’ disables the integration for public repositories.One of the following: auto, enabled, disabledDefaults to "auto".
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).Defaults to [].
Learnings | Choose scope: ‘local’ (repo), ‘global’ (org), or ‘auto’ (local for public repos, global for private repos).One of the following: local, global, autoDefaults to "auto".
Issues | Choose scope for GitHub/GitLab issues: ‘local’ (repo), ‘global’ (org), or ‘auto’ (local for public repos, global for private repos).One of the following: local, global, autoDefaults to "auto".
Jira | Use Jira as a knowledge source. ‘auto’ disables the integration for public repositories.One of the following: auto, enabled, disabledDefaults to "auto".
Linear | Use Linear as a knowledge source. ‘auto’ disables the integration for public repositories.One of the following: auto, enabled, disabledDefaults to "auto".
PRs | Choose scope: ‘local’ (repo), ‘global’ (org), or ‘auto’ (local for public repos, global for private repos).One of the following: local, global, autoDefaults to "auto".
MCP | Use MCP servers as a knowledge source. ‘auto’ disables the integration for public repositories.One of the following: auto, enabled, disabledDefaults to "auto".
Disabled MCP Servers | Specify MCP server labels to disable (case-insensitive). These servers will be excluded from reviews and knowledge base queries.Defaults to [].
Linked Repositories | Repositories that CodeRabbit should consider when reviewing PRs in this repo. Use this to surface cross-repo dependencies and catch breaking changes across related codebases.Defaults to [].
Repository name in owner/repo format (e.g., GitHub: myorg/backend-api, Azure DevOps: MyProject/backend-api, GitLab: group/subgroup/repo, Bitbucket: workspace/repo)
Optionally provide description and guidance on what this repository contains for CodeRabbit to consider during reviews. Example: ‘Contains REST API endpoints and database models.’Defaults to "".
Labels that trigger automatic issue planning. Labels starting with ’!’ are negative matches. Examples: [‘feature’, ‘enhancement’] plans issues with either label. [‘!wip’] plans all issues except those labeled ‘wip’. [‘feature’, ‘!wip’] plans issues labeled ‘feature’ but not ‘wip’.Defaults to [].
Automatically apply suggested labels to the issue. When enabled without labeling instructions, labels are auto-suggested based on similar issues.Defaults to false.
