title: “Google Workspace — Gmail, Calendar, Drive, Docs, Sheets via gws CLI or Python” sidebar_label: “Google Workspace” description: “Gmail, Calendar, Drive, Docs, Sheets via gws CLI or Python”

{/* 本页面由 website/scripts/generate-skill-docs.py 根据技能对应的 SKILL.md 文件自动生成。请直接编辑源文件 SKILL.md，而非此页面。 */}

Google Workspace

可通过 gws CLI 或 Python 操作 Gmail、Calendar、Drive、Docs、Sheets 等功能。

技能元数据

参考：完整 SKILL.md 内容

:::info 以下是 Hermes 在触发该技能时加载的完整技能定义。当技能处于激活状态时，智能体将依据此内容执行操作。

::

Google Workspace

通过 Hermes 管理的 OAuth 机制及轻量级 CLI 封装层，可操作 Gmail、Calendar、Drive、Contacts、Sheets 和 Docs 等功能。若已安装 gws，该技能将使用其作为执行后端以实现更全面的 Google Workspace 功能支持；否则则回退至内置的 Python 客户端实现。

参考资料

• references/gmail-search-syntax.md — Gmail 搜索操作符（如 is:unread、from:、newer_than: 等）

脚本文件

• scripts/setup.py — OAuth2 配置文件（需运行一次以完成授权）
• scripts/google_api.py — 兼容性封装 CLI。在可用时优先使用 gws 执行操作，同时保持与 Hermes 现有的 JSON 输出格式一致。

首次设置指南

整个设置过程完全无需交互——您只需按步骤操作，即可在 CLI、Telegram、Discord 或任何其他平台上使用该技能。

首先定义一个快捷指令：

GSETUP="python ${HERMES_HOME:-$HOME/.hermes}/skills/productivity/google-workspace/scripts/setup.py"

第0步：检查是否已完成配置

$GSETUP --check

如果输出AUTHENTICATED，则可直接跳至“使用方法”——设置已完成。

第1步：初步评估——询问用户需求

在开始OAuth设置之前，需向用户提出两个问题：

问题1：“您需要哪些Google服务？仅电子邮件，还是还需要日历/云端硬盘/表格/文档？”

• 仅电子邮件 → 他们完全不需要此功能。建议使用himalaya技能——该技能支持通过Gmail应用密码（设置→安全→应用密码）进行认证，设置仅需2分钟，且无需Google Cloud项目。请加载himalaya技能并按照其说明进行设置。

• 电子邮件+日历 → 继续使用当前技能，但在认证时使用--services email,calendar参数，这样授权界面只会显示他们实际需要的权限范围。

• 仅日历/云端硬盘/表格/文档 → 继续使用当前技能，并使用更具体的--services参数组合，如calendar,drive,sheets,docs。

• 需要完整工作区访问权限 → 继续使用当前技能，并使用默认的all服务集合。

问题2：“您的Google账户是否使用了高级保护功能（登录时需硬件安全密钥）？如果您不确定，那很可能没有——因为这是需要您主动启用的功能。”

• 否/不确定 → 按常规流程设置即可，继续下一步。
• 是 → 在执行第4步之前，其工作区管理员必须将OAuth客户端ID添加到组织的允许应用列表中。请提前告知用户这一点。

第2步：创建OAuth凭证（仅需一次，约5分钟）

告知用户：

您需要一个Google Cloud OAuth客户端。这是一个只需操作一次的设置流程：

1. 创建或选择一个项目： https://console.cloud.google.com/projectselector2/home/dashboard
2. 在API库中启用所需的API： https://console.cloud.google.com/apis/library 需要启用的API包括：Gmail API、Google日历API、Google云端硬盘API、Google表格API、Google文档API以及People API。
3. 在此处创建OAuth客户端： https://console.cloud.google.com/apis/credentials 选择“凭证”→“创建凭证”→“OAuth 2.0客户端ID”。
4. 应用类型选择“桌面应用”→点击“创建”。
5. 如果该应用仍处于测试阶段，请在此处将用户的Google账户添加为测试用户： https://console.cloud.google.com/auth/audience 选择“受众”→“测试用户”→“添加用户”。
6. 下载JSON文件，并告知我该文件的路径。

关于Hermes CLI的重要提示：如果文件路径以/开头，切勿在CLI中单独发送该路径作为一条消息，因为这可能会被误认为是斜杠命令。应将其放入句子中发送，例如： JSON文件路径为：/home/user/Downloads/client_secret_....json

一旦用户提供文件路径后：

$GSETUP --client-secret /path/to/client_secret.json

