主题
Gemini CLI 安装、执行和部署
安装和运行 Gemini CLI。本文档概述了 Gemini CLI 的安装方法和部署架构。
如何安装和/或运行 Gemini CLI
有多种方式运行 Gemini CLI。推荐的选项取决于你打算如何使用 Gemini CLI。
- 作为标准安装。这是使用 Gemini CLI 最直接的方法。
- 在沙箱中。此方法提供更高的安全性和隔离性。
- 从源代码。推荐给项目贡献者。
1. 标准安装(推荐给标准用户)
这是终端用户安装 Gemini CLI 的推荐方式。它涉及从 NPM 注册表下载 Gemini CLI 包。
全局安装:
bashnpm install -g @google/gemini-cli然后,从任何地方运行 CLI:
bashgeminiNPX 执行:
bash# 从 NPM 执行最新版本,无需全局安装 npx @google/gemini-cli
2. 在沙箱中运行(Docker/Podman)
为了安全和隔离,Gemini CLI 可以在容器内运行。这是 CLI 执行可能有副作用的工具的默认方式。
- 直接从注册表运行: 你可以直接运行已发布的沙箱镜像。这对于只有 Docker 并想运行 CLI 的环境很有用。bash
# 运行已发布的沙箱镜像 docker run --rm -it us-docker.pkg.dev/gemini-code-dev/gemini-cli/sandbox:0.1.1 - 使用
--sandbox标志: 如果你已在本地安装 Gemini CLI(使用上述标准安装),你可以指示它在沙箱容器内运行。bashgemini --sandbox -y -p "your prompt here"
3. 从源代码运行(推荐给 Gemini CLI 贡献者)
项目贡献者会想要直接从源代码运行 CLI。
开发模式: 此方法提供热重载,对于活跃开发很有用。
bash# 从仓库根目录 npm run start类生产模式(链接包): 此方法通过链接本地包来模拟全局安装。对于在生产工作流中测试本地构建很有用。
bash# 将本地 cli 包链接到全局 node_modules npm link packages/cli # 现在你可以使用 `gemini` 命令运行本地版本 gemini
4. 从 GitHub 运行最新的 Gemini CLI 提交
你可以直接从 GitHub 仓库运行最新提交的 Gemini CLI 版本。这对于测试仍在开发中的功能很有用。
bash
# 直接从 GitHub 的 main 分支执行 CLI
npx https://github.com/google-gemini/gemini-cli部署架构
上述执行方法由以下架构组件和流程实现:
NPM 包
Gemini CLI 项目是一个 monorepo,向 NPM 注册表发布两个核心包:
@google/gemini-cli-core:后端,处理逻辑和工具执行。@google/gemini-cli:面向用户的前端。
这些包在执行标准安装和从源代码运行 Gemini CLI 时使用。
构建和打包流程
根据分发渠道,使用两个不同的构建流程:
NPM 发布: 对于发布到 NPM 注册表,
@google/gemini-cli-core和@google/gemini-cli中的 TypeScript 源代码使用 TypeScript 编译器(tsc)转译为标准 JavaScript。生成的dist/目录是 NPM 包中发布的内容。这是 TypeScript 库的标准方法。GitHub
npx执行: 当直接从 GitHub 运行最新版本的 Gemini CLI 时,package.json中的prepare脚本会触发不同的流程。此脚本使用esbuild将整个应用程序及其依赖项打包成单个独立的 JavaScript 文件。此包在用户机器上即时创建,不会检入仓库。
Docker 沙箱镜像
基于 Docker 的执行方法由 gemini-cli-sandbox 容器镜像支持。此镜像发布到容器注册表,包含预安装的全局版本 Gemini CLI。
发布流程
发布流程通过 GitHub Actions 自动化。发布工作流执行以下操作:
- 使用
tsc构建 NPM 包。 - 将 NPM 包发布到工件注册表。
- 创建带有打包资产的 GitHub 发布。