Configuration reference

This reference guide lists all of the code review configuration options that CodeRabbit makes available.

For an overview of how configuration works with CodeRabbit, see Configure CodeRabbit.

How to use this reference

Each entry in this reference corresponds to a single CodeRabbit configuration setting, including an informational table and a description of what the setting does. The tables have two views, which you can select with a tab:

• The Web UI tab displays the location and default value of the setting in the CodeRabbit web interface, for both organization settings and repository settings.
• The coderabbit.yaml tab displays information about the field's location and datatype in your repository's .coderabbit.yaml file.

Global Settings

Data retention

Web UI

Location	General > Data Retention
Default	true

.coderabbit.yaml

This setting can be defined only in the web UI settings for your organization.

If true, then CodeRabbit is allowed to retain enough data about your code review history in order to enable the following features:

• Caching: allows CodeRabbit to store data about your repository between code reviews, improving the speed of subsequent reviews.
• Knowledge base: allows CodeRabbit to maintain its own database about your repository and your team's code review preferences, which can improve the quality and specificity of code reviews generated by CodeRabbit.

If your organization operates under strict data-retention policies, then you can disable data retention. Doing so immediately deletes any cache or knowledge-base data that CodeRabbit has collected for your organization, and prevents CodeRabbit from retaining further cache or knowledge-base data.

If you re-enable data retention, then CodeRabbit re-enables these features, and resumes collecting cache and knowledge-base data.

Early Access

Web UI

Location	General > Early Access
Default	false

.coderabbit.yaml

Field	early_access
Datatype	boolean
Default	false

If enabled, then CodeRabbit lets you use early-access features in your code reviews.

Enable Free Tier

Web UI

Location	General > Enable Free Tier
Default	true

.coderabbit.yaml

Field	enable_free_tier
Datatype	boolean
Default	true

If enabled, then CodeRabbit allows free tier features for users not on a paid plan.

For more information about payment tiers and features, see Pricing.

Language

Web UI

Location	General > Language
Default	en-US

.coderabbit.yaml

Field	language
Datatype	string
Default	"en-US"

Defines the written language that CodeRabbit presents its review comments in. Defaults to U.S. English.

Tone Instructions

Web UI

Location	General > Tone Instructions
Default

.coderabbit.yaml

Field	tone_instructions
Datatype	string
Default

A natural-language description of the tone of voice that CodeRabbit should apply to its review instructions, if you want a tone different from its default.

A few possible examples:

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

Review

Basic Review Settings

Abort On Close

Web UI

Location	Review > Settings > Abort On Close
Default	true

.coderabbit.yaml

Field	reviews.abort_on_close
Datatype	boolean
Default	true

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

Assess Linked Issues

Web UI

Location	Review > Settings > Assess Linked Issues
Default	true

.coderabbit.yaml

Field	reviews.assess_linked_issues
Datatype	boolean
Default	true

If enabled, then the reviews that CodeRabbit generates include assessments of how well a proposed code change addresses any issues that the pull request refers to. CodeRabbit considers issues referred to by number in the following locations:

• The title of the pull request.
• The description of the pull request.
• (GitHub only) The Development field of the pull request.

Besides this setting, issue assessment requires at least one of the following:

• You use the built-in issue managemet system of GitHub or GitLab.
• You have integrated CodeRabbit with an external issue manager.

For more information, see Integrate issue tracking and Let CodeRabbit read your issue trakcer.

Auto Apply Labels

Web UI

Location	Review > Settings > Auto Apply Labels
Default	false

.coderabbit.yaml

Field	reviews.auto_apply_labels
Datatype	boolean
Default	false

Automatically apply the suggested labels to the PR/MR.

Auto Assign Reviewers

Web UI

Location	Review > Settings > Auto Assign Reviewers
Default	false

.coderabbit.yaml

Field	reviews.auto_assign_reviewers
Datatype	boolean
Default	false

Automatically assign suggested reviewers to the pull request

Auto Title Instructions

Web UI

Location	Review > Settings > Auto Title Instructions
Default

.coderabbit.yaml

Field	reviews.auto_title_instructions
Datatype	string
Default

