googleworkspace/cli

这是什么？

核心功能

• 01根据 Google Discovery Service 动态生成命令，新增的 API 方法会自动可用。
• 02所有响应（包括错误）均输出结构化 JSON。
• 03支持 --dry-run 预览请求，支持 --page-all 以 NDJSON 流式获取分页结果。
• 04附带 100 多个 Agent Skills 和 Gemini CLI 扩展，便于 AI 代理调用。
• 05提供多种认证方式：交互式 OAuth、服务账号、访问令牌以及适用于 CI 的凭据导出。

适用场景

• 在终端或 CI 任务中脚本化执行 Drive、表格或 Gmail 的日常操作。
• 让 AI 代理通过结构化命令读取日历、发送邮件或更新电子表格。
• 自动化 Google Chat 通知，例如部署完成后发送消息。
• 将 Workspace 数据通过管道交给 jq 等 shell 工具做统计报表。

快速上手

1. 1

   通过 npm 安装 CLI

   npm install -g @googleworkspace/cli
2. 2

   设置 Google Cloud 项目和 OAuth 凭据

   gws auth setup
3. 3

   使用 OAuth 登录(后续登录)

   gws auth login
4. 4

   列出最近的 5 个 Drive 文件

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

使用前须知

• !这不是 Google 官方支持的产品。
• !项目仍在积极开发中,在 v1.0 之前可能出现破坏性变更。
• !未经验证的测试模式应用最多只能获得约 25 个权限范围,完整的推荐权限预设会失败。
• !必须将自己的 Google 账号添加为测试用户,否则登录会因访问被阻止而失败。

标签

常见问题

cli 是什么？

一个命令行工具，统一调用 Google Workspace 的 Drive、Gmail、日历、表格、文档、Chat 等 API，输出结构化 JSON。 gws 是一个 Google Workspace 命令行客户端，可以用统一的命令访问 Drive、Gmail、日历、表格、文档、Chat 和管理后台等服务，不必手写 curl 调用 REST 接口。命令集在运行时由 Google Discovery Service 动态生成，Google 新增的 API 方法无需等待工具更新即可使用。每个资源都支持 --help，--dry-run 可以在发送请求前预览，--page-all 则以 NDJSON 形式流式输出分页结果。

cli 可以免费使用吗？用的什么许可证？

cli 以 Apache-2.0 许可证开源。用于商业产品前，请先确认许可证条款。

cli 还在维护吗？

活跃维护中。cli 最近一次提交是在 2026年10月6日。

cli 适合用来做什么？

在终端或 CI 任务中脚本化执行 Drive、表格或 Gmail 的日常操作。 让 AI 代理通过结构化命令读取日历、发送邮件或更新电子表格。 自动化 Google Chat 通知，例如部署完成后发送消息。 将 Workspace 数据通过管道交给 jq 等 shell 工具做统计报表。

cli 怎么安装和运行？

通过 npm 安装 CLI: npm install -g @googleworkspace/cli 设置 Google Cloud 项目和 OAuth 凭据: gws auth setup 使用 OAuth 登录(后续登录): gws auth login 列出最近的 5 个 Drive 文件: gws drive files list --params '{"pageSize": 5}'

在哪里获取 cli？

源代码和安装说明在 GitHub 上：https://github.com/googleworkspace/cli