Complete reference for all CodeRabbit configuration options.
.coderabbit.yaml
file.Location | General > Data Retention |
Default | true |
true
, then CodeRabbit is allowed to retain enough data about your code
review history in order to enable the following features:
Location | General > Early Access |
Default | false |
Location | General > Enable Free Tier |
Default | true |
Location | General > Language |
Default | en-US |
Location | General > Tone Instructions |
Default |
Use an encouraging, supportive tone that celebrates good practices while gently suggesting improvements.
Adopt a concise, matter-of-fact style that gets straight to the point without unnecessary pleasantries.
Deliver all review comments in the style of a televised nature documentary, perhaps with David Attenborough hosting.
Location | Review > Settings > Abort On Close |
Default | true |
Location | Review > Settings > Assess Linked Issues |
Default | true |
Location | Review > Settings > Auto Apply Labels |
Default | false |
Location | Review > Settings > Auto Assign Reviewers |
Default | false |
Location | Review > Settings > Auto Title Instructions |
Default |
Location | Review > Settings > Auto Title Placeholder |
Default | @coderabbitai |
Location | Review > Settings > Changed Files Summary |
Default | true |
Location | Review > Settings > Collapse Walkthrough |
Default | false |
Location | Review > Settings > Commit Status |
Default | true |
Location | Review > Settings > Disable Cache |
Default | false |
Location | Review > Settings > Fail Commit Status |
Default | false |
Location | Review > Settings > High Level Summary |
Default | true |
Location | Review > Settings > High Level Summary In Walkthrough |
Default | false |
Location | Review > Settings > High Level Summary Placeholder |
Default | @coderabbitai summary |
Location | Review > Settings > Labeling Instructions |
Default | Empty array |
Location | Review > Settings > Path Filters |
Default | Empty array |
!
character, or include
paths. If the list of paths contains at least one include path, then CodeRabbit
includes only files that match the provided paths.
For example, the following list of path filters instructs CodeRabbit to limit its reviews
only to files found in the src
top-level directory, but exclude any .bin
or .csv
files:
git sparse-checkout
when preparing its own copy of your repository for code review
context.Location | Review > Settings > Path Instructions |
Default | Empty array |
src
directory:
awesome-coderabbit
public repository.
Location | Review > Settings > Poem |
Default | true |
Location | Review > Settings > Profile |
Default | chill |
Chill
: CodeRabbit provides its usual level of commentary.Assertive
: CodeRabbit provides significantly deeper or more verbose commentary,
as much as possible.Chill
profile is the default setting, and is appropriate for most coding
contexts. The Assertive
profile mode can get quite nitpicky in some circumstances. We recommend leaving this setting in Chill
, unless a wordier level of code critique would benefit your team’s work.
Location | Review > Settings > Related Issues |
Default | true |
Location | Review > Settings > Related PRs |
Default | true |
Location | Review > Settings > Request Changes Workflow |
Default | false |
Location | Review > Settings > Review Status |
Default | true |
Location | Review > Settings > Sequence Diagrams |
Default | true |
Location | Review > Settings > Suggested Labels |
Default | true |
Location | Review > Settings > Suggested Reviewers |
Default | true |
Location | Review > Auto Review > Automatic Review |
Default | true |
Location | Review > Auto Review > Automatic Incremental Review |
Default | true |
Location | Review > Auto Review > Base Branches |
Default | Empty array |
main
or master
.)
For example, if you add staging
as a base branch, then CodeRabbit automatically
reviews pull requests on both your repository’s default branch and its staging
branch.
Location | Review > Auto Review > Drafts |
Default | false |
Location | Review > Auto Review > Ignore Title Keywords |
Default | Empty array |
Location | Review > Auto Review > Labels |
Default | Empty array |
Location | Review > Finishing Touches > Docstrings |
Default | true |
Location | Review > Finishing Touches > Unit Tests |
Default | true |
Location | Chat > Auto Reply |
Default | true |
Location | Chat > Jira |
Default | auto |
Location | Chat > Linear |
Default | auto |
Location | Knowledge Base > Opt Out |
Default | false |
Location | Knowledge Base > Pull Requests |
Default | auto |
Location | Knowledge Base > Web Search |
Default | true |
Location | Knowledge Base > Issues |
Default | auto |
Location | Knowledge Base > Jira |
Default | auto |
Location | Knowledge Base > Project Keys |
Default | Empty array |
Location | Knowledge Base > Learnings |
Default | auto |
Location | Knowledge Base > Linear |
Default | auto |
Location | Knowledge Base > Team Keys |
Default | Empty array |
Location | Code Generation > Language |
Default | en-US |
Location | Code Generation > Path Instructions |
Default | Empty array |
Location | Code Generation > Unit Test Generation |
Default | Empty array |
Location | Review > Tools > Enable actionlint |
Default | true |
Location | Review > Tools > ast-grep > Essential Rules |
Default | true |
Location | Review > Tools > ast-grep > Packages |
Default | Empty array |
Location | Review > Tools > ast-grep > Rule Dirs |
Default | Empty array |
Location | Review > Tools > ast-grep > Util Dirs |
Default | Empty array |
Location | Review > Tools > Enable Biome |
Default | true |
Location | Review > Tools > Enable Brakeman |
Default | true |
Location | Review > Tools > Enable Buf |
Default | true |
Location | Review > Tools > Enable checkmake |
Default | true |
Location | Review > Tools > Enable Checkov |
Default | true |
Location | Review > Tools > Enable CircleCI |
Default | true |
Location | Review > Tools > Enable Clippy |
Default | true |
Location | Review > Tools > Enable Cppcheck |
Default | true |
Location | Review > Tools > detekt > Enable |
Default | true |
Location | Review > Tools > detekt > Config File |
Default | No default |
Location | Review > Tools > Enable dotenv-linter |
Default | true |
Location | Review > Tools > Enable ESLint |
Default | true |
Location | Review > Tools > Flake8 > Enable |
Default | true |
Location | Review > Tools > GitHub Checks > Enable |
Default | true |
Location | Review > Tools > GitHub Checks > Timeout Ms |
Default | 90000 |
Location | Review > Tools > Enable Gitleaks |
Default | true |
Location | Review > Tools > golangci-lint > Enable |
Default | true |
Location | Review > Tools > golangci-lint > Config File |
Default | No default |
Location | Review > Tools > Enable Hadolint |
Default | true |
Location | Review > Tools > HTMLHint > Enable |
Default | true |
Location | Review > Tools > HTMLHint > Config File |
Default | No default |
Location | Review > Tools > LanguageTool > Disabled Categories |
Default | Empty array |
Location | Review > Tools > LanguageTool > Disabled Rules |
Default | Empty array |
Location | Review > Tools > LanguageTool > Enable |
Default | true |
Location | Review > Tools > LanguageTool > Enabled Categories |
Default | Empty array |
Location | Review > Tools > LanguageTool > Enabled Only |
Default | false |
Location | Review > Tools > LanguageTool > Enabled Rules |
Default | Empty array |
Location | Review > Tools > LanguageTool > Level |
Default | default |
Location | Review > Tools > Enable Luacheck |
Default | true |
Location | Review > Tools > Enable markdownlint |
Default | true |
Location | Review > Tools > Enable Oxlint |
Default | true |
Location | Review > Tools > PHPStan > Enable |
Default | true |
paths:
parameter.
Location | Review > Tools > PHPStan > Level |
Default | default |
level:
parameter.
Location | Review > Tools > PMD > Enable |
Default | true |
Location | Review > Tools > PMD > Config File |
Default | No default |
Location | Review > Tools > Enable PHPMD |
Default | true |
Location | Review > Tools > Enable PHPCS |
Default | true |
Location | Review > Tools > Enable Prisma Schema Linting |
Default | true |
Location | Review > Tools > Enable Pylint |
Default | true |
Location | Review > Tools > Enable Regal |
Default | true |
Location | Review > Tools > Enable RuboCop |
Default | true |
Location | Review > Tools > Enable Ruff |
Default | true |
Location | Review > Tools > Semgrep > Enable |
Default | true |
Location | Review > Tools > Semgrep > Config File |
Default | No default |
Location | Review > Tools > Enable ShellCheck |
Default | true |
Location | Review > Tools > Enable Shopify Theme Check |
Default | true |
Location | Review > Tools > Enable SQLFluff |
Default | true |
Location | Review > Tools > SwiftLint > Enable |
Default | true |
Location | Review > Tools > SwiftLint > Config File |
Default | No default |
Location | Review > Tools > Enable YAMLlint |
Default | true |