coderabbit

CodeRabbit

プルリクエストとローカルの変更を対象とした、AI を活用したコードレビューです。

クイックナビゲーション

タスク	参照
CLI のインストールと実行	cli-usage.md
.coderabbit.yaml の設定	configuration.md
サポート対象のツール（40 以上のリンター）	tools.md
Git プラットフォームの設定	platforms.md
PR コマンド（@coderabbitai）	pr-commands.md
Claude/Cursor/Codex のワークフロー	agent-integration.md
指摘事項のトリアージ	triage.md
個別の問題を修正	fix.md
レポートとメトリクス	end-to-end-workflow.md
エンドツーエンドのワークフロー	end-to-end-workflow.md
Windows/WSL の設定	windows-wsl.md

前提条件の確認（レビュー前に必ず実行）

CodeRabbit CLI を実行する前に、以下のすべてを確認してください。

# 1. CLI installed?
which coderabbit || echo "MISSING: install with: curl -fsSL https://cli.coderabbit.ai/install.sh | sh"

# 2. Authenticated?
coderabbit auth status 2>&1 | grep -q "Logged in" || echo "MISSING: run coderabbit auth login"

# 3. Git repo has at least one commit? (CRITICAL — CLI crashes with GitError on empty repos)
git rev-parse HEAD >/dev/null 2>&1 || echo "MISSING: repo has no commits — make at least one commit first"

# 4. Base branch exists? (CLI defaults to 'main')
git rev-parse main >/dev/null 2>&1 || echo "WARNING: 'main' branch not found — use --base <branch>"

確認に失敗した場合は、レビューを実行する前に問題を修正してください。状態が不完全なまま先に進まないでください。

認証に失敗した場合のルール： 認証確認（ステップ 2）に失敗した場合、エージェントは必ず以下を実行してください。

1. ただちに停止します。レビューを実行しようとしないでください。
2. CodeRabbit CLI が認証されていないことをユーザーに通知します。
3. 認証するための正確なコマンドをユーザーに提示します：coderabbit auth login
4. ユーザーが認証を完了するまで待ってから、再試行します。
5. ユーザーに代わって coderabbit auth login を実行しないでください。このコマンドにはブラウザーでのリダイレクト操作が必要です。

クイックスタート

レビューを実行

# AI agent workflow (most common) — note: 'review' subcommand is optional
coderabbit review --prompt-only --type uncommitted --no-color

# If base branch is not 'main' (e.g., master, develop):
coderabbit review --prompt-only --type uncommitted --base master --no-color

# Plain text output (human-readable)
coderabbit review --plain --type uncommitted --no-color

ローカルキャプチャスクリプト

後で分析できるよう、出力をファイルに保存します。

# IMPORTANT: use absolute path to the skill's script directory
python3 ~/.claude/skills/coderabbit/scripts/run_coderabbit.py --output coderabbit-report.txt

オプション：

• 別のファイル名を指定するには --output を使用します（リポジトリのルートにある .code-review/ に保存されます）。
• タイムアウトを秒単位で調整するには --timeout を使用します（デフォルト：1800）。
• ベースブランチを指定するには --base を使用します（デフォルト：Git から自動検出）。

PR コマンド

@coderabbitai review          # Incremental review
@coderabbitai full review     # Complete review
@coderabbitai simplify        # Apply targeted simplifications to changed files
@coderabbitai fix merge conflict  # Attempt automatic merge-conflict resolution
@coderabbitai pause           # Stop auto-reviews
@coderabbitai resume          # Resume auto-reviews
@coderabbitai resolve         # Mark comments resolved

重要度マトリクス

重要度	対応	例
CRITICAL	ただちに修正	セキュリティ、データ損失、テナントの分離
HIGH	修正するべき	信頼性、パフォーマンス、アーキテクチャ違反
MEDIUM	状況に応じて判断	保守性、型安全性（手軽に改善できる点）
LOW	スキップ	スタイル／書式、主観的な細かな指摘

AI エージェントのワークフローパターン

Implement [feature] and then run CodeRabbit CLI in a background terminal.
Wait for it to complete, then read the report. Fix CRITICAL/HIGH issues. Ignore nits.

手順：

