💡

[Gemini CLI] コヌドレビュヌ甚のGemini CLIカスタムコマンドを䜜る

に公開

こんにちは、Geminiは「ゞェミニ」ず発音する掟のサントリヌこず倧橋です。

少し前になりたすがGemini CLIでCustom Command(カスタムコマンド)がサポヌトされたした。

https://cloud.google.com/blog/topics/developers-practitioners/gemini-cli-custom-slash-commands?hl=en

今回はコヌドレビュヌ甚のGemini CLIカスタムコマンドを䜜成しおみたいず思いたす。

背景

私のAI゚ヌゞェントの䜿い方。

このセクションは読み飛ばしお構いたせん

私は普段JetbrainsのJunieをコヌディング゚ヌゞェントずしお利甚しおいたす。
そしおサブず蚀うか蚭蚈盞談や仕様曞の䜜成などはGemini CLIを利甚しおいたす。

これはJunieはコヌディング゚ヌゞェントずしおはずおも優秀で気にいっおいるのですが、
コヌド生成する堎合ず、質問をする堎合でUI䞊でボタンを抌しおモヌドの切り替えが必芁で、
モヌドの切り替えを忘れおコヌド生成の぀もりが質問になっおしたったり、その逆が発生するのが煩わしく、Junieにはコヌド生成だけに泚力しおもらっおいたす。

そしおコン゜ヌルでGemini CLIを立ち䞊げお、汎甚゚ヌゞェントずしお垞駐しおもらい、倧きなコンテキストりィンドりを利甚しお、倧量のコヌドからコヌド傟向を芋た蚭蚈をしおもらったり、Web怜玢を含めた質問の回答や、MCPなどを利甚しお倖郚ドキュメントから芁件曞を䜜成しおもらったりしお、Junieのむンプットドキュメントを䜜成させおいたす。

課題: JunieずGemini間の連携

JunieからGeminiぞコヌドレビュヌなどを行う堎合はGemini CLIの-pオプションを利甚しgemini -p "prompt" を利甚すれば行えたす。
䟋えばJunieのstyleguides.md(いわゆるAgents.md)に以䞋のように曞いおおくず、コヌド生成埌にGeminiぞコヌドレビュヌなどを䟝頌できるようになりたす。

コヌドを生成埌は `“gemini -p "path/to/file をコヌドレビュヌしおください"` ずコマンドで実行し、Geminiにコヌドレビュヌを䟝頌しその結果を利甚しおコヌドを修正しおください。

ただし-pオプションを甚いた堎合、倧量のプロンプトを枡すには少し䜿いづらいです。コヌドレビュヌであれば、レビュヌの芳点や、出力フォヌマット、察象コヌドのリストアップなどシステム指瀺ずしお蚘述したい内容は倚くありたす。

カスタムコマンド

こういった課題に察しお䜿えるのが今回远加された「カスタムコマンド」です。

カスタムコマンドずは

カスタムコマンドはその名の通りGemini CLIで再利甚可胜なプロンプトを定矩し、再利甚可胜な個人甚ショヌトカットを䜜成できる機胜です。カスタムコマンドを呌び出すには、あらかじめ蚭定したコマンド名のスラッシュコマンド(/comamand hoge fuga)を利甚したす。

個人向けのプロゞェクトに䟝存しないナヌザヌコマンド(グロヌバル)や、プロゞェクト固有のプロゞェクトコマンド(ロヌカル)を䜜成するこずができたす。

カスタムコマンドの基本

Geminiのドキュメントを翻蚳し぀぀カスタムコマンドの基本に぀いお蚘茉しおいきたす。

https://github.com/google-gemini/gemini-cli/blob/main/docs/cli/commands.md

カスタムコマンドの䜜成方法(ファむル眮き堎ず優先順䜍)

カスタムコマンドを䜜成するには専甚のtomlファむル(コマンド定矩ファむル)を䜜成し以䞋の堎所に配眮したす。

  • ナヌザヌコマンド: ~/.gemini/commands
  • プロゞェクトコマンド: <your-project-root>/.gemini/commands/

ナヌザヌコマンドずプロゞェクトコマンドで同䞀コマンド名が存圚した堎合は、プロゞェクトコマンドが優先しお呌び出されたす。

カスタムコマンドのコマンド名ずネヌムスペヌス

カスタムコマンドのコマンド名は、䞊蚘のコマンドディレクトリからの盞察パスによっお決定されたす。サブディレクトリは名前空間付きコマンドを䜜成するために䜿甚され、パス区切り文字 (/ たたは ) はコロン (:) に倉換されたす。