Custom instructions for auto-generating the PR/MR title.

Auto Title Placeholder

Web UI

Location	Review > Settings > Auto Title Placeholder
Default	@coderabbitai

.coderabbit.yaml

Field	reviews.auto_title_placeholder
Datatype	string
Default	"@coderabbitai"

Add this keyword in the PR/MR title to auto-generate the title.

Changed Files Summary

Web UI

Location	Review > Settings > Changed Files Summary
Default	true

.coderabbit.yaml

Field	reviews.changed_files_summary
Datatype	boolean
Default	true

Generate a summary of the changed files in the walkthrough.

Collapse Walkthrough

Web UI

Location	Review > Settings > Collapse Walkthrough
Default	false

.coderabbit.yaml

Field	reviews.collapse_walkthrough
Datatype	boolean
Default	false

Generate walkthrough in a markdown collapsible section.

Commit Status

Web UI

Location	Review > Settings > Commit Status
Default	true

.coderabbit.yaml

Field	reviews.commit_status
Datatype	boolean
Default	true

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

Disable Cache

Web UI

Location	Review > Settings > Disable Cache
Default	false

.coderabbit.yaml

Field	reviews.disable_cache
Datatype	boolean
Default	false

Activate this setting to disallow CodeRabbit from caching your repository's code and dependencies. This forces CodeRabbit to download the code and dependencies fresh from the repository for every code review that it performs.

When caching is allowed, then CodeRabbit stores a cache of code and metadata from your repostory for up to seven days after its most recent code review. This cache lets CodeRabbit save time and effort in between subsquent reviews of the same repository. For more information, see Caching.

We recommend leaving this setting off, which allows caching, and can speed up code reviews. For more information, see Trust the defaults.

note

The Data Retention setting overrides this one. If you disable all data retention, then your repositories won't keep a cache.

Fail Commit Status

Web UI

Location	Review > Settings > Fail Commit Status
Default	false

.coderabbit.yaml

Field	reviews.fail_commit_status
Datatype	boolean
Default	false

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

High Level Summary

Web UI

Location	Review > Settings > High Level Summary
Default	true

.coderabbit.yaml

Field	reviews.high_level_summary
Datatype	boolean
Default	true

Generate a high level summary of the changes in the PR/MR description.

High Level Summary In Walkthrough

Web UI

Location	Review > Settings > High Level Summary In Walkthrough
Default	false

.coderabbit.yaml

Field	reviews.high_level_summary_in_walkthrough
Datatype	boolean
Default	false

Include the high level summary in the walkthrough comment.

High Level Summary Placeholder

Web UI

Location	Review > Settings > High Level Summary Placeholder
Default	@coderabbitai summary

.coderabbit.yaml

Field	reviews.high_level_summary_placeholder
Datatype	string
Default	"@coderabbitai summary"

Placeholder in the PR/MR description that gets replaced with the high level summary.

Labeling Instructions

Web UI

Location	Review > Settings > Labeling Instructions
Default	Empty array

.coderabbit.yaml

Field	reviews.labeling_instructions
Datatype	array
Default	[]

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.

Path Filters

Web UI

Location	Review > Settings > Path Filters
Default	Empty array

.coderabbit.yaml

Field	reviews.path_filters
Datatype	array
Default	[]

Path filters, if defined, restrict the portions of your repository that CodeRabbit uses for context when preparing code reviews.

You can define a list of path specifications, relative to the root of your repository, to use as path filters.

Paths can be exclude paths, which start with a leading ! 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:

src/**
!**/*.{bin,csv}

note

Under the hood, CodeRabbit uses your provided list of path filters as an argument to git sparse-checkout when preparing its own copy of your repository for code review context.

We strongly recommend defining path filters for any repositories that contain a significant amount of generated files or data that has no contextual bearing on code reviews. CodeRabbit can work faster if it can ignore files that aren't relevant to pull requests. For more information, see Speed up reviews by adding path filters.

Path Instructions

Web UI

Location	Review > Settings > Path Instructions
Default	Empty array

.coderabbit.yaml

Field	reviews.path_instructions
Datatype	array
Default	[]

