gemini-cli README

The project's README from github.com/google-gemini/gemini-cli. As one markdown file: README.md.

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?

📦 Installation

See Gemini CLI installation, execution, and releases for recommended system specifications and a detailed installation guide.

Quick Install

Run instantly with npx

# Using npx (no installation required)
npx @google/gemini-cli

Install globally with npm

npm install -g @google/gemini-cli

Install globally with Homebrew (macOS/Linux)

brew install gemini-cli

Install globally with MacPorts (macOS)

sudo port install gemini-cli

Install with Anaconda (for restricted environments)

# Create and activate a new environment
conda create -y -n gemini_env -c conda-forge nodejs
conda activate gemini_env

# Install Gemini CLI globally via npm (inside the environment)
npm install -g @google/gemini-cli

Release Channels

See Releases for more details.

Preview

New preview releases will be published each week at UTC 23:59 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.

npm install -g @google/gemini-cli@preview

Stable

npm install -g @google/gemini-cli@latest

Nightly

npm install -g @google/gemini-cli@nightly

📋 Key Features

Code Understanding & Generation

Automation & Integration

Advanced Capabilities

GitHub Integration

Integrate Gemini CLI directly into your GitHub workflows with Gemini CLI GitHub Action:

🔐 Authentication Options

Choose the authentication method that best fits your needs:

Option 1: Sign in 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:

Start Gemini CLI, then choose Sign in with Google and follow the browser authentication flow when prompted

gemini

If you are using a paid Code Assist License from your organization, remember to set the Google Cloud Project

# Set your Google Cloud Project
export GOOGLE_CLOUD_PROJECT="YOUR_PROJECT_ID"
gemini

Option 2: Gemini API Key

✨ Best for: Developers who need specific model control or paid tier access

Benefits:

# Get your key from https://aistudio.google.com/apikey
export GEMINI_API_KEY="YOUR_API_KEY"
gemini

Option 3: Vertex AI

✨ Best for: Enterprise teams and production workloads

Benefits:

# Get your key from Google Cloud Console
export GOOGLE_API_KEY="YOUR_API_KEY"
export GOOGLE_GENAI_USE_VERTEXAI=true
gemini

For Google Workspace accounts and other authentication methods, see the authentication guide.

🚀 Getting Started

Basic Usage

Start in current directory

gemini

Include multiple directories

gemini --include-directories ../lib,../docs

Use specific model

gemini -m gemini-2.5-flash

Non-interactive mode for scripts

Get a simple text response:

gemini -p "Explain the architecture of this codebase"

For more advanced scripting, including how to parse JSON and handle errors, use the --output-format json flag to get structured output:

gemini -p "Explain the architecture of this codebase" --output-format json

For real-time event streaming (useful for monitoring long-running operations), use --output-format stream-json to get newline-delimited JSON events:

gemini -p "Run tests and deploy" --output-format stream-json

Quick Examples

Start a new project

cd new-project/
gemini
> Write me a Discord bot that answers questions using a FAQ.md file I will provide

Analyze existing code

git clone https://github.com/google-gemini/gemini-cli
cd gemini-cli
gemini
> Give me a summary of all of the changes that went in yesterday

📚 Documentation

Getting Started

Core Features

Tools & Extensions

Advanced Topics

Troubleshooting & Support

Using MCP Servers

Configure MCP servers in ~/.gemini/settings.json to extend Gemini CLI with custom tools:

> @github List my open pull requests
> @slack Send a summary of today's commits to #dev channel
> @database Run a query to find inactive users

See the MCP Server Integration guide for setup instructions.

🤝 Contributing

We welcome contributions! Gemini CLI is fully open source (Apache 2.0), and we encourage the community to:

See our Contributing Guide for development setup, coding standards, and how to submit pull requests.

Check our Official Roadmap for planned features and priorities.

📖 Resources

Uninstall

See the Uninstall Guide for removal instructions.

Star History Rank


Built with ❤️ by Google and the open source community

gemini-cli (google-gemini/gemini-cli)

Searching Database…

107.4K ·GitHub
这是什么?Gemini CLI 是一个开源 AI 智能体,可以把 Google 的 Gemini 模型直接带到你的终端里,让你在命令行中聊天、生成代码并运行工具。
这是独立的终端应用,还是需要嵌入我自己代码里的东西?它是以终端为核心的命令行智能体,你可以直接运行它,而不是需要导入到其他应用中的代码库。
我该如何安装并启动它?可以通过 npx、npm install -g、Homebrew(macOS/Linux)、MacPorts 或 Anaconda 安装,然后直接运行命令,就能在当前目录开始聊天。
我需要 API 密钥吗,还是直接用 Google 账号登录就行?你可以用 Google 账号登录,享受免费套餐;也可以使用 Gemini API 密钥,或通过 Vertex AI 连接,适用于企业级工作负载。使用 Google 账号登录时无需管理密钥。
免费套餐有什么限制?使用个人 Google 账号登录时,每分钟最多 60 次请求,每天最多 1,000 次请求;预览版和每日构建版可能存在回归问题,因此如果追求稳定,请使用稳定的 'latest' 标签。
我能用自定义工具或集成来扩展它吗?可以。它支持在 ~/.gemini/settings.json 中配置的 MCP(Model Context Protocol,模型上下文协议)服务器,让你添加自定义工具,甚至通过 Imagen、Veo 或 Lyria 生成媒体内容。
它能与 GitHub 集成吗?可以。Gemini CLI GitHub Action 支持自动审查拉取请求(PR)、对议题(issue)进行分类,并可在议题和拉取请求中通过提及 @gemini-cli 按需获取帮助。
我能在脚本中使用它,而不是交互式操作吗?可以。非交互式无头模式支持纯文本、结构化 JSON 或流式 JSON 输出,适用于自动化工作流。
它提供多大的模型上下文窗口?Gemini 3 模型提供 1M token 的上下文窗口,并改进了推理能力,适用于大型代码库和复杂任务。
Size
101.5 MB
Stars
107.4K
Age
1y
Commits · 90 Days