CodeRabbitの設定項目一覧を翻訳しました

CodeRabbitはAIコードレビューサービスです。GitHubやGitLabと連携して、プルリクエスト（PR）に対して自動的にレビューを実行します。

設定はダッシュボードでも可能ですが、各リポジトリに対して .coderabbit.yml ファイルを配置して設定も可能です。設定はConfiguration reference - CodeRabbitにある通りですが、英語なので分かりづらいかも知れません。

そこで、2026年04月現在可能な設定項目について、日本語でまとめておきます。設定の参考にしてください。

設定できる内容について

設定できる項目はこちらのJSONスキーマでも確認できます。 definitions.schema.properties 以下がYAMLのキーになります。

language

文字列で指定します。ISOコード形式で指定します。日本語の場合は ja または ja-JP としてください。デフォルトは en-US です。

tone_instructions

レビューのトーンを指定します（最大250文字）。デフォルトは空文字です。たとえば 必ずダースベーダー調の話し方にしてください。 などと指定します。

early_access

早期アクセス機能を有効にする場合、 true を指定します。デフォルトは false です。

enable_free_tier

無課金ユーザーに対して、無料プランの機能を有効にする場合に true を指定します。デフォルトは true です。

inheritance

親設定から値を継承するかどうか設定します。継承は各レベルで有効化されている場合のみ上位に伝播します。デフォルトは false です。

reviews

レビューキー以下はさらにオブジェクトです。

profile

レビュー用のプロフィールを設定設定します。 chill または assertive のいずれかを指定します。デフォルトは chill です。 chill はリラックスしたトーンで、 assertive はよりアグレッシブに満ちたトーンでレビューを行います。

request_changes_workflow

CodeRabbitのコメントが解決したらレビューを承認するかどうか設定します。デフォルトは false です。

high_level_summary

PRの中に、変更に関する高レベルの要約を入れるかどうか設定します。デフォルトは true です。

high_level_summary_instructions

高レベルの要約の内容やフォーマットをカスタマイズするための指示を設定します。デフォルトは空文字です。たとえば 箇条書きで簡潔なリリースノートを作成し、その後に各コントリビュータの追加行数と削除行数を示すMarkdownテーブルを続けてください。 などと指定します。 high_level_summary_in_walkthrough を使うと、要約をPR説明ではなくウォークスルーに配置できます。

high_level_summary_placeholder

PRの中で、高レベルの要約に置き換わる部分を指定します。デフォルトは @coderabbitai summary です。

high_level_summary_in_walkthrough

高レベルの要約をウォークスルーに含めるかどうか設定します。デフォルトは false です。

auto_title_placeholder

PRのタイトルに指定したキーワードを追加すると、タイトルが自動生成されます。デフォルトは @coderabbitai です。

auto_title_instructions

タイトルを自動生成するための指示を設定します。デフォルトはありません。

review_status

各レビューに、レビューの詳細をポストします。さらに特定のケースにおいてレビューがスキップされた場合、レビューのステータスをポストします。デフォルトは true です。

review_details

レビューの詳細情報（無視されたファイル、追加で使用されたコンテキスト、抑制されたコメントなど）をポストするかどうか設定します。デフォルトは false です。

commit_status

レビュー中の時にはコミットステータスを pending に、レビューが完了したら success に設定します。デフォルトは true です。

fail_commit_status

レビューが失敗、またはできない場合にはコミットステータスを failure に設定します。デフォルトは false です。

collapse_walkthrough

ウォークスルーをMarkdownの折りたたみセクションでラップするかどうか設定します。デフォルトは true です。

changed_files_summary

変更されたファイルの要約を生成するかどうか指定します。デフォルトは true です。

sequence_diagrams

ウォークスルーにシーケンス図を含めるかどうか設定します。デフォルトは true です。

estimate_code_review_effort

ウォークスルーにコードレビュー工数の見積もりを含めるかどうか設定します。デフォルトは true です。

assess_linked_issues

変更内容がウォークスルーで指摘された課題とどれくらい対応しているかを評価するかどうか設定します。デフォルトは true です。

related_issues

ウォークスルーにて、関連する課題を表示するかどうか設定します。デフォルトは true です。

related_prs

ウォークスルーにて、関連するプルリクエストを表示するかどうか設定します。デフォルトは true です。

suggested_labels

ウォークスルーにて、ラベルを提案するかどうか設定します。デフォルトは true です。

auto_apply_labels