Path instructions are additional sets of instructions, expressed in natural lanaguge, that you provide to CodeRabbit for reveiwing certain files in your repository.

You associate each set of instuctions with a file path relative to the root of your repository. Your path specification can use extended glob patterns.

The following example defines a set of path instructions for all TypeScript and JavaScript files in a reposistory's src directory:

Example path settings: Web UI

Example path settings: coderabbit.yaml

path_instructions:
  - path: src/**/*.{ts,tsx,js}
  instructions:
    - Review the React.js/TypeScript/JavaScript code for best practices
    - Check for common security vulnerabilities such as:
    - SQL Injection
    - Insecure dependencies
    - Sensitive data exposure

For further examples of path instructions specific to various programming langauges, see the awesome-coderabbit public repository.

Poem

Web UI

Location	Review > Settings > Poem
Default	true

.coderabbit.yaml

Field	reviews.poem
Datatype	boolean
Default	true

Generate a poem in the walkthrough comment.

Profile

Web UI

Location	Review > Settings > Profile
Default	chill

.coderabbit.yaml

Field	reviews.profile
Datatype	string
Default	"chill"

An overall selector for the level of detail that CodeRabbit should apply to its reviews. Valid values are the following:

• Chill: CodeRabbit provides its usual level of commentary.
• Assertive: CodeRabbit provides significantly deeper or more verbose commentary, as much as possible.

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

Related Issues

Web UI

Location	Review > Settings > Related Issues
Default	true

.coderabbit.yaml

Field	reviews.related_issues
Datatype	boolean
Default	true

Include possibly related issues in the walkthrough.

Related PRs

Web UI

Location	Review > Settings > Related PRs
Default	true

.coderabbit.yaml

Field	reviews.related_prs
Datatype	boolean
Default	true

Include possibly related pull requests in the walkthrough.

Request Changes Workflow

Web UI

Location	Review > Settings > Request Changes Workflow
Default	false

.coderabbit.yaml

Field	reviews.request_changes_workflow
Datatype	boolean
Default	false

If enabled, then CodeRabbit marks a pull request as approved once all comments that CodeRabbit made have been resolved.

Enable this setting if you want to have CodeRabbit's approval count towards a minimum number of approvals that your have configured your Git platform to require before a pull request can be merged.

Review Status

Web UI

Location	Review > Settings > Review Status
Default	true

.coderabbit.yaml

Field	reviews.review_status
Datatype	boolean
Default	true

Post review details on each review. Additionally, post a review status when a review is skipped in certain cases.

Sequence Diagrams

Web UI

Location	Review > Settings > Sequence Diagrams
Default	true

.coderabbit.yaml

Field	reviews.sequence_diagrams
Datatype	boolean
Default	true

Generate sequence diagrams in the walkthrough.

Suggested Labels

Web UI

Location	Review > Settings > Suggested Labels
Default	true

.coderabbit.yaml

Field	reviews.suggested_labels
Datatype	boolean
Default	true

Suggest labels based on the changes in the pull request in the walkthrough.

Suggested Reviewers

Web UI

Location	Review > Settings > Suggested Reviewers
Default	true

.coderabbit.yaml

Field	reviews.suggested_reviewers
Datatype	boolean
Default	true

Suggest reviewers based on the changes in the pull request in the walkthrough.

Automatic Review

Enable Automatic Review

Web UI

Location	Review > Auto Review > Automatic Review
Default	true

.coderabbit.yaml

Field	reviews.auto_review.enabled
Datatype	boolean
Default	true

If enabled, then CodeRabbit reviews new and updated pull requests automatically. For more information, see Automatically review pull requests.

If disabled, then CodeRabbit performs only reviews that you request manually. For more information on manual review commands, see Manually request code reviews.

Disabling this setting also effectively disables all of the other settings listed in this section.

Automatic Incremental Review

Web UI

Location	Review > Auto Review > Automatic Incremental Review
Default	true

.coderabbit.yaml

Field	reviews.auto_review.auto_incremental_review
Datatype	boolean
Default	true

If enabled, then CodeRabbit performs automatic reviews of existing pull requests when their associated branches have commits pushed to them. These incremental reviews happen in addition to the initial code review that CodeRabbit generates after the pull request is first created.

