Gemini CLI
This repository contains the Gemini CLI, a command-line AI workflow tool that connects to your tools, understands your code and accelerates your workflows.
With the Gemini CLI you can:
- Query and edit large codebases in and beyond Gemini's 1M token context window.
- Generate new apps from PDFs or sketches, using Gemini's multimodal capabilities.
- Automate operational tasks, like querying pull requests or handling complex rebases.
- Integrate with GitHub: Use the Gemini CLI GitHub Action for automated PR reviews, issue triage, and on-demand AI assistance directly in your repositories.
- Use tools and MCP servers to connect new capabilities, including media generation with Imagen, Veo or Lyria
- Ground your queries with the Google Search tool, built into Gemini.
Quickstart
You have two options to install Gemini CLI.
With Node
-
Prerequisites: Ensure you have Node.js version 20 or higher installed.
-
Run the CLI: Execute the following command in your terminal:
npx https://github.com/google-gemini/gemini-cliOr install it with:
npm install -g @google/gemini-cliThen, run the CLI from anywhere:
gemini
With Homebrew
-
Prerequisites: Ensure you have Homebrew installed.
-
Install the CLI: Execute the following command in your terminal:
brew install gemini-cliThen, run the CLI from anywhere:
gemini
Common Configuration steps
- Pick a color theme
- Authenticate: When prompted, sign in with your personal Google account. This will grant you up to 60 model requests per minute and 1,000 model requests per day using Gemini.
You are now ready to use the Gemini CLI!
Use a Gemini API key:
The Gemini API provides a free tier with 100 requests per day using Gemini 2.5 Pro, control over which model you use, and access to higher rate limits (with a paid plan):
-
Generate a key from Google AI Studio.
-
Set it as an environment variable in your terminal. Replace
YOUR_API_KEYwith your generated key.export GEMINI_API_KEY="YOUR_API_KEY" -
(Optionally) Upgrade your Gemini API project to a paid plan on the API key page (will automatically unlock Tier 1 rate limits)
Use a Vertex AI API key:
The Vertex AI API provides a free tier using express mode for Gemini 2.5 Pro, control over which model you use, and access to higher rate limits with a billing account:
-
Generate a key from Google Cloud.
-
Set it as an environment variable in your terminal. Replace
YOUR_API_KEYwith your generated key and set GOOGLE_GENAI_USE_VERTEXAI to trueexport GOOGLE_API_KEY="YOUR_API_KEY"
export GOOGLE_GENAI_USE_VERTEXAI=true -
(Optionally) Add a billing account on your project to get access to higher usage limits
For other authentication methods, including Google Workspace accounts, see the authentication guide.
Examples
Once the CLI is running, you can start interacting with Gemini from your shell.
You can start a project from a new directory:
gemini
> Write me a Gemini Discord bot that answers questions using a FAQ.md file I will provide
Or work with an existing project:
cd gemini-cli
gemini
> Give me a summary of all of the changes that went in yesterday
Next steps
- Learn how to contribute to or build from the source.
- Explore the available CLI Commands.
- If you encounter any issues, review the troubleshooting guide.
- For more comprehensive documentation, see the full documentation.
- Take a look at some popular tasks for more inspiration.
- Check out our Official Roadmap
Troubleshooting
Head over to the troubleshooting guide if you're having issues.
GitHub Integration
Integrate Gemini CLI directly into your GitHub workflows with the Gemini CLI GitHub Action. Key features include:
- Pull Request Reviews: Automatically review pull requests when they're opened.
- Issue Triage: Automatically triage and label GitHub issues.
- On-demand Collaboration: Mention
@gemini-cliin issues and pull requests for assistance and task delegation. - Custom Workflows: Set up your own scheduled tasks and event-driven automations.
Popular tasks
Explore a new codebase
Start by cding into an existing or newly-cloned repository and running gemini.
> Describe the main pieces of this system's architecture.