内容摘录
Gemini CLI
Gemini CLI CI
Gemini CLI E2E (Chained)
Version
License
View Code Wiki
!Gemini CLI Screenshot
Gemini CLI is an open-source AI agent that brings the power of Gemini directly
into your terminal. It provides lightweight access to Gemini, giving you the
most direct path from your prompt to our model.
Learn all about Gemini CLI in our documentation.
🚀 Why Gemini CLI?
**🎯 Free tier**: 60 requests/min and 1,000 requests/day with personal Google
account.
**🧠 Powerful Gemini 3 models**: Access to improved reasoning and 1M token
context window.
**🔧 Built-in tools**: Google Search grounding, file operations, shell
commands, web fetching.
**🔌 Extensible**: MCP (Model Context Protocol) support for custom
integrations.
**💻 Terminal-first**: Designed for developers who live in the command line.
**🛡️ Open source**: Apache 2.0 licensed.
📦 Installation
Pre-requisites before installation
Node.js version 20 or higher
macOS, Linux, or Windows
Quick Install
Run instantly with npx
Install globally with npm
Install globally with Homebrew (macOS/Linux)
Install globally with MacPorts (macOS)
Install with Anaconda (for restricted environments)
Release Cadence and Tags
See Releases for more details.
Preview
New preview releases will be published each week at UTC 2359 on Tuesdays. These
releases will not have been fully vetted and may contain regressions or other
outstanding issues. Please help us test and install with preview tag.
Stable
New stable releases will be published each week at UTC 2000 on Tuesdays, this
will be the full promotion of last week's preview release + any bug fixes
and validations. Use latest tag.
Nightly
New releases will be published each day at UTC 0000. This will be all changes
from the main branch as represented at time of release. It should be assumed
there are pending validations and issues. Use nightly tag.
📋 Key Features
Code Understanding & Generation
Query and edit large codebases
Generate new apps from PDFs, images, or sketches using multimodal capabilities
Debug issues and troubleshoot with natural language
Automation & Integration
Automate operational tasks like querying pull requests or handling complex
rebases
Use MCP servers to connect new capabilities, including
media generation with Imagen, Veo or Lyria
Run non-interactively in scripts for workflow automation
Advanced Capabilities
Ground your queries with built-in
Google Search for real-time
information
Conversation checkpointing to save and resume complex sessions
Custom context files (GEMINI.md) to tailor behavior for your projects
GitHub Integration
Integrate Gemini CLI directly into your GitHub workflows with
**Gemini CLI GitHub Action**:
**Pull Request Reviews**: Automated code review with contextual feedback and
suggestions
**Issue Triage**: Automated labeling and prioritization of GitHub issues based
on content analysis
**On-demand Assistance**: Mention @gemini-cli in issues and pull requests
for help with debugging, explanations, or task delegation
**Custom Workflows**: Build automated, scheduled and on-demand workflows
tailored to your team's needs
🔐 Authentication Options
Choose the authentication method that best fits your needs:
Option 1: Login with Google (OAuth login using your Google Account)
**✨ Best for:** Individual developers as well as anyone who has a Gemini Code
Assist License. (see
quota limits and terms of service
for details)
**Benefits:**
**Free tier**: 60 requests/min and 1,000 requests/day
**Gemini 3 models** with 1M token context window
**No API key management** - just sign in with your Google account
**Automatic updates** to latest models
Start Gemini CLI, then choose _Login with Google_ and follow the browser authentication flow when prompted
If you are using a paid Code Assist License from your organization, remember to set the Google Cloud Project
Option 2: Gemini API Key
**✨ Best for:** Developers who need specific model control or paid tier access
**Benefits:**
**Free tier**: 1000 requests/day with Gemini 3 (mix of flash and pro)
**Model selection**: Choose specific Gemini models
**Usage-based billing**: Upgrade for higher limits when needed
Option 3: Vertex AI
**✨ Best for:** Enterprise teams and production workloads
**Benefits:**
**Enterprise features**: Advanced security and compliance
**Scalable**: Higher rate limits with billing account
**Integration**: Works with existing Google Cloud infrastructure
For Google Workspace accounts and other authentication methods, see the
authentication guide.
🚀 Getting Started
Basic Usage
Start in current directory
Include multiple directories
Use specific model
Non-interactive mode for scripts
Get a simple text response:
For more advanced scripting, including how to parse JSON and handle errors, use
the --output-format json flag to get structured output:
For real-time event streaming (useful for monitoring long-running operations),
use --output-format stream-json to get newline-delimited JSON events:
Quick Examples
Start a new project
Analyze existing code
📚 Documentation
Getting Started
**Quickstart Guide** - Get up and running
quickly.
**Authentication Setup** - Detailed
auth configuration.
**Configuration Guide** - Settings and
customization.
**Keyboard Shortcuts** - Productivity
tips.
Core Features
**Commands Reference** - All slash commands
(/help, /chat, etc).
**Custom Commands** - Create your own
reusable commands.
**Context Files (GEMINI.md)** - Provide persistent
context to Gemini CLI.
**Checkpointing** - Save and resume
conversations.
**Token Caching** - Optimize token usage.
Tools & Extensions
**Built-in Tools Overview**
File System Operations
Shell Commands
Web Fetch & Search
**MCP Server Integration** - Extend with custom
tools.
**Custom Extensions** - Build and share your own
commands.
Advanced Topics
**Headless Mode (Scripting)** - Use Gemini CLI in
automated workflows.
**Architecture Overview** - How Gemini CLI works.
**IDE Integration** - VS Code companion.
**Sandboxing & Securit…