For more information on manual review commands, see Manually request code reviews.

We recommend leaving this option enabled.

Base Branches

Web UI

Location	Review > Auto Review > Base Branches
Default	Empty array

.coderabbit.yaml

Field	reviews.auto_review.base_branches
Datatype	array
Default	[]

A list of branches that CodeRabbit performs automatic code reviews on, other than the reposiorty's main branch (usually 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.

Drafts

Web UI

Location	Review > Auto Review > Drafts
Default	false

.coderabbit.yaml

Field	reviews.auto_review.drafts
Datatype	boolean
Default	false

If defined, then CodeRabbit automatically reviews pull requests marked as a draft in your Git platform.

Ignore Title Keywords

Web UI

Location	Review > Auto Review > Ignore Title Keywords
Default	Empty array

.coderabbit.yaml

Field	reviews.auto_review.ignore_title_keywords
Datatype	array
Default	[]

Ignore reviewing if the title of the pull request contains any of these keywords (case-insensitive).

Labels

Web UI

Location	Review > Auto Review > Labels
Default	Empty array

.coderabbit.yaml

Field	reviews.auto_review.labels
Datatype	array
Default	[]

If defined with at least one label, then CodeRabbit automatically reviews only pull requests that have at least one of the labels in this list.

In this case, you can manually request reviews of pull requests lacking a qualifying label. For more information on manual review commands, see Manually request code reviews.

Finishing Touches

Docstrings

Web UI

Location	Review > Finishing Touches > Docstrings
Default	true

.coderabbit.yaml

Field	reviews.finishing_touches.docstrings.enabled
Datatype	boolean
Default	true

If enabled, then CodeRabbit can generate inline documentation for functions added in a pull request. For more information, see Docstrings.

Unit Tests

Web UI

Location	Review > Finishing Touches > Unit Tests
Default	true

.coderabbit.yaml

Field	reviews.finishing_touches.unit_tests.enabled
Datatype	boolean
Default	true

If enabled, then CodeRabbit can generate unit tests for code added in a pull request. For more information, see Unit Test Generation.

Chat

Auto Reply

Web UI

Location	Chat > Auto Reply
Default	true

.coderabbit.yaml

Field	chat.auto_reply
Datatype	boolean
Default	true

Enable the bot to reply automatically without requiring the user to tag it.

Integrations

Jira

Web UI

Location	Chat > Jira
Default	auto

.coderabbit.yaml

Field	chat.integrations.jira.usage
Datatype	string
Default	"auto"

Enable the Jira integration for opening issues, etc. 'auto' disables the integration for public repositories.

Linear

Web UI

Location	Chat > Linear
Default	auto

.coderabbit.yaml

Field	chat.integrations.linear.usage
Datatype	string
Default	"auto"

Enable the Linear integration for opening issues, etc. 'auto' disables the integration for public repositories.

Knowledge Base

Basic settings

Opt Out

Web UI

Location	Knowledge Base > Opt Out
Default	false

.coderabbit.yaml

Field	knowledge_base.opt_out
Datatype	boolean
Default	false

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.

Pull Requests

Web UI

Location	Knowledge Base > Pull Requests
Default	auto

.coderabbit.yaml

Field	knowledge_base.pull_requests.scope
Datatype	string
Default	"auto"

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.

Web Search

Web UI

Location	Knowledge Base > Web Search
Default	true

.coderabbit.yaml

Field	knowledge_base.web_search.enabled
Datatype	boolean
Default	true

Enable the web search integration.

Issues

Web UI

Location	Knowledge Base > Issues
Default	auto

.coderabbit.yaml

Field	knowledge_base.issues.scope
Datatype	string
Default	"auto"

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.

Jira

Enable Jira

Web UI

Location	Knowledge Base > Jira
Default	auto

.coderabbit.yaml

Field	knowledge_base.jira.usage
Datatype	string
Default	"auto"

Enable the Jira knowledge base integration. 'auto' disables the integration for public repositories.

Project Keys

Web UI

Location	Knowledge Base > Project Keys
Default	Empty array

