CodeRabbit CLI の使い方

CodeRabbit とは、コードレビュー専門の AI です。
GitHub と連携しリポジトリ上で使う方法もありますが、今回は CLI 経由での使い方を試しました。
使用されているAI のモデルは公開されていませんが、要約にはシンプルなモデルを、複雑な箇所で高性能なモデルが使われているようです。

CodeRabbitでは、要約にはシンプルなモデルを使用し、複雑なコードレビューには高性能なモデルを適用する、マルチモデル戦略を採用しました。

https://www.coderabbit.ai/ja/blog/coderabbit-deep-dive-ja?utm_source=chatgpt.com

インストール

公式サイトの記載通り、以下のコマンドを実行することでインストール可能です。

curl -fsSL https://cli.coderabbit.ai/install.sh | sh

https://www.coderabbit.ai/ja/cli

インストール後cr auth loginを実行することで認証が完了します。

使い方

シンプルな使い方は以下のように cr / coderabbit と入力してください。

cr
coderabbit

実行すると画像のように main ブランチとの差分が表示されます。(<repository>に現在のリポジトリ名が、<branch>に現在のブランチ名が表示されます。)
GitHub 連携を行なっていないので、ローカルの main ブランチとの差分が表示されていることに注意が必要ですが、正しく表示されていることがわかります。

t を入力するとファイルツリー形式で確認できます。

Enter を入力すると分析が開始されます。

特に指摘事項がない場合は以下のように表示されます。

レビューがある場合は以下のように表示されます。

ファイル名を選択し、Enterを入力するとレビュー箇所が表示されもう一度選択するとその詳細が表示されます。

画像のように、修正内容とAIに渡すためのプロンプトが表示されています。
ただし、AIとの併用を考えるとプロンプトのみを渡し、修正内容はより多くの情報を扱えるAIエージェントに考えさせる方が適任なはずです。
具体的な方法は以降で説明します。

crとcr reviewの違い

crコマンドを実行した場合、特殊なオプション(auth, update)をつけない限りはcr reviewが呼び出されているようですが、-hをオプションとして呼び出した際の挙動が少し異なります。reviewのオプションを確認したくなることがあるため、自分はreviewのオプションの説明が記載されているヘルプの表示されるcr reviewを使うようにしています。

❯ cr -h
Usage: coderabbit [options] [command]

CodeRabbit CLI for code review

Options:
  -h, --help        display help for command

Commands:
  auth              Authentication commands
  review [options]  AI-driven code reviews with interactive or plain text output (default)
  update            Update CodeRabbit CLI to the latest version
  help [command]    display help for command

❯ cr review -h
Usage: coderabbit review [options]

AI-driven code reviews with interactive or plain text output (default)

Options:
  -V, --version            output the version number
  --plain                  Output in plain text format (non-interactive)
  --prompt-only            Show only AI agent prompts (implies --plain)
  -t, --type <type>        Review type: all, committed, uncommitted (default: "all")
  -c, --config <files...>  Additional instructions for CodeRabbit AI (e.g., claude.md, coderabbit.yaml)
  --base <branch>          Base branch for comparison
  --base-commit <commit>   Base commit on current branch for comparison
  --cwd <path>             Working directory path
  --no-color               Disable colored output
  -h, --help               display help for command

AI との併用

プロンプトのみを実行する場合は以下のコマンドを実行します。

# AI ツールに渡す場合
cr review --prompt-only

実行結果としては以下のような表示がされます。
直接AIにコマンドを実行させることで、より強固なものになるはずです。
また、レビューの見やすさもこちらの方が一覧で出されるため私自身が呼び出す際もこのオプションをつけるようにしています。

オプション

以下のようにオプションをつけることでより詳細を設定することが可能です。

# 比較先のブランチの指定
cr review --base <branch-name>

# 特定のコミットと比較
cr review --base-commit <commit>

# コミット済み・コミット前に絞って比較
cr review --type <type>

指定内容が正しいかどうかは--prompt-onlyオプションを外すことで確認できるので、実行前に確認すると良いでしょう。