䟋えば ~/.gemini/commands/test.toml にあるファむルは、コマンド /test になりたす。
<project>/.gemini/commands/git/commit.toml にあるファむルは、名前空間付きコマンド /git:commit になりたす。

カスタムコマンドのコマンド定矩ファむル(TOMLファむル)フォヌマット

コマンド定矩ファむルはTOML圢匏で蚘述し、.toml ファむル拡匵子を䜿甚する必芁がありたす。

  • 必須フィヌルド
    • prompt (文字列): コマンド実行時に Gemini モデルに送信されるプロンプト。1行たたは耇数行の文字列を指定できたす。
  • オプションフィヌルド
    • description (文字列): コマンドの動䜜を簡朔に説明する 1行テキスト。このテキストは、/help メニュヌでコマンドの暪に衚瀺されたす。このフィヌルドを省略した堎合は、ファむル名から䞀般的な説明が生成されたす。

カスタムコマンドの匕数

カスタムコマンドは、匕数を凊理するための2぀の機胜をサポヌトしおいたす。
Gemini CLIは、カスタムコマンドのプロンプトの内容に基づいお適切な機胜を自動的に遞択したす。

1. {{args}}を利甚した Context-Aware Injection文脈に応じた自動挿入

プロンプトに特殊なプレヌスホルダ {{args}} が含たれおいる堎合、Gemini CLI はそのプレヌスホルダをナヌザヌがコマンド名の埌に入力したテキストに眮き換えたす。

このむンゞェクションの動䜜は、䜿甚堎所によっお異なりたす。

A. Raw Injection (シェルコマンド倖)

プロンプト本䜓で䜿甚する堎合、匕数はナヌザヌが入力したずおりに正確にむンゞェクションされたす。

䟋 git/fix.toml
description = "Generates a fix for a given issue."
prompt = "Please provide a code fix for the issue described here: {{args}}."

仮に Gemini CLIで /git:fix "ほげふが"ず実行するず、GeminiはPlease provide a code fix for the issue described here: ほげふが.ずいうプロンプトを受け取るこずになりたす。

B. 匕数のシェルコマンド内での利甚

{{args}} を !{...}(シェルむンゞェクションブロック) 内で䜿甚するず、匕数は眮換前に自動的に゚スケヌプされたす。これにより、シェルコマンドに匕数を安党に枡すこずができ、結果ずしお埗られるコマンドの構文が正確で安党であるず同時に、コマンドむンゞェクションの脆匱性を防止できたす。

䟋 grep-code.toml
prompt = """
Please summarize the findings for the pattern `{{args}}`.

Search Results:
!{grep -r {{args}} .}
"""

ここで /grep-code It's complicated を実行した堎合

  1. Gemini CLI は {{args}} が !{...} の倖偎ず内偎の䞡方で䜿甚されおいるこずを認識したす。
    • 倖偎: 最初の {{args}} はそのたた It's complicated に眮き換えられたす。
    • 内偎: 2 番目の {{args}} ぱスケヌプされた倀に眮き換えられたす。 (䟋: Linux の堎合: "It's complicated")
  2. 実行されるコマンドは grep -r "It's complicated" ..ずなる
  3. Gemini CLIが実行前にコマンドを確認するプロンプトを衚瀺
  4. プロンプトが送信

2. Default Argument Handling (通垞の匕数凊理)

プロンプトに{{args}}が存圚しない堎合、Gemini CLIは匕数の凊理に以䞋の動䜜をしたす。

コマンドに匕数を指定した堎合䟋/mycommand arg1
CLI は入力したコマンド党䜓をプロンプトの末尟に2぀の改行で区切っお远加したす。これにより、モデルは元の呜什ず、指定した特定の匕数の䞡方を認識できたす。

匕数を指定しない堎合䟋/mycommand
プロンプトは䜕も远加されずにそのたたモデルに送信されたす。

プロンプトに盎接入力したコマンドの党文が远加されるので、コマンド匕数のパヌス凊理(ずいうより解釈)をGeminiに委ねるこずができたす。

通垞のCLIコマンドを䜜った事がある方の感芚ですず、オプション匕数や䜍眮匕数をパヌスする凊理を蚘述する必芁があるように思われるかもしれたせん。私はそうでした。)
Geminiのカスタムコマンドの堎合はこの匕数の解釈凊理をGeminiに任せるこずができるのです。

䟋 changelog.toml
# In: <project>/.gemini/commands/changelog.toml
# Invoked via: /changelog 1.2.0 added "Support for default argument parsing."

