cli

环境要求

• Node.js/npm（用于 npm 全局安装方式）
• Google 账号（需加入 OAuth 同意屏幕的测试用户）
• 可选：已安装并认证的 gcloud，可让 gws auth setup 自动创建项目
• 可选：Google Cloud 项目与 OAuth 桌面应用客户端（手动配置时需要）
• 可选：Rust/Cargo 或 Homebrew 或 Nix（用于其他安装方式）

安装与启动步骤

1. 1安装 gws

   README 推荐从 GitHub Releases 下载对应系统的二进制并放入 PATH；也可用 npm 自动下载合适的二进制。

   npm install -g @googleworkspace/cli

   复制

2. 2其他安装方式

   按需选择：Homebrew、Cargo 源码编译或 Nix 运行，三条命令择一执行即可。

   brew install googleworkspace-cli
   cargo install --git https://github.com/googleworkspace/cli --locked
   nix run github:googleworkspace/cli

   复制

3. 3初始化认证

   执行后按提示完成 Google Cloud 项目配置，需要本机已安装并认证 gcloud，这是最快的方式。

   gws auth setup

   复制

4. 4手动配置 OAuth

   无法自动化创建时：在 Cloud Console 建 OAuth 桌面应用客户端，下载 JSON 存到 ~/.config/gws/client_secret.json，并把账号加为测试用户。

5. 5OAuth 登录

   首次或后续登录都执行此命令，会打开浏览器完成 Google 账号授权流程。

   gws auth login

   复制

6. 6验证是否可用

   调用 Drive 接口列出 5 个文件，返回结构化 JSON 说明命令面已动态构建成功。

   gws drive files list --params '{"pageSize": 5}'

   复制

7. 7安装智能体技能

   内置 40+ agent skills，用这条命令可一次性全部安装到支持 skills 的环境中。

   npx skills add https://github.com/googleworkspace/cli

   复制

关键配置

如何确认成功

运行 gws drive files list --params '{"pageSize": 5}'，能返回 Drive 文件列表的 JSON 结果即表示启动并授权成功。

常见问题

注意事项

• gws 不内置静态命令表，而是运行时读取 Google Discovery Service 动态生成命令，Google 新增接口会自动支持。
• README 推荐直接下载 GitHub Releases 的预编译二进制并将 gws 加入 $PATH。
• 如果已有 OAuth 访问令牌或凭据文件，可用对应环境变量跳过登录流程。
• 这不是官方支持的 Google 产品，生产使用需自行评估。