Gemini-CLI 项目是一个模块化的 TypeScript monorepo,主要分为两个核心包:@gemini-cli/core
和 @gemini-cli/cli
。这种设计将核心业务逻辑与用户界面分离,提高了代码的可维护性和复用性。
架构图
主要模块说明
1. @gemini-cli/cli
(表现层)
- 路径:
packages/cli
- 职责:
- 用户交互: 这是用户直接与之交互的命令行界面。
- UI 渲染: 使用 Ink (一个用于命令行应用的 React 渲染器) 来构建丰富的、交互式的终端界面。
- 命令解析: 解析用户输入的命令和参数。
- 环境配置: 读取
HTTPS_PROXY
等环境变量,并进行初步配置。 - 调用核心层: 将处理后的用户请求传递给核心逻辑层 (
@gemini-cli/core
) 来执行。
2. @gemini-cli/core
(核心逻辑层)
- 路径:
packages/core
- 职责:
- 核心客户端: 管理整个会话的生命周期。
- Gemini API 通信: 负责与 Google Gemini API 进行所有通信,包括发送请求和处理响应。它使用
undici
的ProxyAgent
来处理网络代理。 - 工具执行: 实现了对模型返回的工具调用(如
run_shell_command
,read_file
等)的本地执行逻辑。 - 配置管理: 提供一个统一的配置管理器,用于获取和管理项目的各种设置。
- 无UI依赖: 这个包不包含任何用户界面的代码,可以被独立地用于其他环境(例如,作为另一个应用的后台服务)。
3. scripts
目录
- 职责: 存放各种构建、测试和辅助脚本,用于自动化开发流程,例如编译 TypeScript、打包应用等。
4. integration-tests
目录
- 职责: 包含端到端测试,用于验证整个应用的流程,确保各个模块能够正确地协同工作。
数据流(以用户输入为例)
- 用户在终端中执行
gemini
命令。 @gemini-cli/cli
接收输入,并通过其 React (Ink) UI 组件进行渲染。- 用户输入一个 Prompt。
@gemini-cli/cli
将 Prompt 传递给@gemini-cli/core
中的核心客户端。- 核心客户端通过其 API 客户端模块将请求发送到 Google Gemini API (如果设置了代理,则通过代理发送)。
- 模型返回结果,可能包含文本响应或工具调用请求。
- 如果返回的是工具调用,
@gemini-cli/core
的工具处理器会执行相应的本地工具代码。 - 最终结果通过
@gemini-cli/cli
渲染回用户的终端界面。