🏢 Google Workspace CLI — 谷歌办公CLI
v1.0.0官方 Google 命令行工具,一站式调用 Drive、Gmail、Calendar、Sheets、Docs、Chat、Admin 等全部 Workspace API,并内置 MCP server 供 AI 代理直接操作云端文档与邮件。
详细分析 ▾
运行时依赖
版本
初始发布
安装命令
点击复制技能文档
官方 Google 发布的 Workspace 全 API CLI。基于 Google Discovery Service 动态构建——Google 新增接口时自动覆盖。
注意: 这是 Google 官方组织维护的 CLI(googleworkspace/cli),与第三方替代品不同。新项目优先使用 gws——自带原生 MCP 模式,并由 Google 持续开发。
支持的 API
- Drive — 文件、文件夹、共享、权限
- Gmail — 邮件、标签、草稿、发送
- Calendar — 事件、日历、邀请
- Sheets — 表格、值、格式
- Docs — 文档读写
- Chat — 聊天室、消息
- Admin — 用户、群组、组织单元
- Tasks — 任务列表、任务
- Meet — 会议资源
- ……以及通过 Discovery Service 可用的所有其他 Workspace API
安装
npm install -g @googleworkspace/cli
# 或:cargo install --git https://github.com/googleworkspace/cli --locked
# 或:nix run github:googleworkspace/cli
验证:
gws --version
认证(一次性设置必需)
⚠️ 认证需手动操作——每个账号仅需设置一次 OAuth 凭据。方案 A:使用 gcloud(最快)
gws auth setup # 创建 GCP 项目、启用 API、登录
gws auth login # 后续登录 / 变更权限范围
方案 B:无 gcloud(手动 GCP 控制台)
- 访问 console.cloud.google.com → 创建项目
- 启用 Workspace API(Drive、Gmail、Calendar 等)
- 创建 OAuth 2.0 客户端 ID(桌面应用类型)
- 下载凭据 JSON
- 设置:
export GOOGLE_WORKSPACE_CLI_CREDENTIALS_FILE=/path/to/credentials.json - 运行:
gws auth login
方案 C:服务账号(服务器/无头)
export GOOGLE_WORKSPACE_CLI_CREDENTIALS_FILE=/path/to/service-account.json
凭据使用 OS 密钥环进行 AES-256-GCM 加密存储。基本用法
# 列出最近 10 个 Drive 文件 gws drive files list --params '{"pageSize": 10}'# 创建电子表格 gws sheets spreadsheets create --json '{"properties": {"title": "Q1 Budget"}}'
# 列出 Gmail 邮件 gws gmail users messages list --params '{"userId": "me", "maxResults": 5}'
# 发送 Gmail 邮件 gws gmail users messages send --params '{"userId": "me"}' --json '{"raw": ""}'
# 查看任意方法的模式 gws schema drive.files.list
# 流式分页结果 gws drive files list --params '{"pageSize": 100}' --page-all | jq -r '.files[].name'
# 试运行(仅预览请求,不执行) gws chat spaces messages create --params '{"parent": "spaces/xyz"}' --json '{"text": "test"}' --dry-run
MCP 服务器模式(AI 代理使用)
gws 可作为 MCP 服务器,将所有 Workspace API 以结构化工具形式暴露给 Claude、Cursor、VS Code 等。
# 启动 MCP 服务器(全部服务) gws mcp# 仅启动指定服务(推荐) gws mcp -s drive,gmail,calendar
# 紧凑模式——将 200–400 个工具压缩为约 26 个元工具(节省上下文) gws mcp -s drive,gmail,calendar --tool-mode compact
添加到代理配置(如 OpenClaw / mcporter):
{
"mcpServers": {
"google-workspace": {
"command": "gws",
"args": ["mcp", "-s", "drive,gmail,calendar,sheets,docs", "--tool-mode", "compact"]
}
}
}
OpenClaw 代理用法
完成认证后,代理可:- 读/发 Gmail → 自动化邮件流程
- 读/写 Calendar → 安排会议、解析空闲时间
- 读/写 Sheets → 记录数据、拉取报表
- 管理 Drive → 整理文件、共享文档
- Chat → 向 Google Chat 聊天室发送通知
示例——列出最近邮件:
gws gmail users messages list --params '{"userId": "me", "maxResults": 10, "q": "is:unread"}'
注意事项
- 认证为手动(一次性)——首次使用前必须完成
gws auth setup - 活跃开发中——v1.0 之前可能出现破坏性变更;请查看 GitHub 获取最新信息
- 官方 Google 组织——由 GitHub 上
googleworkspace发布,非第三方 - 无样板代码——结构化 JSON 输出,可直接配合
jq与脚本使用 - 原生 MCP——一条命令即可将任意 Workspace API 暴露为 MCP 工具
状态
- 可行性: ✅ 高 —— 官方 Google 组织、原生 MCP、npm 一键安装
- 认证障碍: ⚠️ 需一次性手动
gws auth setup(需 GCP 项目) - 替代建议: 相比 gcloud 脚本更优——随 Google API 表面自动更新