1. 前提条件を確認します（上記を参照）。先に進む前に問題を修正してください。
2. ベースブランチを検出します：git symbolic-ref refs/remotes/origin/HEAD 2>/dev/null。取得できない場合は main／master を使用します。
3. CLI をバックグラウンドで実行します：coderabbit review --prompt-only --type uncommitted --base <branch> --no-color
4. レビューには 7～30 分以上かかります。バックグラウンドで実行します（run_in_background=true）。
5. プロセスが完了したら、出力を読み取ります。
6. CRITICAL/HIGH の指摘を修正し、LOW はスキップします。
7. レビューの反復は最大 2～3 回に制限します。

トラブルシューティング

詳細なしで [error] stopping cli が表示される

実際のエラーを確認するには、DEBUG=* を指定して実行します。

DEBUG=* coderabbit review --prompt-only --type uncommitted 2>&1 | grep -E "(ERROR|error|GitError)"

ログファイルを確認します。

ls -t ~/.coderabbit/logs/ | head -1 | xargs -I{} cat ~/.coderabbit/logs/{}

よくあるエラー

エラー	原因	修正
GitError（詳細なし）	リポジトリにコミットがない	少なくとも1つコミットしてください
Failed to get commit SHA for branch main	ベースブランチが存在しない	--base master または --base <your-branch> を使用してください
Raw mode is not supported	非 TTY 環境での対話モード	常に --prompt-only または --plain を使用してください
認証後に [error] stopping cli	トークンの有効期限切れ	coderabbit auth login を再実行してください
CLI が応答しない／出力がない	変更セットが大きい	範囲を限定するために --type uncommitted を使用してください

認証ステータスを確認する

coderabbit auth status

リンク済みリポジトリ（2026-02-18）

CodeRabbit は、PR レビュー中にリンク済みリポジトリを分析し、リポジトリ間の破損（API／型／依存関係のずれ）を検出できます。

• ナレッジベースの設定でリンク済みリポジトリを設定します。
• 2026-03-11 時点で、Pro プランではマルチリポジトリ分析用に最大 2 件のリポジトリをリンクできます。
• あるリポジトリの変更が別のリポジトリのコントラクトに影響する場合に使用します。
• リポジトリ間の指摘が実行時の互換性の問題を示している場合は、重要度を HIGH／CRITICAL として扱ってください。

ダッシュボードとレポート（2026-03-12）

• ダッシュボードの指標が、Git プラットフォームのレビューとIDE／CLI のレビューに分けられるようになりました。
• レポート機能には、ナレッジベース、マージ前チェック、レポートなどの Git プラットフォームのページに加え、概要、組織の傾向、データ指標などの IDE／CLI のページが含まれます。
• ダッシュボード全体でチームフィルターを利用できます。レビューの件数や指摘をリポジトリ単位ではなくチーム単位で分ける必要がある場合に使用してください。

コードの簡素化（オープンベータ、Pro）（2026-03-13）

• @coderabbitai simplify は、PR で変更されたファイルに対してエージェントによるクリーンアップを実行します。
• 動作を維持しながら、再利用可能なヘルパーの抽出、条件分岐の簡素化、冗長なコードの削除を行います。
• CodeRabbit は、リポジトリに既存のテストスイートで結果を検証し、フォローアップ PR を作成するか、ブランチに直接コミットできます。
• フォーク PR の直接コミットモードでは利用できません。

チャットアクセス制御（GitHub Orgs）（2026-03-16）

• PR コメントのチャットを組織メンバーのみに制限する必要がある場合は、.coderabbit.yaml で chat.allow_non_org_members: false を使用します。
• これはコメントスレッドでのやり取りのみに適用され、自動 PR レビューの動作は変わりません。
• デフォルトは引き続き true です。そのため、オプトアウトしない限り、公開リポジトリのチャットは開放されています。

マージコンフリクトの解決（オープンベータ、Pro）（2026-03-17）

• CodeRabbit は、PR レビュー中にマージコンフリクトを検出し、ワンクリックまたはコメントによる解決を提案できます。
• @coderabbitai fix merge conflict または GitHub の Walkthrough チェックボックスで実行します。
• 成功すると適切なマージコミットを作成しますが、解決が曖昧な場合や、認証、暗号化、シークレット、アクセス制御などのセキュリティ上重要なロジックに関わる場合は、処理を辞退します。
• コンフリクトのあるファイルが1つでも辞退された場合、自動解決は全体が中止され、部分的なコミットは作成されません。

