run-gemini-cli

概要

run-gemini-cli は、[Gemini CLI] を介して [Gemini] を開発ワークフローに統合する GitHub Action です。これは、重要なルーチンコーディングタスクのための自律エージェントとして、また、迅速に作業を委任できるオンデマンドのコラボレーターとして機能します。

これを使用して、GitHub プルリクエストのレビュー、イシューのトリアージ、コード分析と修正などを、[Gemini] と会話形式 (例: @gemini-cli fix this issue) で GitHub リポジトリ内で直接実行できます。

• run-gemini-cli
  • 概要
  • 特徴
  • クイックスタート
    • 1. Gemini API キーを取得する
    • 2. GitHub シークレットとして追加する
    • 3. .gitignore を更新する
    • 4. ワークフローを選択する
    • 5. 試してみる！
  • ワークフロー
    • Gemini Dispatch
    • Issue Triage
    • Pull Request Review
    • Gemini CLI Assistant
  • 設定
    • 入力
    • 出力
    • リポジトリ変数
    • シークレット
  • 認証
    • Google 認証
    • GitHub 認証
  • 可観測性
  • 拡張機能
  • ベストプラクティス
  • カスタマイズ
  • 貢献

特徴

• 自動化: イベント (例: イシューのオープン) やスケジュール (例: 夜間) に基づいてワークフローをトリガーします。
• オンデマンドコラボレーション: [Gemini CLI] に言及することで、イシューやプルリクエストのコメントからワークフローをトリガーします (例: @gemini-cli /review)。
• ツールによる拡張性: [Gemini] モデルのツール呼び出し機能を活用して、[GitHub CLI] (gh) などの他の CLI と対話できます。
• カスタマイズ可能: リポジトリ内の GEMINI.md ファイルを使用して、[Gemini CLI] にプロジェクト固有の指示とコンテキストを提供します。

クイックスタート

わずか数分でリポジトリに Gemini CLI を使い始められます。

1. Gemini API キーを取得する

[Google AI Studio] から API キーを取得します。無料枠が充実しています。

2. GitHub シークレットとして追加する

API キーを GEMINI_API_KEY という名前のシークレットとしてリポジトリに保存します。

• リポジトリの Settings > Secrets and variables > Actions に移動します。
• New repository secret をクリックします。
• Name: GEMINI_API_KEY、Value: ご自身の API キー

3. .gitignore を更新する

.gitignore ファイルに次のエントリを追加します。

# gemini-cli settings
.gemini/

# GitHub App credentials
gha-creds-*.json

4. ワークフローを選択する

ワークフローをセットアップするには、2 つのオプションがあります。

オプション A: セットアップコマンドを使用する (推奨)

1. ターミナルで Gemini CLI を起動します。

   gemini
   

2. ターミナルの Gemini CLI で、次のように入力します。

   /setup-github
   

オプション B: ワークフローを手動でコピーする

1. 事前構築済みのワークフローを examples/workflows ディレクトリから、リポジトリの .github/workflows ディレクトリにコピーします。注: gemini-dispatch.yml ワークフローもコピーする必要があります。これにより、ワークフローを実行するためのトリガーが設定されます。

5. 試してみる！

プルリクエストレビュー:

• リポジトリでプルリクエストを開き、自動レビューを待ちます。
• 既存のプルリクエストに @gemini-cli /review とコメントすると、手動でレビューをトリガーできます。

イシュートリアージ:

• イシューを開き、自動トリアージを待ちます。
• 既存のイシューに @gemini-cli /triage とコメントすると、手動でトリアージをトリガーできます。

一般的な AI アシスタンス:

• 任意のイシューまたはプルリクエストで、@gemini-cli に続けてリクエストを記載します。
• 例:
  • @gemini-cli explain this code change
  • @gemini-cli suggest improvements for this function
  • @gemini-cli help me debug this error
  • @gemini-cli write unit tests for this component

ワークフロー

このアクションは、さまざまなユースケース向けに事前構築済みのワークフローをいくつか提供します。各ワークフローは、リポジトリの .github/workflows ディレクトリにコピーし、必要に応じてカスタマイズするように設計されています。

Gemini Dispatch

このワークフローは Gemini CLI の中央ディスパッチャとして機能し、トリガーイベントとコメントで指定されたコマンドに基づいて、適切なワークフローにリクエストをルーティングします。ディスパッチワークフローのセットアップ方法の詳細なガイドは、Gemini Dispatch ワークフローのドキュメント を参照してください。

Issue Triage

このアクションは、GitHub イシューを自動的、またはスケジュールに従ってトリアージするために使用できます。イシュートリアージシステムのセットアップ方法の詳細なガイドは、GitHub Issue Triage ワークフローのドキュメント を参照してください。

Pull Request Review

このアクションは、プルリクエストが開かれたときに自動的にレビューするために使用できます。プルリクエストレビューシステムのセットアップ方法の詳細なガイドは、GitHub PR Review ワークフローのドキュメント を参照してください。

Gemini CLI Assistant

このタイプのアクションは、一般的な目的の会話型 Gemini AI アシスタントをプルリクエストやイシュー内で起動し、幅広いタスクを実行するために使用できます。汎用 Gemini CLI ワークフローのセットアップ方法の詳細なガイドは、Gemini Assistant ワークフローのドキュメント を参照してください。

設定

入力

• gcp_location: (オプション) Google Cloud のロケーション。

• gcp_project_id: (オプション) Google Cloud プロジェクト ID。

• gcp_service_account: (オプション) Google Cloud サービスアカウントのメールアドレス。

• gcp_workload_identity_provider: (オプション) Google Cloud Workload Identity Provider。

• gcp_token_format: (オプション、デフォルト: access_token) 認証用のトークンフォーマット。"access_token" に設定するとアクセストークンを生成します (サービスアカウントが必要)。空文字列に設定すると直接 WIF を使用します。"access_token" または "id_token" を指定できます。

• gcp_access_token_scopes: (オプション、デフォルト: https://www.googleapis.com/auth/cloud-platform,https://www.googleapis.com/auth/userinfo.email,https://www.googleapis.com/auth/userinfo.profile) token_format が "access_token" の場合のアクセストークンスコープ。カンマ区切りの OAuth 2.0 スコープのリスト。

• gemini_api_key: (オプション) Gemini API の API キー。

• gemini_cli_version: (オプション、デフォルト: latest) インストールする Gemini CLI のバージョン。"latest"、"preview"、"nightly"、特定のバージョン番号、または git ブランチ、タグ、コミットを指定できます。詳細については、Gemini CLI リリース を参照してください。

• gemini_debug: (オプション) デバッグログと出力ストリーミングを有効にします。

• gemini_model: (オプション) Gemini で使用するモデル。

• google_api_key: (オプション) Gemini で使用する Vertex AI API キー。

• prompt: (オプション、デフォルト: You are a helpful assistant.) Gemini CLI の --prompt 引数 に渡される文字列。

• settings: (オプション) .gemini/settings.json に書き込まれて CLI の プロジェクト 設定を構成する JSON 文字列。 詳細については、設定ファイル のドキュメントを参照してください。

• use_gemini_code_assist: (オプション、デフォルト: false) デフォルトの Gemini API キーの代わりに Code Assist を使用して Gemini モデルにアクセスするかどうか。 詳細については、Gemini CLI ドキュメント を参照してください。

• use_vertex_ai: (オプション、デフォルト: false) デフォルトの Gemini API キーの代わりに Vertex AI を使用して Gemini モデルにアクセスするかどうか。 詳細については、Gemini CLI ドキュメント を参照してください。