PRに対して、自動的にラベルを付与するかどうか設定します。デフォルトは false です。

suggested_reviewers

レビュアーの提案を行うかどうか設定します。デフォルトは true です。

auto_assign_reviewers

自動的にレビュアーを割り当てるかどうか設定します。デフォルトは false です。

suggested_reviewers_instructions

レビュアーの割り当て指示は、以下の配列になります。GitHub専用です。

reviewers

割り当てるレビュアーのリストです。各要素は以下のキーを持つオブジェクトです。

• handle
  レビュアーのユーザー名またはチームスラッグ。たとえば security-pdl など。
• type
  レビュアーが個人ユーザーかチーム/グループかを指定します。 user または group のいずれかで、デフォルトは user です。

instructions

3,000文字以下の文字列で、これらのレビュアーを割り当てる条件を指示します。たとえば PRにWindowsレジストリの変更が含まれる場合に割り当ててください など。

in_progress_fortune

レビュー実行中にフォーチュンメッセージを投稿するかどうか設定します。デフォルトは true です。

poem

ウォークスルーの最後にポエムを追加するかどうか設定します。デフォルトは true です。

enable_prompt_for_ai_agents

インラインレビューコメントに「Prompt for AI Agents」セクションを含めるかどうか設定します。AIエージェント向けのコード生成指示を提供します。デフォルトは true です。

labeling_instructions

ラベル指示は、以下の配列になります。

label

具体的なラベル名。たとえば bug や enhancement 、 frontend など。

instructions

3,000文字以下。たとえば Reactコンポーネントに関する変更を含む場合 など。

path_filters

