heydeer
始める

HeyDeer CLI

プルリクエストを作成する前に、ブランチとコミット前の変更をターミナルからレビューできます。HeyDeer CLI は作業している場所に指摘事項を表示し、コーディングエージェントからも実行できます。

インストールとサインイン

CLI には Node.js 22 以降、HeyDeer をインストールした GitHub 上のリポジトリ、そのリポジトリへの書き込み権限が必要です。

npm install -g heydeer
heydeer login

heydeer login はリンクとコードを表示します。リンクを開き、GitHub で HeyDeer にサインインしてコードを入力してください。ページにはサインインの要求元が表示されるので、許可する前に自分のコンピューターかどうか確認してください。

コマンド動作
heydeer loginこのコンピューターで HeyDeer にサインインします。
heydeer statusCLI がどのユーザーとして動作しているかを表示します。
heydeer logoutこのコンピューターでサインアウトします。
heydeer --versionインストールされている CLI のバージョンを表示します。

CLI はサインイン情報を ~/.config/heydeer/credentials.json(Windows では %APPDATA%\heydeer)に保存します。サインインは最後に使ってから 30 日間、最長 90 日間有効です。期限が切れたら heydeer login を再度実行してください。

変更をレビューする

リポジトリ内でレビューを実行し、変更の目的を一文で添えます。

heydeer review "Retry failed uploads. Fixes #123."

HeyDeer は、ブランチのコミットと追跡中のファイルのコミット前の変更を、origin のデフォルトブランチとのマージベースと比べてレビューします。説明はプルリクエストの説明と同じように読み、記載された Issue も含めてコードと照らし合わせます。説明が長い場合はファイルに書き、--description-file で渡してください。

CLI はリポジトリ、ベース、ブランチ、レビューの深さを表示し、送信するファイルを一覧にして、レビューの進行状況を追います。レビューが終わると、各指摘事項を重大度、ファイル、行とともに表示します。

オプション

オプション動作
--description-file <path>説明をコマンドラインではなくファイルから読み込みます。
--base <ref>別のブランチやコミットを比較対象にします。それを対象とする作業に使います。
--include-untrackedまだ Git に追加していない新しいファイルもレビューします。gitignore で除外されたものは除きます。
--depth standard|deepこのレビューだけ、リポジトリとは別のレビューの深さで実行します。詳細は有料プランで利用できます。
--fullブランチの前回のレビュー以降の変更だけでなく、すべての変更をレビューします。
--dry-run送信されるファイルと手元に残るファイルを一覧表示します。サインインもレビューの開始も行いません。
--json完了したレビューを JSON で出力します。スクリプトやコーディングエージェント向けです。

手元に残るもの

コンピューターから送られるのは、マージベースからの差分と説明だけです。残りのコードは HeyDeer が GitHub から読み込みます。CLI は次のファイルをレビューから除外し、Left on this machine に一覧表示します。

  • .env ファイルや秘密鍵などの認証情報ファイル。
  • 既知の形式の認証情報を含む変更。
  • バイナリファイル。
  • 1 ファイルあたり 1 MB を超える変更。

すべての変更の合計は、差分で最大 32 MB です。それを超える場合は、より近い --base を指定するか、プルリクエストでレビューしてください。--dry-run を実行すると、送信前に正確な一覧を確認できます。

修正したらもう一度実行する

ブランチをレビューするたびに、前回のレビューで未解決だった指摘事項を再確認します。次の実行で、修正によってどれが解決したかがわかります。

リポジトリで新しい変更のみレビューがオンの場合、ブランチの次回以降のレビューは前回の完全なレビュー以降の変更だけを対象にします。それが 3 回続くか、変更の大半がそのレビュー以降の新しいものになると、次のレビューはすべての変更を対象にします。--full を渡せば、いつでもすべてをレビューできます。前回のレビューから何も変わっていなければ、CLI はそう伝えてレビューを開始しません。

スクリプトやコーディングエージェントから使う

--json を付けると、完了したレビューは 1 つの JSON オブジェクトとして標準出力に、進行状況は標準エラーに出力されます。各指摘事項には重大度、タイトル、ファイルと行、説明の本文が含まれます。

Claude Code、Codex、Cursor にプルリクエストを作成する前に自分の作業をレビューさせるには、AGENTS.md に次のような指示を追加します。

Before opening a pull request, run `heydeer review --json "<what the change does>"`
from the repository root, fix the findings you agree with, and run it again.

CLI は次のいずれかのコードで終了します。

終了コード意味
0レビューが完了しました(指摘事項の有無は問いません)。
1レビューが失敗したか、変更したファイルがすべて手元に残る必要がありました。
2コマンドまたはオプションが正しくありません。
130Ctrl+C でキャンセルしました。

完了したレビューは指摘事項の有無にかかわらず 0 で終了します。ブランチの準備ができているかは JSON の指摘事項を読んで判断してください。

クレジット

ローカルのレビューは、そのリポジトリを対象とするインストールのワークスペースのクレジットを使い、どのリポジトリでも非公開コードとして課金されます。ドライランと、前回のレビューから何も変わっていない実行では、クレジットを使いません。ローカルのレビューは 1 人あたり 1 時間に 30 回まで開始できます。Ctrl+C を押すと HeyDeer 側のレビューもキャンセルされ、2 回押すと CLI がすぐに止まります。