如果他们粘贴的是原始的客户端 ID/客户端密钥值而非文件路径，你需要为他们手动创建一个有效的桌面端 OAuth JSON 文件，并将其保存在显式的位置（例如 ~/Downloads/hermes-google-client-secret.json），之后再使用 --client-secret 参数指定该文件进行操作。

第 3 步：获取授权地址

使用第 1 步中选择的服务集。示例：

$GSETUP --auth-url --services email,calendar --format json
$GSETUP --auth-url --services calendar,drive,sheets,docs --format json
$GSETUP --auth-url --services all --format json

该操作会返回一个包含 auth_url 字段的 JSON 数据，同时会将该完整 URL 保存至 ~/.hermes/google_oauth_last_url.txt 文件中。

针对此步骤的 Agent 规则如下：

• 提取 auth_url 字段，并以单行形式将该完整 URL 发送给用户。
• 告知用户在授权通过后，浏览器在访问 http://localhost:1 时很可能会出错，而这属于正常现象。
• 要求用户从浏览器地址栏复制整个重定向后的 URL。
• 如果用户遇到 Error 403: access_denied 错误，请直接引导其访问 https://console.cloud.google.com/auth/audience，自行添加为测试用户。

第 4 步：交换验证码

用户可以粘贴类似 http://localhost:1/?code=4/0A...&scope=... 的 URL，也可以仅粘贴验证码字符串，两种方式均可。--auth-url 步骤会在本地存储一个临时的待处理 OAuth 会话，这样即便是在无头系统中，--auth-code 步骤也能随后完成 PKCE 验证码交换流程：

$GSETUP --auth-code "THE_URL_OR_CODE_THE_USER_PASTED" --format json

如果由于验证码已过期、已被使用，或是来自旧版本的浏览器标签页，导致使用 --auth-code 参数失败，系统现在会返回一个新的 fresh_auth_url。在这种情况下，请立即将新网址发送给用户，让其仅通过最新的浏览器重定向功能进行尝试。

第 5 步：验证

$GSETUP --check

应输出 AUTHENTICATED 字样，表示设置已完成——此后令牌将自动刷新。

备注

• 令牌存储在 ~/.hermes/google_token.json 文件中，并会自动刷新。
• 待处理的 OAuth 会话状态/验证信息会暂时保存在 ~/.hermes/google_oauth_pending.json 文件中，直至交换完成。
• 若已安装 gws，则 google_api.py 会指向同一个 ~/.hermes/google_token.json 凭证文件。用户无需再执行单独的 gws auth login 操作。
• 如需撤销授权：使用 $GSETUP --revoke 命令。

使用方法

所有命令均通过 API 脚本执行。可将 GAPI 设为快捷指令：

GAPI="python ${HERMES_HOME:-$HOME/.hermes}/skills/productivity/google-workspace/scripts/google_api.py"

Gmail

# Search (returns JSON array with id, from, subject, date, snippet)
$GAPI gmail search "is:unread" --max 10
$GAPI gmail search "from:boss@company.com newer_than:1d"
$GAPI gmail search "has:attachment filename:pdf newer_than:7d"

# Read full message (returns JSON with body text)
$GAPI gmail get MESSAGE_ID

# Send
$GAPI gmail send --to user@example.com --subject "Hello" --body "Message text"
$GAPI gmail send --to user@example.com --subject "Report" --body "<h1>Q4</h1><p>Details...</p>" --html
$GAPI gmail send --to user@example.com --subject "Hello" --from '"Research Agent" <user@example.com>' --body "Message text"

# Reply (automatically threads and sets In-Reply-To)
$GAPI gmail reply MESSAGE_ID --body "Thanks, that works for me."
$GAPI gmail reply MESSAGE_ID --from '"Support Bot" <user@example.com>' --body "Thanks"

# Labels
$GAPI gmail labels
$GAPI gmail modify MESSAGE_ID --add-labels LABEL_ID
$GAPI gmail modify MESSAGE_ID --remove-labels UNREAD

日历功能

# List events (defaults to next 7 days)
$GAPI calendar list
$GAPI calendar list --start 2026-03-01T00:00:00Z --end 2026-03-07T23:59:59Z

# Create event (ISO 8601 with timezone required)
$GAPI calendar create --summary "Team Standup" --start 2026-03-01T10:00:00-06:00 --end 2026-03-01T10:30:00-06:00
$GAPI calendar create --summary "Lunch" --start 2026-03-01T12:00:00Z --end 2026-03-01T13:00:00Z --location "Cafe"
$GAPI calendar create --summary "Review" --start 2026-03-01T14:00:00Z --end 2026-03-01T15:00:00Z --attendees "alice@co.com,bob@co.com"

# Delete event
$GAPI calendar delete EVENT_ID

驱动功能