文字列の配列です。ここで指定したパターンは、レビュー時にリポジトリのクローンを作成する際に利用されます。 ! で始まるパターンは除外されます。たとえば、 !docs/** と指定すると、 docs ディレクトリ以下は除外されます。逆に src/** と指定すると、 src ディレクトリ以下はレビュー対象になります。

path_instructions

パスインストラクションは、以下の配列になります。

path

ファイルパスのパターン。たとえば src/** や docs/** など。

instructions

20,000文字以下の文字列で、パスに対するレビューガイドラインを詳細に指示します。

abort_on_close

PRがクローズ・マージされた場合にレビューを中止するかどうか設定します。デフォルトは true です。

disable_cache

キャッシュの無効化について指定します。デフォルトは false です。キャッシュを無効化すると、毎回コードと依存関係をダウンロードします。

slop_detection

スパムや低品質なPRの検出に関する設定です。公開リポジトリ・GitHub限定の機能です。 slop_detection 以下は、以下のキーがあります。

enabled

slop検出を有効にするかどうか設定します。デフォルトは true です。

label

slop（低品質）と分類されたPRに付与するラベルを指定します。たとえば slop など。

auto_review

自動レビュー以下は、以下のキーがあります。

enabled

自動コードレビューを有効にします。デフォルトは true です。

description_keyword

自動レビューが無効（ enabled が false ）の場合に、PR説明にこのキーワードが含まれているとレビューをトリガーします。デフォルトは空文字です。

auto_incremental_review

自動インクリメンタルレビューを有効にします。デフォルトは true です。

auto_pause_after_reviewed_commits

指定した数のレビュー済みコミット後に自動レビューを一時停止します。 0 で無効になります。デフォルトは 5 です。

ignore_title_keywords

文字列の配列です。ここで指定したキーワードがあると、レビューはスキップされます。大文字小文字は区別されません。

labels

文字列の配列です。指定されたラベルがある場合のみ、自動レビューが実行されます。 ! で始まるラベルは否定マッチになります。たとえば ['bug', 'feature'] はいずれかのラベルがあるPRをレビューし、 ['!wip'] は wip ラベル以外のすべてのPRをレビューします。この設定は enabled が false の場合でもレビューをトリガーします。

drafts

ドラフトのプルリクエストに対しても自動レビューを実行するかどうか設定します。デフォルトは false です。

base_branches

文字列の配列。レビューするベースのブランチを指定します。正規表現が利用できます。

ignore_usernames

プルリクエストのレビューを行わないユーザー名を列挙します。メールアドレスではなく、Gitプラットフォームのユーザー名と完全に一致している必要があります。デフォルトは [] です。

finishing_touches

finishing_touches 以下は、以下のキーがあります。

docstrings

ドキュメンテーション文字列の生成に関する設定です。 docstrings 以下は、以下のキーがあります。

• enabled
  PRに対して、ドキュメンテーション文字列を生成するかどうか設定します。デフォルトは true です。

unit_tests

ユニットテストの生成に関する設定です。 unit_tests 以下は、以下のキーがあります。

• enabled
  PRに対して、ユニットテストを生成するかどうか設定します。デフォルトは true です。

simplify

コード簡略化に関する設定です。 simplify 以下は、以下のキーがあります。

• enabled
  Simplify仕上げタッチを有効にするかどうか設定します。変更されたコードの再利用性、品質、効率をレビューし、改善を適用します。デフォルトは false です。

custom

カスタム仕上げタッチレシピの配列です。最大5件まで定義できます。 @coderabbitai run <レシピ名> で実行できます。各要素は以下のキーを持ちます。

• enabled
  このカスタムレシピを有効にするかどうか設定します。デフォルトは true です。
• name
  レシピ名です（最大100文字）。コマンドで使用されます。
• instructions
  レシピが実行する内容の指示です（最大10,000文字）。

pre_merge_checks

マージ前チェックの設定です。 pre_merge_checks 以下は、以下のキーがあります。

override_requested_reviewers_only

有効にすると、リクエストされたレビュアーのみ（PRの作成者ではなく）がマージ前チェックの失敗をオーバーライド/無視できるようになります。デフォルトは false です。

docstrings

ドキュメント文字列カバレッジのチェック設定です。以下のキーがあります。

• mode
  実施レベルを指定します。 off 、 warning 、 error のいずれかです。 off はチェックを無効にし、 warning は警告を投稿し、 error はマージ前に解決が必要になります。デフォルトは warning です。
• threshold
  チェックに合格するために必要な最低カバレッジ（%）を指定します（0〜100）。デフォルトは 80 です。

title

PRタイトルのチェック設定です。以下のキーがあります。

• mode
  実施レベルを指定します。 off 、 warning 、 error のいずれかです。デフォルトは warning です。
• requirements
  タイトルの要件を記述します。たとえば タイトルは簡潔かつ説明的で、50文字以内が理想的です。 など。デフォルトは空文字です。

description

PR説明のチェック設定です。以下のキーがあります。

• mode
  実施レベルを指定します。 off 、 warning 、 error のいずれかです。デフォルトは warning です。

issue_assessment

リンクされたIssueへの対応状況の評価設定です。以下のキーがあります。

• mode
  実施レベルを指定します。 off 、 warning 、 error のいずれかです。デフォルトは warning です。

custom_checks

カスタムマージ前チェックの配列です。最大50件まで定義できます。各要素は以下のキーを持ちます。

• mode
  実施レベルを指定します。 off 、 warning 、 error のいずれかです。デフォルトは warning です。
• name
  チェックの表示名です（最大50文字）。
• instructions
  合格/不合格の決定基準を記述します（最大10,000文字）。

tools

ast-grep

ast-grep 以下は、以下のキーがあります。

• rule_dirs
  文字列の配列です。ルールディレクトリのリストが指定できます。
• util_dirs
  文字列の配列です。ユーティリティディレクトリのリストが指定できます。
• essential_rules
  ast-grepに必須のパッケージを利用するかどうか指定します。デフォルトは true です。
• packages
  文字列の配列です。利用するパッケージのリストを指定します。

shellcheck

ShellCheckはシェルスクリプトのバグを見つける静的解析ツールです。 shellcheck 以下は、以下のキーがあります。

• enabled
  ShellCheckを有効にするかどうか設定します。デフォルトは true です。

ruff

RuffはPythonのLinter/コードフォーマッタです。 ruff 以下は、以下のキーがあります。

• enabled
  Ruffを有効にするかどうか設定します。デフォルトは true です。

markdownlint

markdownlint-cli2を利用します。markdownlint-cli2は、Markdownファイル向けの静的解析ツールで、Markdown標準と一貫性を強制します。 markdownlint 以下は、以下のキーがあります。

• enabled
  markdownlintを有効にするかどうか設定します。デフォルトは true です。

github-checks

GitHub 統合設定をチェックします。 github-checks 以下は、以下のキーがあります。

• enabled
  GitHubチェックを有効にするかどうか設定します。デフォルトは true です。
• timeout_ms
  GitHubチェックのタイムアウト時間をミリ秒単位で指定します（0以上、900000以下）。デフォルトは 90000 です。

languagetool

LanguageToolの利用について設定します。LanguageToolは30以上の言語に対応したスタイルと文法のチェッカーです。 languagetool 以下は、以下のキーがあります。

• enabled
  LanguageToolを有効にするかどうか設定します。デフォルトは true です
• enabled_rules
  文字列の配列です。LanguageToolで有効にするルールのIDを指定します
• disabled_rules
  文字列の配列です。LanguageToolで無効にするルールのIDを指定します
• enabled_categories
  文字列の配列です。LanguageToolで有効にするカテゴリのIDを指定します
• disabled_categories
  文字列の配列です。LanguageToolで無効にするカテゴリのIDを指定します
• enabled_only
  enabled_rules と enabled_categories で指定されたルールとカテゴリのみを有効にします。デフォルトは false です
• level
  default または picky のいずれかを指定します。 default はデフォルトのルールセットを使用し、 picky は追加のルールが有効になります。デフォルトは default です

biome

BiomeはWebプロジェクトのための高速なフォーマッタ、Linter、そしてアナライザです。 biome 以下は、以下のキーがあります。

• enabled
  Biomeを有効にするかどうか設定します。デフォルトは true です

hadolint

HadolintはDockerfileの静的解析ツールです。 hadolint 以下は、以下のキーがあります。

• enabled
  Hadolintを有効にするかどうか設定します。デフォルトは true です

swiftlint

SwiftLintはSwiftコードのスタイルと規約をチェックするツールです。 swiftlint 以下は、以下のキーがあります。

• enabled
  SwiftLintを有効にするかどうか設定します。デフォルトは true です
• config_file
  SwiftLintの設定ファイルの、リポジトリからのパスを指定します。設定ファイルの名前がデフォルトの .swiftlint.(yml|yaml) と異なる場合に指定します

phpstan

PHPStanはPHPの静的解析ツールです。 phpstan 以下は、以下のキーがあります。

• enabled
  PHPStanを有効にするかどうか設定します。デフォルトは true です
• level
  PHPStanのレベルを指定します。default か max または 0 から 9 の整数値で、デフォルトは default です。レベルについてはPHPStanのドキュメントを参照してください

phpmd

PHPMDはPHPコードの潜在的な問題を検出するツールです。 phpmd 以下は、以下のキーがあります。

• enabled
  PHPMDを有効にするかどうか設定します。デフォルトは true です

phpcs

PHP CodeSnifferはPHPのLinter/コーディング規約チェッカーです。 phpcs 以下は、以下のキーがあります。

• enabled
  PHP CodeSnifferを有効にするかどうか設定します。デフォルトは true です

golangci-lint

GolangCI-LintはGo言語のための静的解析ツールです。 golangci-lint 以下は、以下のキーがあります。

• enabled
  GolangCI-Lintを有効にするかどうか設定します。デフォルトは true です
• config_file
  GolangCI-Lintの設定ファイルの、リポジトリからのパスを指定します。設定ファイルの名前がデフォルトの .golangci.(yml|yaml|toml|json) と異なる場合に指定します

yamllint

YAMLファイルの静的解析ツールです。 yamllint 以下は、以下のキーがあります。

• enabled
  Yamllintを有効にするかどうか設定します。デフォルトは true です

gitleaks

Betterleaksは機密情報を検出するシークレットスキャナーです（Gitleaksの改良版）。 gitleaks 以下は、以下のキーがあります。

• enabled
  Betterleaksを有効にするかどうか設定します。デフォルトは true です

trufflehog

TruffleHogは検証機能付きのシークレットスキャナーです。コード内のシークレットを検出し、検証できます。 trufflehog 以下は、以下のキーがあります。

• enabled
  TruffleHogを有効にするかどうか設定します。デフォルトは true です

checkov

CheckovはIaCのセキュリティとコンプライアンスをチェックするツールです。 checkov 以下は、以下のキーがあります。

• enabled
  Checkovを有効にするかどうか設定します。デフォルトは true です

tflint

TFLintはTerraformのLinterで、潜在的なエラーの検出やベストプラクティスの強制を行います。 tflint 以下は、以下のキーがあります。

• enabled
  TFLintを有効にするかどうか設定します。デフォルトは true です

detekt

DetektはKotlinコードの静的解析ツールです。 detekt 以下は、以下のキーがあります。

• enabled
  Detektを有効にするかどうか設定します。デフォルトは true です
• config_file
  Detektの設定ファイルの、リポジトリからのパスを指定します

eslint

EslintはJavaScriptやTypeScriptのための静的解析ツールです。 eslint 以下は、以下のキーがあります。

• enabled
  Eslintを有効にするかどうか設定します。デフォルトは true です

rubocop

RubocopはRubyコードの静的解析ツールです。 rubocop 以下は、以下のキーがあります。

• enabled
  Rubocopを有効にするかどうか設定します。デフォルトは true です

flake8

Flake8はPyFlakes、pycodestyle、およびNed BatchelderのMcCabeスクリプトを統合したPython用リンターです。 flake8 以下は、以下のキーがあります。

• enabled
  Flake8を有効にするかどうか設定します。デフォルトは true です

fortitudeLint

FortitudeはFortranのLinterで、コード品質やスタイルの問題をチェックします。 fortitudeLint 以下は、以下のキーがあります。

• enabled
  Fortitudeを有効にするかどうか設定します。デフォルトは true です

buf

BufはProtocol Buffersのための静的解析ツールです。 buf 以下は、以下のキーがあります。

• enabled
  Bufを有効にするかどうか設定します。デフォルトは true です

regal

RegalはRegoのための静的解析ツールです。 regal 以下は、以下のキーがあります。

• enabled
  Regalを有効にするかどうか設定します。デフォルトは true です

actionlint

ActionlintはGitHub Actionsのための静的解析ツールです。 actionlint 以下は、以下のキーがあります。

• enabled
  Actionlintを有効にするかどうか設定します。デフォルトは true です

pmd

PMDはJavaや他の言語のための静的解析ツールです。 pmd 以下は、以下のキーがあります。

• enabled
  PMDを有効にするかどうか設定します。デフォルトは true です
• config_file
  PMDの設定ファイルの、リポジトリからのパスを指定します

clang

ClangはC/C++コードの静的解析とコード品質チェックを行うツールです。 clang 以下は、以下のキーがあります。

• enabled
  Clangを有効にするかどうか設定します。デフォルトは true です

cppcheck

CppcheckはC/C++コードの静的解析ツールです。 cppcheck 以下は、以下のキーがあります。

• enabled
  Cppcheckを有効にするかどうか設定します。デフォルトは true です

opengrep

OpenGrepは17以上の言語に対応した高性能な静的コード解析エンジンで、セキュリティ脆弱性やバグを検出します。Semgrep設定と互換性があります。 opengrep 以下は、以下のキーがあります。

• enabled
  OpenGrepを有効にするかどうか設定します。デフォルトは true です

semgrep

Semgrepはコードの静的解析ツールです。 semgrep 以下は、以下のキーがあります。

• enabled
  Semgrepを有効にするかどうか設定します。デフォルトは true です
• config_file
  Semgrepの設定ファイルの、リポジトリからのパスを指定します

circleci

CircleCI toolを使って、CircleCIの設定をチェックします。 circleci 以下は、以下のキーがあります。

• enabled
  CircleCI toolを有効にするかどうか設定します。デフォルトは true です

clippy

ClippyはRustコードの一般的なミスを検出し改善するためのLintコレクションです。 clippy 以下は、以下のキーがあります。

• enabled
  Clippyを有効にするかどうか設定します。デフォルトは true です

sqlfluff

SQLFluffはSQLコードの静的解析ツールです。 sqlfluff 以下は、以下のキーがあります。

• enabled
  SQLFluffを有効にするかどうか設定します。デフォルトは true です
• config_file
  SQLFluffの設定ファイルの、リポジトリからのパスを指定します。設定ファイルの名前がSQLFluffのデフォルトと異なる場合に指定します

trivy

TrivyはIaCファイル（Terraform、Kubernetes、Dockerなど）のセキュリティスキャナーで、設定ミスやシークレットを検出します。 trivy 以下は、以下のキーがあります。

• enabled
  Trivyを有効にするかどうか設定します。デフォルトは true です

prismaLint

Prismaのための静的解析ツールです。 prismaLint 以下は、以下のキーがあります。

• enabled
  PrismaLintを有効にするかどうか設定します。デフォルトは true です

pylint

PylintはPythonの静的コード解析ツールです。 pylint 以下は、以下のキーがあります。

• enabled
  Pylintを有効にするかどうか設定します。デフォルトは true です

oxc

OxcはRustで書かれたJavaScript/TypeScriptの静的解析ツールです。 oxc 以下は、以下のキーがあります。

• enabled
  Oxcを有効にするかどうか設定します。デフォルトは true です

shopifyThemeCheck

Shopifyのテーマファイルの静的解析ツールです。 shopifyThemeCheck 以下は、以下のキーがあります。

• enabled
  ShopifyThemeCheckを有効にするかどうか設定します。デフォルトは true です

luacheck

Luaのための静的解析ツールです。 luacheck 以下は、以下のキーがあります。

• enabled
  Luacheckを有効にするかどうか設定します。デフォルトは true です

brakeman

BrakemanはRuby on Railsアプリ用のセキュリティ脆弱性を静的解析します。 brakeman 以下は、以下のキーがあります。

• enabled
  brakemanを有効にするかどうか設定します。デフォルトは true です

dotenvLint

dotenv-linterは .env の静的解析ツールです。 dotenvLint 以下は、以下のキーがあります。

• enabled
  dotenvLintを有効にするかどうか設定します。デフォルトは true です

htmlhint

HTMLHintはHTMLファイルの静的解析ツールです。 htmlhint 以下は、以下のキーがあります。

• enabled
  HTMLHintを有効にするかどうか設定します。デフォルトは true です

stylelint

Stylelintはスタイルシート（CSS、SCSS、Sass、Less、SugarSS、Stylus）のLinterで、エラーを防ぎ規約を強制します。 stylelint 以下は、以下のキーがあります。

• enabled
  Stylelintを有効にするかどうか設定します。デフォルトは true です

checkmake

checkmakeはMakefileの静的解析ツールです。 checkmake 以下は、以下のキーがあります。

• enabled
  checkmakeを有効にするかどうか設定します。デフォルトは true です

osvScanner

OSVスキャナーは脆弱性パッケージスキャン用のツールです。 osvScanner 以下は、以下のキーがあります。

• enabled
  osvScannerを有効にするかどうか設定します。デフォルトは true です

blinter

BlinterはWindowsバッチファイルのLinterで、構文エラー、セキュリティ脆弱性、パフォーマンスの問題、スタイルの問題を包括的に静的解析します。 blinter 以下は、以下のキーがあります。

• enabled
  Blinterを有効にするかどうか設定します。デフォルトは true です

smartyLint

smarty-lintはSmarty 3テンプレートファイルのLinterで、不正なオペレーター使用、命名規約、空ブロック、引用符なし文字列などの一般的な問題をチェックします。 smartyLint 以下は、以下のキーがあります。

• enabled
  smarty-lintを有効にするかどうか設定します。デフォルトは true です

emberTemplateLint

ember-template-lintはHandlebarsテンプレートファイルのLinterで、アクセシビリティ違反、非推奨パターン、テンプレートのアンチパターンなどの問題をチェックします。 emberTemplateLint 以下は、以下のキーがあります。

• enabled
  ember-template-lintを有効にするかどうか設定します。デフォルトは true です

psscriptanalyzer

PSScriptAnalyzerはPowerShellスクリプトおよびモジュールの静的コードチェッカーです。 psscriptanalyzer 以下は、以下のキーがあります。

• enabled
  PSScriptAnalyzerを有効にするかどうか設定します。デフォルトは true です

chat

chat 以下は、以下のキーがあります。

art

チャット応答でアート（ASCIIまたは絵文字）を生成するかどうか設定します。デフォルトは true です。

allow_non_org_members

組織外のメンバーがCodeRabbitとコメントチャットで対話できるかどうか設定します。 false にすると、GitHub組織リポジトリでのIssue/レビューコメントでの対話を組織メンバーに制限します。自動PRレビューの対象には影響しません。デフォルトは true です。

auto_reply

ユーザーがタグ付けしなくとも、自動返信できるか設定します。デフォルトは true です。

integrations

integrations 以下は、以下のキーがあります。

jira

Jiraとの統合時に利用する設定です。

• usage
  Jiraの利用方法を指定します。 auto または enabled 、 disabled のいずれかを指定します。デフォルトは auto です。 auto は、公開リポジトリとの連携は無効になります。

linear

Linearとの統合時に利用する設定です。

• usage
  Linearの利用方法を指定します。 auto または enabled 、 disabled のいずれかを指定します。デフォルトは auto です。 auto は、公開リポジトリとの連携は無効になります

knowledge_base

knowledge_base 以下は、以下のキーがあります。

opt_out

データ保持を必要とするすべてのナレッジベース機能を無効にするか設定します。デフォルトは false です。設定を true にすると、既存のナレッジベースは削除されます。

web_search

web_search 以下は、以下のキーがあります。

• enabled
  Web検索を有効にするかどうか設定します。デフォルトは true です

code_guidelines

code_guidelines 以下は、以下のキーがあります。

• enabled
  コーディングガイドラインを有効にするか設定します。デフォルトは true です。
• filePatterns
  filePatterns は文字列の配列です。コーディングガイドライン文書用のファイル（複数可）を指定します。CodeRabbitはこれらのファイルをスキャンし、コードレビュー時に適用します。ファイル名は大文字と小文字を区別します。次の一般的なファイルはデフォルトで含まれます（**/.cursorrules / .github/copilot-instructions.md / .github/instructions/*.instructions.md / **/CLAUDE.md / **/GEMINI.md / */.cursor/rules/ / **/.windsurfrules / */.clinerules/ / */.rules/ / **/AGENT.md / **/AGENTS.md）。

