This reference is automatically generated from the CodeRabbit configuration schema.
Last updated: June 24, 2026
.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
Reference
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, 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, bnDefaults to "en-US".Set the tone of reviews and chat. Example: ‘You must talk like Mr. T. I pity the fool who doesn’t!’Defaults to
"".Max length: 250
Enable early-access features.Defaults to
false.Enable free tier features for users not on a paid plan.Defaults to
true.Reviews
Settings related to reviews.Reference
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.Generate a high-level summary of the changes in the PR description or walkthrough.Defaults to
true.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".Include the high-level summary in the walkthrough comment.Defaults to
false.Add this keyword to the PR title to auto-generate a title.Defaults to
"@coderabbitai".Auto Title Instructions | Customize how CodeRabbit generates the PR title.Defaults to
"".Post review status messages (e.g., when a review is skipped) in the walkthrough summary comment.Defaults to
true.Post review details (ignored files, extra context used, suppressed comments, etc.).Defaults to
false.Set the commit status to ‘pending’ when the review is in progress and ‘success’ when it is complete.Defaults to
true.Set the commit status to ‘failure’ when the PR cannot be reviewed by CodeRabbit for any reason.Defaults to
false.Wrap the walkthrough in a Markdown collapsible section.Defaults to
true.Include a summary of the changed files in the walkthrough.Defaults to
true.Include sequence diagrams in the walkthrough.Defaults to
true.Include an estimated code review effort in the walkthrough.Defaults to
true.Include an assessment of how well the changes address linked issues in the walkthrough.Defaults to
true.Include potentially related issues in the walkthrough.Defaults to
true.Related PRs | Include potentially related PRs in the walkthrough.Defaults to
true.Suggest labels based on the changes, and include them in the walkthrough.Defaults to
true.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
[].Mutually Exclusive Groups | Define labels that should not coexist. Example:
{ risk: ['critical', 'high', 'medium', 'low'] }.Defaults to {}.Automatically apply suggested labels to the PR.Defaults to
false.Suggest reviewers based on the changes, and include them in the walkthrough.Defaults to
true.Automatically assign the suggested reviewers to the PR.Defaults to
false.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.Defaults to
[].Post a fortune message while the review is running.Defaults to
true.Generate a poem in the walkthrough comment.Defaults to
true.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 [].Path Instructions | Add path-specific guidance for code review.Defaults to
[].Abort the in-progress review if the PR is closed or merged.Defaults to
true.Disable caching of code and dependencies; fetch them fresh on each run.Defaults to
false.Anti-Slop | Settings for detecting and managing spam or low-quality PRs. Only for public repos, only for GitHub as of now.Defaults to
{}.Configuration for auto reviewDefaults to
{}.Configuration for finishing touchesDefaults to
{}.Configuration for pre merge checksDefaults to
{}.Tools that provide additional context to code reviews.Defaults to
{}.Chat
Configuration for chatReference
Generate art in chat responses (ASCII or emoji).Defaults 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.Let CodeRabbit reply automatically without requiring a mention/tag.Defaults to
true.Configuration for integrationsDefaults to
{}.Knowledge base
Configuration for knowledge baseReference
Opt Out | Disable knowledge base features that require data retention. Opting out removes any existing stored knowledge base data.Defaults to
false.Configuration for web searchDefaults to
{}.Use your coding guideline documents (see File Patterns) as review criteria.Defaults to
{}.Configuration for learningsDefaults to
{}.Configuration for issuesDefaults to
{}.Configuration for jiraDefaults to
{}.Configuration for linearDefaults to
{}.Configuration for pull requestsDefaults to
{}.Configuration for mcpDefaults to
{}.Automatic Repository Linking | When enabled, CodeRabbit automatically detects and links related repositories in your organization to identify breaking changes and downstream impact during PR reviews.Defaults to
false.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
[].Code generation
Configuration for code generationReference
Docstring Generation | Settings for generating docstrings.Defaults to
{"path_instructions":[]}.Unit Test Generation | Settings for generating unit tests.Defaults to
{"path_instructions":[]}.Issue enrichment
Configuration for issue enrichmentReference
Settings for automatic issue enrichment.Defaults to
{}.Settings for issue planning.Defaults to
{}.Settings for issue labeling.Defaults to
{}.Related resources
Review commands
Learn about @coderabbitai commands
Tools reference
Browse all supported linters and analyzers