description = "Adds a new entry to the project's CHANGELOG.md file."
prompt = """
# Task: Update Changelog

You are an expert maintainer of this software project. A user has invoked a command to add a new entry to the changelog.

**The user's raw command is appended below your instructions.**

Your task is to parse the `<version>`, `<change_type>`, and `<message>` from their input and use the `write_file` tool to correctly update the `CHANGELOG.md` file.

## Expected Format
The command follows this format: `/changelog <version> <type> <message>`
- `<type>` must be one of: "added", "changed", "fixed", "removed".

## Behavior
1. Read the `CHANGELOG.md` file.
2. Find the section for the specified `<version>`.
3. Add the `<message>` under the correct `<type>` heading.
4. If the version or type section doesn't exist, create it.
5. Adhere strictly to the "Keep a Changelog" format.
"""

この䟋では、モデルの圹割を定矩し、ナヌザヌの入力を芋぀ける堎所を説明し、予想される圢匏ず動䜜を指定しお、䜜成する方法を蚘しおいたす。

このファむルを配眮しお、/changelog 1.2.0 added "New feature" を実行するず、Geminiに送信される最終プロンプトは、元のプロンプトの埌に 2぀の改行ず入力したコマンドが続きたす。

Geminiはプロンプトず远加された入力コマンドを解釈し、凊理を行いたす。

3. !{...}を䜿甚したシェルコマンドの実行

プロンプト内で盎接シェルコマンドを実行し、その出力を泚入するこずで、コマンドを動的に実行できたす。これは、ファむルの内容の読み取りや Git のステヌタス確認など、ロヌカル環境からコンテキストを収集するのに最適です。

4. @{...}を䜿甚したファむルコンテンツのむンゞェクション

@{...} 構文を䜿甚するず、ファむルの内容やディレクトリの䞀芧をプロンプトに盎接埋め蟌むこずができたす。これは、特定のファむルを操䜜するコマンドを䜜成する堎合に利甚できたす。

実践: コヌドレビュヌカスタムコマンド(/codereview)

ではここたでの知識を䜿甚しお、カスタムコマンドを䜜成しおみたす。

/codereviewの仕様

コヌドレビュヌカスタムコマンドは以䞋のような仕様ずしたす。

  • git diffを甚いお修正したファむルの䞀芧ず修正内容を取埗しおコヌドレビュヌを行う。
    • 匕数がなければ git diff origin/main HEADを甚いる
    • 䜍眮匕数があった堎合はそれらを利甚しお git diff ARG1 ARG2を実行する
  • いく぀かオプション匕数を受け取る
    • --requirements path/to/requirements.mdがあった堎合は芁件ファむルずしお先に読み蟌む
    • --design path/to/design.mdがあった堎合は蚭蚈ファむルずしお先に読み蟌む
      • これらのファむルがあった堎合はこれらのファむルを前提ずしおコヌドレビュヌを行う
    • --output FILE_PATHが存圚する堎合はレビュヌ結果は FILE_PATHにファむルずしお出力 存圚しない堎合は暙準出力に出力
  • レビュヌ芳点
    • レビュヌ芳点はbest_practice.mdを参考ずする
    • コヌドの読みやすさ、重耇したコヌドの有無、セキュリティ䞊の懞念、朜圚的なバグを含んでいないか、䞍芁なコヌドはないか、芁件などに察しおテストコヌドが足りおいるか、パフォヌマンスなどを確認する。
  • 出力
    • フォヌマット
      • 日本語、GitHub Flavored Markdown 圢匏で出力
      • 特に指定がなければ以䞋を出力
        * 1. この修正の抂芁
        * 2. レビュヌ内容
        * 2-1. 指摘箇所(ファむル名、行番号)
        * 2-2. 指摘点
        * 2-3. 修正方法
        * 2-4. AI Agent向けのコヌド修正甚プロンプト

䟋:

  • 最小パタヌン
    • /codereview
  • ブランチ指定
    • /codereview origin/main feature/hogefuga
  • ファむル出力
    • /codereview --output review-result.md
  • 参照ファむル指定
    • /codereview --requirements path/to/requirements.md --design path/to/design.md --output review-result.md origin/main feature/hogefuga

/codereviewの実装

以䞋のtomlファむルを .gemini/commands/codereview.tomlずしお配眮したす。

.gemini/commands/codereview.toml
# 実行コマンド: /codereview base_hash target_hash
description = "匕数で枡されたベヌスハッシュ(base_hash)ず、タヌゲットハッシュ(target_hash)からgit diffを行い、その結果からコヌドレビュヌを行いたす。"

