欢迎查阅 Gemini CLI 文档
本文档为安装、使用和开发 Gemini CLI 提供完整指南。Gemini CLI 让你可以通过命令行界面与 Gemini 模型进行交互。
概览
Gemini CLI 将 Gemini 模型的能力带到终端,为你提供交互式 REPL(Read-Eval-Print Loop)体验。Gemini CLI 由一个客户端应用(packages/cli)和一个本地服务器(packages/core)组成,本地服务器负责转发对 Gemini API 及其 AI 模型的请求。Gemini CLI 还内置多种工具,可执行文件系统操作、运行 Shell、进行 Web 抓取等,这些工具都由 packages/core 管理。
如何浏览文档
本套文档按照以下章节组织:
快速开始
- Gemini CLI 快速入门: 带你快速体验 Gemini CLI。
- 部署: 安装并运行 Gemini CLI。
- 身份验证: 为 Gemini CLI 配置身份验证。
- 配置: 了解如何配置 CLI。
- 示例: 探索 Gemini CLI 的使用示例。
CLI
- CLI 概览: 介绍命令行界面的总体结构。
- 命令: 说明可用的 CLI 命令。
- 企业版: 面向企业的 Gemini CLI 功能。
- 主题: Gemini CLI 的主题外观。
- Token 缓存: Token 缓存与优化策略。
- 教程: Gemini CLI 教程集合。
- Checkpointing: Checkpointing 功能说明。
- Telemetry: CLI 遥测数据概览。
- Trusted Folders: 介绍 Trusted Folders 安全机制。
Core
- Gemini CLI Core 概览: 了解 Gemini CLI Core。
- Memport: 使用 Memory Import Processor。
- Tools API: Core 如何管理并暴露工具。
Tools
- Gemini CLI Tools 概览: 了解 Gemini CLI 的工具体系。
- 文件系统工具:
read_file与write_file工具说明。 - MCP Servers: 在 Gemini CLI 中使用 MCP servers。
- 多文件读取工具:
read_many_files工具文档。 - Shell 工具:
run_shell_command工具说明。 - Web Fetch 工具:
web_fetch工具说明。 - Web Search 工具:
google_web_search工具说明。 - Memory 工具:
save_memory工具说明。
扩展
- Extensions: 如何为 CLI 扩展新功能。
- Extension 发布: 发布 Gemini CLI 扩展的流程。
IDE 集成
- IDE 集成: 将 CLI 连接到你的编辑器。
- IDE Companion Extension 规范: 构建 IDE companion 扩展的规范。
关于 Gemini CLI 项目
- 架构概览: 理解 Gemini CLI 的高层架构及组件协作方式。
- 贡献与开发指南: 面向贡献者的环境搭建、构建、测试与编码规范。
- NPM: 项目包结构说明。
- 故障排查指南: 常见问题的解决方案。
- FAQ: 常见问题解答。
- 服务条款与隐私声明: 了解使用 Gemini CLI 时适用的服务条款与隐私声明。
- Releases: 项目版本与发布节奏信息。
希望本套文档能够帮助你充分发挥 Gemini CLI 的价值!