# Search existing files
$GAPI drive search "quarterly report" --max 10
$GAPI drive search "mimeType='application/pdf'" --raw-query --max 5

# Get metadata for a single file
$GAPI drive get FILE_ID

# Upload a local file (auto-detects MIME type)
$GAPI drive upload /path/to/report.pdf
$GAPI drive upload /path/to/image.png --name "Logo.png" --parent FOLDER_ID

# Download (binary files download as-is; Google-native files export to a
# sensible default — Docs→pdf, Sheets→csv, Slides→pdf, Drawings→png)
$GAPI drive download FILE_ID
$GAPI drive download DOC_ID --output ~/doc.pdf
$GAPI drive download DOC_ID --export-mime text/plain --output ~/doc.txt

# Create a folder
$GAPI drive create-folder "Reports"
$GAPI drive create-folder "Q4" --parent FOLDER_ID

# Share
$GAPI drive share FILE_ID --email alice@example.com --role reader
$GAPI drive share FILE_ID --email alice@example.com --role writer --notify
$GAPI drive share FILE_ID --type anyone --role reader        # anyone with link
$GAPI drive share FILE_ID --type domain --domain example.com --role reader

# Delete — defaults to trash (reversible). Use --permanent to skip the trash.
$GAPI drive delete FILE_ID
$GAPI drive delete FILE_ID --permanent

联系方式

$GAPI contacts list --max 20

表格功能

# Create a new spreadsheet
$GAPI sheets create --title "Q4 Budget"
$GAPI sheets create --title "Inventory" --sheet-name "Stock"

# Read
$GAPI sheets get SHEET_ID "Sheet1!A1:D10"

# Write
$GAPI sheets update SHEET_ID "Sheet1!A1:B2" --values '[["Name","Score"],["Alice","95"]]'

# Append rows
$GAPI sheets append SHEET_ID "Sheet1!A:C" --values '[["new","row","data"]]'

文档资料

# Read
$GAPI docs get DOC_ID

# Create a new Doc (optionally seeded with body text)
$GAPI docs create --title "Meeting Notes"
$GAPI docs create --title "Draft" --body "First paragraph..."

# Append text to the end of an existing Doc
$GAPI docs append DOC_ID --text "Additional content to append"

输出格式

所有命令均返回 JSON 格式的数据。可使用 jq 工具解析，或直接读取。主要字段如下：

• Gmail 搜索：[{id, threadId, from, to, subject, date, snippet, labels}]
• Gmail 获取信息：{id, threadId, from, to, subject, date, labels, body}
• Gmail 发送/回复邮件：{status: "sent", id, threadId}
• 日历列表：[{id, summary, start, end, location, description, htmlLink}]
• 创建日历事件：{status: "created", id, summary, htmlLink}
• Drive 搜索：[{id, name, mimeType, modifiedTime, webViewLink}]
• Drive 获取信息：{id, name, mimeType, modifiedTime, size, webViewLink, parents, owners}
• Drive 上传文件：{status: "uploaded", id, name, mimeType, webViewLink}
• Drive 下载文件：{status: "downloaded", id, name, path, mimeType}
• Drive 创建文件夹：{status: "created", id, name, webViewLink}
• Drive 共享文件：{status: "shared", permissionId, fileId, role, type}
• Drive 删除文件：{status: "trashed" | "deleted", fileId, permanent}
• 联系人列表：[{name, emails: [...], phones: [...]}]
• Sheets 获取数据：[[cell, cell, ...], ...]
• 创建 Sheets 表格：{status: "created", spreadsheetId, title, spreadsheetUrl}
• 创建文档：{status: "created", documentId, title, url}
• 向文档追加内容：{status: "appended", documentId, inserted_at, characters}

规则

1. 未经用户确认，严禁发送邮件、创建/删除日历事件、删除 Drive 文件、共享文件或修改文档/表格内容。 首先需明确说明即将执行的操作（如收件人、文件 ID、内容、共享权限等），并征得用户同意。对于 drive delete 操作，建议优先使用默认的回收站处理方式（可恢复），而非 --permanent 选项。
2. 首次使用时请检查认证状态——运行 setup.py --check 命令。若检测失败，需指导用户完成相关设置。
3. 对于复杂查询，请参考 Gmail 搜索语法指南——可通过 skill_view("google-workspace", file_path="references/gmail-search-syntax.md") 加载该指南。
4. 日历时间必须包含时区信息——始终使用带有时区偏移的 ISO 8601 格式（例如 2026-03-01T10:00:00-06:00），或 UTC 格式（标有 Z）。
5. 需遵守速率限制——避免频繁连续调用 API。尽可能批量读取数据。

故障排除

撤销访问权限

$GSETUP --revoke