.coderabbit.yaml

Field	knowledge_base.jira.project_keys
Datatype	array
Default	[]

Specify the Jira project keys to use for the knowledge base.

Learnings

Web UI

Location	Knowledge Base > Learnings
Default	auto

.coderabbit.yaml

Field	knowledge_base.learnings.scope
Datatype	string
Default	"auto"

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.

Linear

Enable Linear

Web UI

Location	Knowledge Base > Linear
Default	auto

.coderabbit.yaml

Field	knowledge_base.linear.usage
Datatype	string
Default	"auto"

Enable the Linear knowledge base integration. 'auto' disables the integration for public repositories.

Team Keys

Web UI

Location	Knowledge Base > Team Keys
Default	Empty array

.coderabbit.yaml

Field	knowledge_base.linear.team_keys
Datatype	array
Default	[]

Specify the Linear team keys (identifiers) to use for the knowledge base. E.g. 'ENG'

Code Generation

Code Generation Language

Web UI

Location	Code Generation > Language
Default	en-US

.coderabbit.yaml

Field	code_generation.docstrings.language
Datatype	string
Default	"en-US"

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

Docstring Path Instructions

Web UI

Location	Code Generation > Path Instructions
Default	Empty array

.coderabbit.yaml

Field	code_generation.docstrings.path_instructions
Datatype	array
Default	[]

Provide additional guidelines for docstring generation based on file paths.

Unit Test Path Instructions

Web UI

Location	Code Generation > Unit Test Generation
Default	Empty array

.coderabbit.yaml

Field	code_generation.unit_tests.path_instructions
Datatype	array
Default	[]

Provide additional guidelines for unit test generation based on file paths.

Tools

CodeRabbit integrates with various third-party tools for enhanced code analysis.

actionlint

actionlint is a static checker for GitHub Actions workflow files.

Enable actionlint

Web UI

Location	Review > Tools > Enable actionlint
Default	true

.coderabbit.yaml

Field	reviews.tools.actionlint.enabled
Datatype	boolean
Default	true

is a static checker for GitHub Actions workflow files.

ast-grep

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

Essential Rules

Web UI

Location	Review > Tools > ast-grep > Essential Rules
Default	true

.coderabbit.yaml

Field	reviews.tools.ast-grep.essential_rules
Datatype	boolean
Default	true

Use ast-grep essentials package.

Packages

Web UI

Location	Review > Tools > ast-grep > Packages
Default	Empty array

.coderabbit.yaml

Field	reviews.tools.ast-grep.packages
Datatype	array
Default	[]

Predefined packages to be used.

Rule Dirs

Web UI

Location	Review > Tools > ast-grep > Rule Dirs
Default	Empty array

.coderabbit.yaml

Field	reviews.tools.ast-grep.rule_dirs
Datatype	array
Default	[]

List of rules directories.

Util Dirs

Web UI

Location	Review > Tools > ast-grep > Util Dirs
Default	Empty array

.coderabbit.yaml

Field	reviews.tools.ast-grep.util_dirs
Datatype	array
Default	[]

List of utils directories.

Biome

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

Enable Biome

Web UI

Location	Review > Tools > Enable Biome
Default	true

.coderabbit.yaml

Field	reviews.tools.biome.enabled
Datatype	boolean
Default	true

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

Brakeman

Brakeman is a static analysis security vulnerability scanner for Ruby on Rails applications. | v7.0.2

Enable Brakeman

Web UI

Location	Review > Tools > Enable Brakeman
Default	true

.coderabbit.yaml

Field	reviews.tools.brakeman.enabled
Datatype	boolean
Default	true

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

Buf

Buf offers linting for Protobuf files.

Enable Buf

Web UI

Location	Review > Tools > Enable Buf
Default	true

.coderabbit.yaml

Field	reviews.tools.buf.enabled
Datatype	boolean
Default	true

Buf offers linting for Protobuf files.

checkmake

checkmake is a linter for Makefiles.

Enable checkmake

Web UI

Location	Review > Tools > Enable checkmake
Default	true

.coderabbit.yaml

Field	reviews.tools.checkmake.enabled
Datatype	boolean
Default	true

