欢迎使用 Gemini CLI 文档

¥Welcome to Gemini CLI documentation

本文档提供了 Gemini CLI 的安装、使用和开发指南。该工具允许您通过命令行界面与 Gemini 模型进行交互。

¥This documentation provides a comprehensive guide to installing, using, and developing Gemini CLI. This tool lets you interact with Gemini models through a command-line interface.

概述

¥Overview

Gemini CLI 将 Gemini 模型的功能带到您的终端，并通过交互式的读取-求值-打印循环 (REPL) 环境进行演示。Gemini CLI 由一个客户端应用程序 (packages/cli) 与本地服务器通信 (packages/core)，它负责管理对 Gemini API 及其 AI 模型的请求。Gemini CLI 还包含各种工具，用于执行文件系统操作、运行 Shell 和 Web 获取等任务，这些任务由packages/core。

¥Gemini CLI brings the capabilities of Gemini models to your terminal in an interactive Read-Eval-Print Loop (REPL) environment. Gemini CLI consists of a client-side application (packages/cli) that communicates with a local server (packages/core), which in turn manages requests to the Gemini API and its AI models. Gemini CLI also contains a variety of tools for tasks such as performing file system operations, running shells, and web fetching, which are managed by packages/core.

浏览文档

¥Navigating the documentation

本文档分为以下几个部分：

¥This documentation is organized into the following sections:

• 执行和部署：运行 Gemini CLI 的信息。

  ¥Execution and Deployment: Information for running Gemini CLI.

• 架构概述：了解 Gemini CLI 的高层设计，包括其组件及其交互方式。

  ¥Architecture Overview: Understand the high-level design of Gemini CLI, including its components and how they interact.

• CLI用法：文档packages/cli。

  ¥CLI Usage: Documentation for packages/cli.

• CLI 介绍：命令行界面概述。

  ¥CLI Introduction: Overview of the command-line interface.

• 命令：可用 CLI 命令的描述。

  ¥Commands: Description of available CLI commands.

• 配置：有关配置 CLI 的信息。

  ¥Configuration: Information on configuring the CLI.

• 检查点：检查点功能的文档。

  ¥Checkpointing: Documentation for the checkpointing feature.

• 扩展：如何使用新功能扩展 CLI。

  ¥Extensions: How to extend the CLI with new functionality.

• IDE 集成：将 CLI 连接到您的编辑器。

  ¥IDE Integration: Connect the CLI to your editor.

• 遥测：CLI 中的遥测概述。

  ¥Telemetry: Overview of telemetry in the CLI.

• 核心细节：文档packages/core。

  ¥Core Details: Documentation for packages/core.

• 核心介绍：核心组件概述。

  ¥Core Introduction: Overview of the core component.

• 工具 API：有关核心如何管理和公开工具的信息。

  ¥Tools API: Information on how the core manages and exposes tools.

• 工具：

  ¥Tools:

• 工具概述：可用工具的概述。

  ¥Tools Overview: Overview of the available tools.

• 文件系统工具：文档read_file和write_file工具。

  ¥File System Tools: Documentation for the read_file and write_file tools.

• 多文件读取工具：文档read_many_files工具。

  ¥Multi-File Read Tool: Documentation for the read_many_files tool.

• Shell 工具：文档run_shell_command工具。

  ¥Shell Tool: Documentation for the run_shell_command tool.

• Web 获取工具：文档web_fetch工具。

  ¥Web Fetch Tool: Documentation for the web_fetch tool.

• 网络搜索工具：文档google_web_search工具。

  ¥Web Search Tool: Documentation for the google_web_search tool.

• 记忆工具：文档save_memory工具。

  ¥Memory Tool: Documentation for the save_memory tool.

• 贡献与开发指南：为贡献者和开发人员提供的信息，包括设置、构建、测试和编码约定。

  ¥Contributing & Development Guide: Information for contributors and developers, including setup, building, testing, and coding conventions.

• 新公共管理：有关项目包结构的详细信息

  ¥NPM: Details on how the project's packages are structured

• 故障排除指南：查找常见问题和常见问题解答的解决方案。

  ¥Troubleshooting Guide: Find solutions to common problems and FAQs.

• 服务条款和隐私声明：有关您使用 Gemini CLI 的服务条款和隐私声明的信息。

  ¥Terms of Service and Privacy Notice: Information on the terms of service and privacy notices applicable to your use of Gemini CLI.

• 发布：有关项目发布和部署节奏的信息。

  ¥Releases: Information on the project's releases and deployment cadence.

我们希望本文档能帮助您充分利用 Gemini CLI！

¥We hope this documentation helps you make the most of the Gemini CLI!