run-gemini-cli

Overview

run-gemini-cli is a GitHub Action that integrates [Gemini] into your development workflow via the [Gemini CLI]. It acts both as an autonomous agent for critical routine coding tasks, and an on-demand collaborator you can quickly delegate work to.

Use it to perform GitHub pull request reviews, triage issues, perform code analysis and modification, and more using [Gemini] conversationally (e.g., @gemini-cli fix this issue) directly inside your GitHub repositories.

• run-gemini-cli
  • Overview
  • Features
  • Quick Start
    • 1. Get a Gemini API Key
    • 2. Add it as a GitHub Secret
    • 3. Update your .gitignore
    • 4. Choose a Workflow
    • 5. Try it out!
  • Workflows
    • Gemini Dispatch
    • Issue Triage
    • Pull Request Review
    • Gemini CLI Assistant
  • Configuration
    • Inputs
    • Outputs
    • Repository Variables
    • Secrets
  • Authentication
    • Google Authentication
    • GitHub Authentication
  • Observability
  • Extensions
  • Best Practices
  • Customization
  • Contributing

Features

• Automation: Trigger workflows based on events (e.g. issue opening) or schedules (e.g. nightly).
• On-demand Collaboration: Trigger workflows in issue and pull request comments by mentioning the [Gemini CLI] (e.g., @gemini-cli /review).
• Extensible with Tools: Leverage [Gemini] models' tool-calling capabilities to interact with other CLIs like the [GitHub CLI] (gh).
• Customizable: Use a GEMINI.md file in your repository to provide project-specific instructions and context to [Gemini CLI].

Quick Start

Get started with Gemini CLI in your repository in just a few minutes:

1. Get a Gemini API Key

Obtain your API key from [Google AI Studio] with generous free-of-charge quotas

2. Add it as a GitHub Secret

Store your API key as a secret named GEMINI_API_KEY in your repository:

• Go to your repository's Settings > Secrets and variables > Actions
• Click New repository secret
• Name: GEMINI_API_KEY, Value: your API key

3. Update your .gitignore

Add the following entries to your .gitignore file:

# gemini-cli settings
.gemini/

# GitHub App credentials
gha-creds-*.json

4. Choose a Workflow

You have two options to set up a workflow:

Option A: Use setup command (Recommended)

1. Start the Gemini CLI in your terminal:

   gemini
   

2. In Gemini CLI in your terminal, type:

   /setup-github
   

Option B: Manually copy workflows

1. Copy the pre-built workflows from the examples/workflows directory to your repository's .github/workflows directory. Note: the gemini-dispatch.yml workflow must also be copied, which triggers the workflows to run.

5. Try it out!

Pull Request Review:

• Open a pull request in your repository and wait for automatic review
• Comment @gemini-cli /review on an existing pull request to manually trigger a review

Issue Triage:

• Open an issue and wait for automatic triage
• Comment @gemini-cli /triage on existing issues to manually trigger triaging

General AI Assistance:

• In any issue or pull request, mention @gemini-cli followed by your request
• Examples:
  • @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

Workflows

This action provides several pre-built workflows for different use cases. Each workflow is designed to be copied into your repository's .github/workflows directory and customized as needed.

Gemini Dispatch

This workflow acts as a central dispatcher for Gemini CLI, routing requests to the appropriate workflow based on the triggering event and the command provided in the comment. For a detailed guide on how to set up the dispatch workflow, go to the Gemini Dispatch workflow documentation.

Issue Triage

This action can be used to triage GitHub Issues automatically or on a schedule. For a detailed guide on how to set up the issue triage system, go to the GitHub Issue Triage workflow documentation.

Pull Request Review

This action can be used to automatically review pull requests when they are opened. For a detailed guide on how to set up the pull request review system, go to the GitHub PR Review workflow documentation.

Gemini CLI Assistant

This type of action can be used to invoke a general-purpose, conversational Gemini AI assistant within the pull requests and issues to perform a wide range of tasks. For a detailed guide on how to set up the general-purpose Gemini CLI workflow, go to the Gemini Assistant workflow documentation.

Configuration

Inputs

• gcp_location: (Optional) The Google Cloud location.

• gcp_project_id: (Optional) The Google Cloud project ID.

• gcp_service_account: (Optional) The Google Cloud service account email.

• gcp_workload_identity_provider: (Optional) The Google Cloud Workload Identity Provider.

• gcp_token_format: (Optional, default: access_token) The token format for authentication. Set to "access_token" to generate access tokens (requires service account), or set to empty string for direct WIF. Can be "access_token" or "id_token".

• gcp_access_token_scopes: (Optional, default: https://www.googleapis.com/auth/cloud-platform,https://www.googleapis.com/auth/userinfo.email,https://www.googleapis.com/auth/userinfo.profile) The access token scopes when using token_format "access_token". Comma-separated list of OAuth 2.0 scopes.

• gemini_api_key: (Optional) The API key for the Gemini API.

• gemini_cli_version: (Optional, default: latest) The version of the Gemini CLI to install. Can be "latest", "preview", "nightly", a specific version number, or a git branch, tag, or commit. For more information, see Gemini CLI releases.