checkmake is a linter for Makefiles.

Checkov

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

Enable Checkov

Web UI

Location	Review > Tools > Enable Checkov
Default	true

.coderabbit.yaml

Field	reviews.tools.checkov.enabled
Datatype	boolean
Default	true

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

CircleCI

CircleCI tool is a static checker for CircleCI config files.

Enable CircleCI

Web UI

Location	Review > Tools > Enable CircleCI
Default	true

.coderabbit.yaml

Field	reviews.tools.circleci.enabled
Datatype	boolean
Default	true

CircleCI tool is a static checker for CircleCI config files.

Clippy

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

Enable Clippy

Web UI

Location	Review > Tools > Enable Clippy
Default	true

.coderabbit.yaml

Field	reviews.tools.clippy.enabled
Datatype	boolean
Default	true

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

Cppcheck

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

Enable Cppcheck

Web UI

Location	Review > Tools > Enable Cppcheck
Default	true

.coderabbit.yaml

Field	reviews.tools.cppcheck.enabled
Datatype	boolean
Default	true

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

detekt

Detekt is a static code analysis tool for Kotlin files.

Enable detekt

Web UI

Location	Review > Tools > detekt > Enable
Default	true

.coderabbit.yaml

Field	reviews.tools.detekt.enabled
Datatype	boolean
Default	true

Enable detekt.

Config File

Web UI

Location	Review > Tools > detekt > Config File
Default	No default

.coderabbit.yaml

Field	reviews.tools.detekt.config_file
Datatype	string
Default	No default

Optional path to the detekt configuration file relative to the repository.

dotenv-linter

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

Enable dotenv-linter

Web UI

Location	Review > Tools > Enable dotenv-linter
Default	true

.coderabbit.yaml

Field	reviews.tools.dotenvLint.enabled
Datatype	boolean
Default	true

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

ESLint

ESLint is a static code analysis tool for JavaScript files.

Enable ESLint

Web UI

Location	Review > Tools > Enable ESLint
Default	true

.coderabbit.yaml

Field	reviews.tools.eslint.enabled
Datatype	boolean
Default	true

ESLint is a static code analysis tool for JavaScript files.

GitHub Checks

GitHub Checks integration configuration.

Enable GitHub Checks

Web UI

Location	Review > Tools > GitHub Checks > Enable
Default	true

.coderabbit.yaml

Field	reviews.tools.github-checks.enabled
Datatype	boolean
Default	true

Enable integration, defaults to true

Timeout Ms

Web UI

Location	Review > Tools > GitHub Checks > Timeout Ms
Default	90000

.coderabbit.yaml

Field	reviews.tools.github-checks.timeout_ms
Datatype	number
Default	90000

Time in milliseconds to wait for all GitHub Checks to conclude.

Gitleaks

Gitleaks is a secret scanner.

Enable Gitleaks

Web UI

Location	Review > Tools > Enable Gitleaks
Default	true

.coderabbit.yaml

Field	reviews.tools.gitleaks.enabled
Datatype	boolean
Default	true

Gitleaks is a secret scanner.

golangci-lint

golangci-lint is a fast linters runner for Go.

Enable golangci-lint

Web UI

Location	Review > Tools > golangci-lint > Enable
Default	true

.coderabbit.yaml

Field	reviews.tools.golangci-lint.enabled
Datatype	boolean
Default	true

Enable golangci-lint.

Config File

Web UI

Location	Review > Tools > golangci-lint > Config File
Default	No default

.coderabbit.yaml

Field	reviews.tools.golangci-lint.config_file
Datatype	string
Default	No 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'.

Hadolint

Hadolint is a Dockerfile linter.

Enable Hadolint

Web UI

Location	Review > Tools > Enable Hadolint
Default	true

.coderabbit.yaml

Field	reviews.tools.hadolint.enabled
Datatype	boolean
Default	true

Hadolint is a Dockerfile linter.

HTMLHint

HTMLHint is a static code analysis tool for HTML files.

Enable HTMLHint

Web UI

Location	Review > Tools > HTMLHint > Enable
Default	true

.coderabbit.yaml