Betterleaks（Gitleaks に代わるもの）（2026-03-19）

• シークレットスキャンでは Betterleaks を使用するようになりました（Gitleaks より検出性能が向上しています）。
• .coderabbit.yaml の gitleaks 設定キーで Betterleaks を制御します。
• デフォルトでは引き続き有効で、既存のシークレットスキャンは変更なしで継続されます。

低品質コードの検出（2026-03-24）

• 公開 GitHub リポジトリで、品質の低い AI 生成 PR を自動的に検出します。
• PR の Walkthrough コメントでフラグが付けられます。
• オプトインのラベル付け：

reviews:
  slop_detection:
    enabled: true # default
    label: "slop" # optional label

Bitbucket Data Center（2026-03-24）

• Git プラットフォームとして Bitbucket Data Center を完全にサポートします。
• OAuth 2.0、自動 Webhook 設定、完全な PR レビュー機能に対応します。

監査ログ（2026-03-25）

• ワークスペース全体のすべての管理操作について、改ざん耐性のある監査ログを記録します。
• シートの割り当て／削除、ロールの変更、組織／リポジトリの変更、サブスクリプションイベント、設定の更新、API キーの操作を対象とします。
• 設定 UI または REST API からアクセスでき、自動エクスポートにも対応しています。

CLI エージェントモード（2026-03-31）

• coderabbit review --agent は、Skills やエージェントとの統合向けに、結果を構造化 JSON 形式で出力します。

CLI 0.4.x（2026-04-01 ～ 2026-04-06）

• coderabbit auth login はブラウザー内で完了します。
• --agent は、エージェント環境向けの認証関連ワークフローにさらに対応しました。
• サブディレクトリを対象としたレビューでは、--cwd の代わりに --dir を使用します。
• ローカルレビューのテレメトリーに coderabbit stats を使用できます。

GitLab SSH アクセス（2026-04-02）

• セルフマネージド GitLab では、HTTPS の代わりに SSH クローン用の認証情報を使用できます。
• これは、GitLab インスタンスが HTTPS によるクローンを提供していない場合や、SSH のみのリポジトリアクセスを強制している場合に役立ちます。

Codex プラグイン（2026-04-14）

• CodeRabbit は、スタンドアロン CLI に加えて、専用の Codex プラグインとしても利用できます。
• このプラグインは CLI のインストールと認証を確認し、自然言語または @coderabbit からレビューを開始します。また、指摘事項をエージェントのループ内に保持して、後続の修正に活用できます。

グローバルオーバーライド（2026-04-16）

• 組織の管理者は、すべてのリポジトリに最優先の設定オーバーライドを適用できます。
• ネストされたオブジェクトは下位レイヤーとマージされ、配列とスカラー値は下位レイヤーの値を置き換えます。

カスタム仕上げレシピ（早期アクセス）（2026-02-23）

再利用可能な名前付きの「仕上げ」レシピを定義して、エージェントによるコード変更を PR に適用できます。

最小限の例については、configuration.md をご覧ください。

最小構成

# .coderabbit.yaml
language: en-US
reviews:
  profile: chill
  high_level_summary: true
  tools:
    gitleaks:
      enabled: true
    ruff:
      enabled: true

重要な禁止事項

• 本番コードにフォールバック、モック、スタブを追加しないでください
• CodeRabbit が指摘した範囲を超えて対応範囲を広げないでください
• フォーマッター／リンターが処理するスタイル上の軽微な指摘を修正しないでください
• CRITICAL の指摘を無視しないでください。不明な場合はエスカレーションしてください
• コードを修正する前に、CLI のエラー（認証／ネットワーク）を解消してください
• コミットがないリポジトリで CLI を実行しないでください。実行すると、エラーが表示されないままクラッシュします

リンク

• ドキュメント
• 変更履歴
• GitHub
• スキーマ

テンプレート

• coderabbit.minimal.yaml — 最小構成
• coderabbit.full.yaml — すべてのオプションを含む完全な例
• agent-prompts.md — すぐに使える AI エージェント向けプロンプト