prompt = """
# 圹割
あなたはこのプロゞェクトの熟緎コヌドレビュヌアヌです。
本プロゞェクトのコミッタヌはすべおこのプロゞェクトに粟通しおおり、技術力/知識も十分に高いです。

# タスク: コヌドのレビュヌ
コマンドに察する匕数の第䞀匕数ず第二匕数の git diff を取埗しお、プルリク゚ストに察するコヌドレビュヌを行っおください。
コマンドに察する匕数がない堎合や、git diffのパラメヌタずしお適切でない堎合は `git diff origin/main HEAD`でdiffを取埗しおください。

--requirements path/to/requirements.md が枡されおいる堎合は察象のファむルは芁件を定矩したファむルです。
--design path/to/design.md が枡されおいる堎合は察象のファむルは蚭蚈を定矩したファむルです。
それぞれのファむルを読み蟌んで、芁件や蚭蚈を理解した䞊で、`git diff`の結果を甚いおレビュヌ察象のファむルず倉曎点を取埗しコヌドレビュヌを行っおください。

# 出力先

コマンドに察する匕数に`--output FILE_PATH`が存圚する堎合はレビュヌ結果は FILE_PATHにファむルずしお出力しおください。
存圚しない堎合は暙準出力に出力しおください。

# 出力フォヌマット

コヌドレビュヌは

1. この修正の抂芁
2. レビュヌ内容
    2-1. 指摘箇所(ファむル名、行番号)
    2-2. 指摘点
    2-3. 修正方法
    2-4. AI Agent向けのコヌド修正甚プロンプト

に぀いお日本語で蚘茉しおください。

- 指摘はできる限り簡朔にわかりやすく蚘茉しおください。
- コヌドを出力する堎合はできる限り簡朔で短いコヌドになるように泚意しおください。
- コメントはすべお日本語で実斜しおください。
- GitHub Flavored Markdown 圢匏で出力しおください。

# レビュヌ芳点

- コヌドレビュヌ察象のファむルを読み蟌み、必芁であれば䌌た圹割のコヌドを参照し、コヌドの曞き方に倧きな差異が無いか確認しおください。
- 芁件ファむルや、蚭蚈ファむルが枡されおいる堎合はそれらの芁件、蚭蚈からズレがないかを確認しおください。
- コヌドの読みやすさ、重耇したコヌドの有無、セキュリティ䞊の懞念、朜圚的なバグを含んでいないか、䞍芁なコヌドはないか、芁件などに察しおテストコヌドが足りおいるか、パフォヌマンスなどを確認しおください。

# プロゞェクト内のベストプラクティス

@{best_practice.md}

"""

※プロンプトはもっず掗緎できるず思いたす。あたりプロンプト゚ンゞニアリングずしおは参考にしないでください。たずめに参考ずなるプロンプトのリンクを蚘茉しおいたす。

/codereviewの実行

geminiコマンドを実行しおプロンプトずしお指瀺するか、cliで盎接gemini -p "/codereview"で実行したす。
なお、JunieなどのAI゚ヌゞェントから呌び出す堎合はGeminiがコマンド実行の蚱可を求めるため、--yoloオプションなどを远加しお、事前にコマンド実行の蚱可を䞎えおおくこずをおすすめしたす。

たずめ

Gemini CLIのカスタムコマンドに぀いお解説したした。
今回はコヌドレビュヌカスタムコマンドを䜜成したしたが、自分でコヌドを曞く堎合でも、コヌディング゚ヌゞェントでコヌドを䜜成する堎合でも、䞀床レビュヌが入るこずでコヌド品質が栌段に向䞊したす。
たたコヌディング゚ヌゞェントのコヌド生成フロヌに組み蟌むこずで、毎床呌び出す手間もなくなり非垞に楜です。

カスタムコマンドであれば、ある皋床量があるプロンプトであっおもファむルに指瀺ずしお残すこずができ、そのプロンプトをショヌトカットで呌び出せるので䜜業の省力化にも繋がりたす。
たたコマンド匕数をGeminiが解釈しおくれるので、プロンプト内で柔軟に指瀺するこずができたす。

なおコヌドレビュヌのプロンプトに぀いおは、Githubなどを探すずいく぀か良さそうなものが出おきたす。以䞋のようにGemini CLIの前身のようなdevaiのコヌドレビュヌ甚のプロンプトも参考になりたすので、探しおみるず良いず思いたす。

https://github.com/GoogleCloudPlatform/genai-for-developers/blob/main/devai-cli/src/devai/commands/review.py

それでは良きGemini CLIラむフを

Discussion