learnings

learnings 以下は、以下のキーがあります。

• scope
  local または global 、 auto のいずれかを指定します。 local はローカルリポジトリのみに学習を適用し、 global は組織全体、 auto は公開リポジトリの場合はリポジトリのみ、プライベートリポジトリの場合は組織に対して学習します。デフォルトは auto です

issues

issues 以下は、以下のキーがあります。

• scope
  local 、 global 、 auto のいずれかを指定します。 local はリポジトリの Issue のみ、 global は組織の Issue のみ、 auto は公開リポジトリにはリポジトリの Issue、非公開リポジトリには組織の Issue を使用します。デフォルトは auto です

jira

jira 以下は、以下のキーがあります。

• usage
  Jira ナレッジベースの統合を有効・無効を設定します。 auto 、 enabled 、 disabled のいずれかを指定します。デフォルトは auto です。 auto は、公開リポジトリとの連携は無効になります
• project_keys
  Jiraプロジェクトのキーの配列です。Jiraナレッジベースを有効にする場合、プロジェクトキーを指定する必要があります。プロジェクトキーは、Jiraのプロジェクト設定で確認できます

linear

linear 以下は、以下のキーがあります。

• usage
  Linear ナレッジベースの統合を有効・無効を設定します。 auto 、 enabled 、 disabled のいずれかを指定します。デフォルトは auto です。 auto は、公開リポジトリとの連携は無効になります