Field	reviews.tools.htmlhint.enabled
Datatype	boolean
Default	true

Enable HTMLHint.

Config File

Web UI

Location	Review > Tools > HTMLHint > Config File
Default	No default

.coderabbit.yaml

Field	reviews.tools.htmlhint.config_file
Datatype	string
Default	No default

Optional path to the HTMLHint configuration file relative to the repository. This is useful when the configuration file is named differently than the default '.htmlhintrc'.

LanguageTool

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

Disabled Categories

Web UI

Location	Review > Tools > LanguageTool > Disabled Categories
Default	Empty array

.coderabbit.yaml

Field	reviews.tools.languagetool.disabled_categories
Datatype	array
Default	[]

IDs of categories to be disabled. Note: TYPOS, TYPOGRAPHY, and CASING are always disabled.

Disabled Rules

Web UI

Location	Review > Tools > LanguageTool > Disabled Rules
Default	Empty array

.coderabbit.yaml

Field	reviews.tools.languagetool.disabled_rules
Datatype	array
Default	[]

IDs of rules to be disabled. Note: EN_UNPAIRED_BRACKETS, and EN_UNPAIRED_QUOTES are always disabled.

Enable LanguageTool

Web UI

Location	Review > Tools > LanguageTool > Enable
Default	true

.coderabbit.yaml

Field	reviews.tools.languagetool.enabled
Datatype	boolean
Default	true

Enable LanguageTool

Enabled Categories

Web UI

Location	Review > Tools > LanguageTool > Enabled Categories
Default	Empty array

.coderabbit.yaml

Field	reviews.tools.languagetool.enabled_categories
Datatype	array
Default	[]

IDs of categories to be enabled.

Enabled Only

Web UI

Location	Review > Tools > LanguageTool > Enabled Only
Default	false

.coderabbit.yaml

Field	reviews.tools.languagetool.enabled_only
Datatype	boolean
Default	false

Only the rules and categories whose IDs are specified with 'enabledRules' or 'enabledCategories' are enabled.

Enabled Rules

Web UI

Location	Review > Tools > LanguageTool > Enabled Rules
Default	Empty array

.coderabbit.yaml

Field	reviews.tools.languagetool.enabled_rules
Datatype	array
Default	[]

IDs of rules to be enabled. The rule won't run unless 'level' is set to a level that activates the rule.

Level

Web UI

Location	Review > Tools > LanguageTool > Level
Default	default

.coderabbit.yaml

Field	reviews.tools.languagetool.level
Datatype	string
Default	"default"

If set to 'picky', additional rules will be activated, i.e. rules that you might only find useful when checking formal text.

Luacheck

Configuration for Lua code linting to ensure code quality

Enable Luacheck

Web UI

Location	Review > Tools > Enable Luacheck
Default	true

.coderabbit.yaml

Field	reviews.tools.luacheck.enabled
Datatype	boolean
Default	true

Luacheck helps maintain consistent and error-free Lua code

markdownlint

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

Enable markdownlint

Web UI

Location	Review > Tools > Enable markdownlint
Default	true

.coderabbit.yaml

Field	reviews.tools.markdownlint.enabled
Datatype	boolean
Default	true

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

OXC

OXC is a JavaScript/TypeScript linter written in Rust.

Enable OXC

Web UI

Location	Review > Tools > Enable OXC
Default	true

.coderabbit.yaml

Field	reviews.tools.oxc.enabled
Datatype	boolean
Default	true

OXC is a JavaScript/TypeScript linter written in Rust.

PHPStan

PHPStan is a tool to analyze PHP code.

Enable PHPStan

Web UI

Location	Review > Tools > PHPStan > Enable
Default	true

.coderabbit.yaml

Field	reviews.tools.phpstan.enabled
Datatype	boolean
Default	true

PHPStan requires config file in your repository root. Please ensure that this file contains the paths: parameter.

Level

Web UI

Location	Review > Tools > PHPStan > Level
Default	default

.coderabbit.yaml

Field	reviews.tools.phpstan.level
Datatype	string
Default	"default"

Specify the rule level to run. This setting is ignored if your configuration file already has a level: parameter.

