Core:
- Command-line AI workflow tool that connects to tools and understands code
- Supports querying/editing large codebases and generating apps from PDFs/sketches
- Includes automation capabilities and MCP server integration for enhanced functionality
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.
- 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 in to Gemini.
Quickstart
-
Prerequisites: Ensure you have Node.js version 18 or higher installed.
-
Run the CLI: Execute the following command in your terminal:
1
npx https://github.com/google-gemini/gemini-cli
Or install it with:
1 2
npm install -g @google/gemini-cli gemini
-
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!
For advanced use or increased limits:
If you need to use a specific model or require a higher request capacity, you can use an API key:
-
Generate a key from Google AI Studio.
-
Set it as an environment variable in your terminal. Replace
YOUR_API_KEY
with your generated key.1
export GEMINI_API_KEY="YOUR_API_KEY"
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:
|
|
Or work with an existing project:
|
|
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.
Troubleshooting
Head over to the troubleshooting guide if you’re having issues.
Popular tasks
Explore a new codebase
Start by cd
ing into an existing or newly-cloned repository and running gemini
.
|
|
|
|
Work with your existing code
|
|
|
|
Automate your workflows
Use MCP servers to integrate your local system tools with your enterprise collaboration suite.
|
|
|
|
Interact with your system
|
|
|
|