• team_keys
  Linearチームのキーの配列です。Linearナレッジベースを有効にする場合、チームキーを指定する必要があります。チームキーは、Linearのチーム設定で確認できます

pull_requests

pull_requests 以下は、以下のキーがあります。

• scope
  local 、 global 、 auto のいずれかを指定します。 local はリポジトリのプルリクエストのみ、 global は組織のプルリクエストのみ、 auto は公開リポジトリにはリポジトリのプルリクエスト、非公開リポジトリには組織のプルリクエストを使用します。デフォルトは auto です

mcp

MCPサーバーをナレッジソースとして利用する設定です。 mcp 以下は、以下のキーがあります。

• usage
  MCPの利用方法を指定します。 auto 、 enabled 、 disabled のいずれかを指定します。デフォルトは auto です。 auto は、公開リポジトリとの連携は無効になります
• disabled_servers
  文字列の配列です。無効にするMCPサーバーのラベルを指定します（大文字小文字は区別しません）。指定されたサーバーはレビューおよびナレッジベースクエリから除外されます

linked_repositories

PR時にCodeRabbitが考慮すべき関連リポジトリの配列です。クロスリポジトリの依存関係を明らかにし、関連するコードベース間の破壊的変更を検出するために使用します。最大10件まで指定できます。各要素は以下のキーを持ちます。