PMD

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

Enable PMD

Web UI

Location	Review > Tools > PMD > Enable
Default	true

.coderabbit.yaml

Field	reviews.tools.pmd.enabled
Datatype	boolean
Default	true

Enable PMD.

Config File

Web UI

Location	Review > Tools > PMD > Config File
Default	No default

.coderabbit.yaml

Field	reviews.tools.pmd.config_file
Datatype	string
Default	No default

Optional path to the PMD configuration file relative to the repository.

Prisma Schema Linting

Configuration for Prisma Schema linting to ensure schema file quality

Enable Prisma Schema Linting

Web UI

Location	Review > Tools > Enable Prisma Schema Linting
Default	true

.coderabbit.yaml

Field	reviews.tools.prismaLint.enabled
Datatype	boolean
Default	true

Prisma Schema linting helps maintain consistent and error-free schema files

Pylint

Pylint is a Python static code analysis tool.

Enable Pylint

Web UI

Location	Review > Tools > Enable Pylint
Default	true

.coderabbit.yaml

Field	reviews.tools.pylint.enabled
Datatype	boolean
Default	true

Pylint is a Python static code analysis tool.

Regal

Regal is a linter and language server for Rego.

Enable Regal

Web UI

Location	Review > Tools > Enable Regal
Default	true

.coderabbit.yaml

Field	reviews.tools.regal.enabled
Datatype	boolean
Default	true

Regal is a linter and language server for Rego.

RuboCop

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

Enable RuboCop

Web UI

Location	Review > Tools > Enable RuboCop
Default	true

.coderabbit.yaml

Field	reviews.tools.rubocop.enabled
Datatype	boolean
Default	true

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

Ruff

Ruff is a Python linter and code formatter.

Enable Ruff

Web UI

Location	Review > Tools > Enable Ruff
Default	true

.coderabbit.yaml

Field	reviews.tools.ruff.enabled
Datatype	boolean
Default	true

Ruff is a Python linter and code formatter.

Semgrep

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

Enable Semgrep

Web UI

Location	Review > Tools > Semgrep > Enable
Default	true

.coderabbit.yaml

Field	reviews.tools.semgrep.enabled
Datatype	boolean
Default	true

Enable Semgrep.

Config File

Web UI

Location	Review > Tools > Semgrep > Config File
Default	No default

.coderabbit.yaml

Field	reviews.tools.semgrep.config_file
Datatype	string
Default	No default

Optional path to the Semgrep configuration file relative to the repository.

ShellCheck

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

Enable ShellCheck

Web UI

Location	Review > Tools > Enable ShellCheck
Default	true

.coderabbit.yaml

Field	reviews.tools.shellcheck.enabled
Datatype	boolean
Default	true

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

Shopify Theme Check

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

Enable Shopify Theme Check

Web UI

Location	Review > Tools > Enable Shopify Theme Check
Default	true

.coderabbit.yaml

Field	reviews.tools.shopifyThemeCheck.enabled
Datatype	boolean
Default	true

A linter for Shopify themes that helps you follow Shopify theme & Liquid best practices

SQLFluff

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

Enable SQLFluff

Web UI

Location	Review > Tools > Enable SQLFluff
Default	true

.coderabbit.yaml

Field	reviews.tools.sqlfluff.enabled
Datatype	boolean
Default	true

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

SwiftLint

SwiftLint integration configuration object.

Enable SwiftLint

Web UI

Location	Review > Tools > SwiftLint > Enable
Default	true

.coderabbit.yaml

Field	reviews.tools.swiftlint.enabled
Datatype	boolean
Default	true

Enable SwiftLint.

Config File

Web UI

Location	Review > Tools > SwiftLint > Config File
Default	No default

.coderabbit.yaml

Field	reviews.tools.swiftlint.config_file
Datatype	string
Default	No 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'.

YAMLlint

YAMLlint is a linter for YAML files.

Enable YAMLlint

Web UI

Location	Review > Tools > Enable YAMLlint
Default	true

.coderabbit.yaml

Field	reviews.tools.yamllint.enabled
Datatype	boolean
Default	true

YAMLlint is a linter for YAML files.