• repository
  owner/repo 形式のリポジトリ名を指定します（例：GitHub: myorg/backend-api 、Azure DevOps: MyProject/backend-api 、GitLab: group/subgroup/repo 、Bitbucket: workspace/repo ）
• instructions
  リポジトリの内容や、レビュー時にCodeRabbitが考慮すべき点についての説明を指定します（最大2,000文字）。たとえば REST APIエンドポイントとデータベースモデルを含んでいます。 など

code_generation

code_generation 以下は、以下のキーがあります。

docstrings

docstrings 以下は、以下のキーがあります。

language

ドキュメンテーション文字列の言語を指定します。ISOコード形式で指定します。デフォルトは en-US です。

path_instructions

ドキュメンテーション文字列のパスに対する指示を指定します。path_instructions 以下は、以下のキーを持つ配列です。

• path
  ファイルパスのパターン。たとえば src/** や docs/** など。
• instructions
  20,000文字以下の文字列で、ドキュメンテーション文字列に対するガイドラインを詳細に指示します。

unit_tests

unit_tests 以下は、以下のキーがあります。

path_instructions

path_instructions 以下は、以下のキーを持つ配列です。

• path
  ファイルパスのパターン。たとえば src/** や tests/** など。
• instructions
  20,000文字以下の文字列で、ユニットテストに対するガイドラインを詳細に指示します。

issue_enrichment

Issue充実化の設定です。 issue_enrichment 以下は、以下のキーがあります。

auto_enrich

自動Issue充実化の設定です。 auto_enrich 以下は、以下のキーがあります。

enabled

Issueを追加コンテキスト（関連コード、潜在的な解決策、複雑さの評価）で自動的に充実化するかどうか設定します。デフォルトは false です。

planning

Issueプランニングの設定です。 planning 以下は、以下のキーがあります。

enabled

Issueの実装計画を生成するかどうか設定します（早期プレビュー）。デフォルトは true です。

auto_planning

ラベルに基づく自動プランニングの設定です。 auto_planning 以下は、以下のキーがあります。

• enabled
  自動プランニングを有効にするかどうか設定します。デフォルトは true です
• labels
  文字列の配列です。自動プランニングをトリガーするラベルを指定します。 ! で始まるラベルは否定マッチになります。たとえば ['feature', 'enhancement'] はいずれかのラベルがあるIssueに対してプランニングを実行し、 ['!wip'] は wip ラベル以外のすべてのIssueに対して実行します

labeling

Issueラベリングの設定です。 labeling 以下は、以下のキーがあります。

labeling_instructions

Issueラベルの提案指示は、以下の配列になります。各要素は以下のキーを持ちます。

• label
  提案するラベル名。たとえば enhancement など
• instructions
  ラベルの適用条件の指示です（最大3,000文字）。たとえば 新機能または機能リクエスト など

auto_apply_labels

提案されたラベルをIssueに自動的に適用するかどうか設定します。ラベリング指示なしで有効にすると、類似のIssueに基づいてラベルが自動提案されます。デフォルトは false です。

Tips

.coderabbit.yml を組織で共通化したい場合もあると思います。その場合には、URLを指定して共通化した設定も読み込めます。

.coderabbit.yml

remote_config:
  url: "https://your-config-location/.coderabbit.yaml"

設定例

coderabbitai/awesome-coderabbit: Official awesome-list of CodeRabbit Starters & Resources ⚡️にて公開されているCodeRabbitの設定例を参考にしてください。

.coderabbit.yml

# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json
language: "en-US"
early_access: false
tone_instructions: 'You are an expert code reviewer in Java, TypeScript, JavaScript, and NodeJS. You work in an enterprise software developer team, providing concise and clear code review advice. You only elaborate or provide detailed explanations when requested.'
reviews:
  profile: "chill"
  request_changes_workflow: false
  high_level_summary: true
  poem: true
  review_status: true
  collapse_walkthrough: false
  auto_review:
    enabled: true
    drafts: false
    base_branches: ["pg", "release"]
  path_instructions:
    - path: "app/client/cypress/**/**.*"
      instructions: |
        Review the following e2e test code written using the Cypress test library. Ensure that:
        - Follow best practices for Cypress code and e2e automation
        - Avoid using cy.wait in code
        - Avoid using cy.pause in code
        - Avoid using agHelper.sleep()
        - Use locator variables for locators
        - Use data-* attributes for selectors
        - Avoid Xpaths, Attributes and CSS path
        - Avoid selectors like .btn.submit
        - Perform logins via API
        - Avoid using it.only
        - Use multiple assertions
        - Avoid string assertions
        - Ensure unique filenames
chat:
  auto_reply: true

まとめ

CodeRabbitの設定は数多いですが、デフォルトで有効になっているものも多く、基本的にはそのままでも十分品質の高いレビューが得られるはずです。より見るべきポイントを指定したい場合や、組織のルールに合わせてカスタマイズしたい際の参考にしてください。

なお、設定は機能追加に合わせて変更される可能性があります。最新の情報は公式ドキュメントを参照してください。

Add a configuration file | CodeRabbit