@gguf/claw 2026.2.1 → 2026.2.3

package/docs/zh-CN/gateway/heartbeat.md

@@ -0,0 +1,274 @@
+---
+read_when:
+  - 调整心跳频率或消息内容时
+  - 在心跳和定时任务之间做选择时
+summary: 心跳轮询消息和通知规则
+title: 心跳
+x-i18n:
+  generated_at: "2026-02-01T20:26:52Z"
+  model: claude-opus-4-5
+  provider: pi
+  source_hash: 18b017066aa2c41811b985564dd389834906f4576e85b576fb357a0eff482e69
+  source_path: gateway/heartbeat.md
+  workflow: 14
+---
+
+# 心跳（Gateway网关）
+
+> **心跳还是定时任务？** 参见 [定时任务与心跳对比](/automation/cron-vs-heartbeat) 了解何时使用哪种方式。
+
+心跳在主会话中运行**定期智能体对话轮次**，以便模型在不打扰你的情况下主动呈现需要关注的事项。
+
+## 快速入门（新手）
+
+1. 保持心跳启用（默认间隔为 `30m`，Anthropic OAuth/setup-token 模式下为 `1h`），或设置自定义频率。
+2. 在智能体工作区中创建一个简短的 `HEARTBEAT.md` 检查清单（可选但推荐）。
+3. 决定心跳消息发送到哪里（默认为 `target: "last"`）。
+4. 可选：启用心跳推理内容投递以提高透明度。
+5. 可选：将心跳限制在活跃时段（本地时间）。
+
+配置示例：
+
+```json5
+{
+  agents: {
+    defaults: {
+      heartbeat: {
+        every: "30m",
+        target: "last",
+        // activeHours: { start: "08:00", end: "24:00" },
+        // includeReasoning: true, // 可选：同时发送单独的 `Reasoning:` 消息
+      },
+    },
+  },
+}
+```
+
+## 默认值
+
+- 间隔：`30m`（当检测到 Anthropic OAuth/setup-token 认证模式时为 `1h`）。通过 `agents.defaults.heartbeat.every` 或按智能体 `agents.list[].heartbeat.every` 设置；使用 `0m` 禁用。
+- 提示词正文（可通过 `agents.defaults.heartbeat.prompt` 配置）：
+  `Read HEARTBEAT.md if it exists (workspace context). Follow it strictly. Do not infer or repeat old tasks from prior chats. If nothing needs attention, reply HEARTBEAT_OK.`
+- 心跳提示词作为用户消息**原样**发送。系统提示词包含"Heartbeat"部分，且运行在内部标记为心跳。
+- 活跃时段（`heartbeat.activeHours`）按配置的时区检查。在窗口外，心跳将被跳过，直到下一个处于窗口内的时刻。
+
+## 心跳提示词的用途
+
+默认提示词有意设计得比较宽泛：
+
+- **后台任务**："Consider outstanding tasks" 促使智能体检查待办事项（收件箱、日历、提醒、排队工作）并呈现紧急事项。
+- **关怀用户**："Checkup sometimes on your human during day time" 促使偶尔发送一条轻量级的"需要什么帮助吗？"消息，但通过使用你配置的本地时区避免夜间打扰（参见 [/concepts/timezone](/concepts/timezone)）。
+
+如果你希望心跳执行非常具体的任务（例如"检查 Gmail PubSub 统计"或"验证 Gateway网关健康状态"），请将 `agents.defaults.heartbeat.prompt`（或 `agents.list[].heartbeat.prompt`）设置为自定义内容（原样发送）。
+
+## 响应约定
+
+- 如果没有需要关注的事项，回复 **`HEARTBEAT_OK`**。
+- 在心跳运行期间，当 `HEARTBEAT_OK` 出现在回复的**开头或结尾**时，OpenClaw 将其视为确认。该标记会被移除，如果剩余内容 **≤ `ackMaxChars`**（默认：300），则整条回复被丢弃。
+- 如果 `HEARTBEAT_OK` 出现在回复的**中间**，则不做特殊处理。
+- 对于告警，**不要**包含 `HEARTBEAT_OK`；只返回告警文本。
+
+在心跳之外，消息开头或结尾的多余 `HEARTBEAT_OK` 会被移除并记录日志；仅包含 `HEARTBEAT_OK` 的消息将被丢弃。
+
+## 配置
+
+```json5
+{
+  agents: {
+    defaults: {
+      heartbeat: {
+        every: "30m", // 默认：30m（0m 禁用）
+        model: "anthropic/claude-opus-4-5",
+        includeReasoning: false, // 默认：false（可用时投递单独的 Reasoning: 消息）
+        target: "last", // last | none | <渠道 id>（核心或插件，例如 "bluebubbles"）
+        to: "+15551234567", // 可选的渠道特定覆盖
+        prompt: "Read HEARTBEAT.md if it exists (workspace context). Follow it strictly. Do not infer or repeat old tasks from prior chats. If nothing needs attention, reply HEARTBEAT_OK.",
+        ackMaxChars: 300, // HEARTBEAT_OK 之后允许的最大字符数
+      },
+    },
+  },
+}
+```
+
+### 作用域和优先级
+
+- `agents.defaults.heartbeat` 设置全局心跳行为。
+- `agents.list[].heartbeat` 在其之上合并；如果任何智能体有 `heartbeat` 块，则**只有这些智能体**运行心跳。
+- `channels.defaults.heartbeat` 为所有渠道设置可见性默认值。
+- `channels.<channel>.heartbeat` 覆盖渠道默认值。
+- `channels.<channel>.accounts.<id>.heartbeat`（多账户渠道）覆盖按渠道的设置。
+
+### 按智能体心跳
+
+如果任何 `agents.list[]` 条目包含 `heartbeat` 块，则**只有这些智能体**运行心跳。按智能体的块在 `agents.defaults.heartbeat` 之上合并（因此你可以设置一次共享默认值，然后按智能体覆盖）。
+
+示例：两个智能体，只有第二个运行心跳。
+
+```json5
+{
+  agents: {
+    defaults: {
+      heartbeat: {
+        every: "30m",
+        target: "last",
+      },
+    },
+    list: [
+      { id: "main", default: true },
+      {
+        id: "ops",
+        heartbeat: {
+          every: "1h",
+          target: "whatsapp",
+          to: "+15551234567",
+          prompt: "Read HEARTBEAT.md if it exists (workspace context). Follow it strictly. Do not infer or repeat old tasks from prior chats. If nothing needs attention, reply HEARTBEAT_OK.",
+        },
+      },
+    ],
+  },
+}
+```
+
+### 字段说明
+
+- `every`：心跳间隔（时长字符串；默认单位 = 分钟）。
+- `model`：可选的心跳运行模型覆盖（`provider/model`）。
+- `includeReasoning`：启用后，在可用时还会投递一条以 `Reasoning:` 为前缀的单独消息（与 `/reasoning on` 格式相同）。
+- `session`：可选的心跳运行会话键。
+  - `main`（默认）：智能体主会话。
+  - 显式会话键（从 `openclaw sessions --json` 或[会话 CLI](/cli/sessions) 复制）。
+  - 会话键格式：参见[会话](/concepts/session)和[群组](/concepts/groups)。
+- `target`：
+  - `last`（默认）：投递到最近使用的外部渠道。
+  - 显式渠道：`whatsapp` / `telegram` / `discord` / `googlechat` / `slack` / `msteams` / `signal` / `imessage`。
+  - `none`：运行心跳但**不投递**到外部。
+- `to`：可选的接收者覆盖（渠道特定 ID，例如 WhatsApp 的 E.164 格式或 Telegram 聊天 ID）。
+- `prompt`：覆盖默认提示词正文（不合并）。
+- `ackMaxChars`：`HEARTBEAT_OK` 之后在投递前允许的最大字符数。
+
+## 投递行为
+
+- 心跳默认在智能体的主会话中运行（`agent:<id>:<mainKey>`），或在 `session.scope = "global"` 时为 `global`。设置 `session` 可覆盖为特定渠道会话（Discord/WhatsApp 等）。
+- `session` 仅影响运行上下文；投递由 `target` 和 `to` 控制。
+- 要投递到特定渠道/接收者，设置 `target` + `to`。使用 `target: "last"` 时，投递使用该会话的最近外部渠道。
+- 如果主队列繁忙，心跳将被跳过并稍后重试。
+- 如果 `target` 解析不到外部目标，运行仍会执行但不发送出站消息。
+- 仅包含心跳的回复**不会**保持会话活跃；`updatedAt` 会被恢复，因此空闲过期行为正常。
+
+## 可见性控制
+
+默认情况下，`HEARTBEAT_OK` 确认会被抑制，而告警内容会被投递。你可以按渠道或按账户调整：
+
+```yaml
+channels:
+  defaults:
+    heartbeat:
+      showOk: false # 隐藏 HEARTBEAT_OK（默认）
+      showAlerts: true # 显示告警消息（默认）
+      useIndicator: true # 发送指示器事件（默认）
+  telegram:
+    heartbeat:
+      showOk: true # 在 Telegram 上显示 OK 确认
+  whatsapp:
+    accounts:
+      work:
+        heartbeat:
+          showAlerts: false # 抑制该账户的告警投递
+```
+
+优先级：按账户 → 按渠道 → 渠道默认值 → 内置默认值。
+
+### 各标志的作用
+
+- `showOk`：当模型返回仅含 OK 的回复时，发送 `HEARTBEAT_OK` 确认。
+- `showAlerts`：当模型返回非 OK 回复时，发送告警内容。
+- `useIndicator`：为 UI 状态展示面板发送指示器事件。
+
+如果**三者全部**为 false，OpenClaw 将完全跳过心跳运行（不调用模型）。
+
+### 按渠道与按账户示例
+
+```yaml
+channels:
+  defaults:
+    heartbeat:
+      showOk: false
+      showAlerts: true
+      useIndicator: true
+  slack:
+    heartbeat:
+      showOk: true # 所有 Slack 账户
+    accounts:
+      ops:
+        heartbeat:
+          showAlerts: false # 仅抑制 ops 账户的告警
+  telegram:
+    heartbeat:
+      showOk: true
+```
+
+### 常见模式
+
+| 目标                          | 配置                                                                                     |
+| ----------------------------- | ---------------------------------------------------------------------------------------- |
+| 默认行为（静默 OK，告警开启） | _（无需配置）_                                                                           |
+| 完全静默（无消息，无指示器）  | `channels.defaults.heartbeat: { showOk: false, showAlerts: false, useIndicator: false }` |
+| 仅指示器（无消息）            | `channels.defaults.heartbeat: { showOk: false, showAlerts: false, useIndicator: true }`  |
+| 仅在一个渠道显示 OK           | `channels.telegram.heartbeat: { showOk: true }`                                          |
+
+## HEARTBEAT.md（可选）
+
+如果工作区中存在 `HEARTBEAT.md` 文件，默认提示词会告诉智能体读取它。把它当作你的"心跳检查清单"：简短、稳定，可以安全地每 30 分钟包含一次。
+
+如果 `HEARTBEAT.md` 存在但实际为空（仅包含空行和 markdown 标题如 `# Heading`），OpenClaw 将跳过心跳运行以节省 API 调用。如果文件不存在，心跳仍会运行，由模型决定做什么。
+
+保持内容简短（简短的检查清单或提醒），避免提示词膨胀。
+
+`HEARTBEAT.md` 示例：
+
+```md
+# Heartbeat checklist
+
+- Quick scan: anything urgent in inboxes?
+- If it's daytime, do a lightweight check-in if nothing else is pending.
+- If a task is blocked, write down _what is missing_ and ask Peter next time.
+```
+
+### 智能体可以更新 HEARTBEAT.md 吗？
+
+可以——只要你让它这样做。
+
+`HEARTBEAT.md` 只是智能体工作区中的一个普通文件，所以你可以在正常聊天中告诉智能体：
+
+- "更新 `HEARTBEAT.md`，添加每日日历检查。"
+- "重写 `HEARTBEAT.md`，使其更简短，专注于收件箱跟进。"
+
+如果你希望这种更新主动发生，也可以在心跳提示词中包含明确的指示，例如："如果检查清单变得过时，请用更好的内容更新 HEARTBEAT.md。"
+
+安全提示：不要在 `HEARTBEAT.md` 中放入敏感信息（API 密钥、电话号码、私有令牌）——它会成为提示词上下文的一部分。
+
+## 手动唤醒（按需）
+
+你可以排入系统事件并立即触发心跳：
+
+```bash
+openclaw system event --text "Check for urgent follow-ups" --mode now
+```
+
+如果多个智能体配置了 `heartbeat`，手动唤醒会立即运行每个智能体的心跳。
+
+使用 `--mode next-heartbeat` 等待下一个计划时刻。
+
+## 推理内容投递（可选）
+
+默认情况下，心跳仅投递最终的"回答"载荷。
+
+如果你需要透明度，请启用：
+
+- `agents.defaults.heartbeat.includeReasoning: true`
+
+启用后，心跳还会投递一条以 `Reasoning:` 为前缀的单独消息（与 `/reasoning on` 格式相同）。当智能体管理多个会话/代码库，而你想了解它为什么决定联系你时，这很有用——但它也可能泄露比你期望的更多内部细节。建议在群聊中保持关闭。
+
+## 成本意识
+
+心跳运行完整的智能体对话轮次。更短的间隔消耗更多令牌。保持 `HEARTBEAT.md` 简短，如果你只需要内部状态更新，考虑使用更便宜的 `model` 或 `target: "none"`。

package/docs/zh-CN/gateway/index.md

@@ -0,0 +1,328 @@
+---
+read_when:
+  - 运行或调试 Gateway网关进程时
+summary: Gateway网关服务的运维手册、生命周期与操作指南
+title: Gateway网关运维手册
+x-i18n:
+  generated_at: "2026-02-01T20:40:09Z"
+  model: claude-opus-4-5
+  provider: pi
+  source_hash: 497d58090faaa6bdae62780ce887b40a1ad81e2e99ff186ea2a5c2249c35d9ba
+  source_path: gateway/index.md
+  workflow: 14
+---
+
+# Gateway网关服务运维手册
+
+最后更新：2025-12-09
+
+## 简介
+
+- 始终运行的进程，拥有唯一的 Baileys/Telegram 连接以及控制/事件平面。
+- 替代旧版 `gateway` 命令。CLI 入口：`openclaw gateway`。
+- 持续运行直到被停止；遇到致命错误时以非零状态退出，以便 supervisor 重启。
+
+## 如何运行（本地）
+
+```bash
+openclaw gateway --port 18789
+# 在标准输出中获取完整的调试/跟踪日志：
+openclaw gateway --port 18789 --verbose
+# 如果端口被占用，先终止监听进程再启动：
+openclaw gateway --force
+# 开发循环（TS 文件变更时自动重载）：
+pnpm gateway:watch
+```
+
+- 配置热重载会监视 `~/.openclaw/openclaw.json`（或 `OPENCLAW_CONFIG_PATH`）。
+  - 默认模式：`gateway.reload.mode="hybrid"`（安全变更热应用，关键变更则重启）。
+  - 热重载在需要时通过 **SIGUSR1** 进行进程内重启。
+  - 通过 `gateway.reload.mode="off"` 禁用。
+- WebSocket 控制平面绑定到 `127.0.0.1:<port>`（默认 18789）。
+- 同一端口也提供 HTTP 服务（控制 UI、钩子、A2UI）。单端口复用。
+  - OpenAI Chat Completions (HTTP)：[`/v1/chat/completions`](/gateway/openai-http-api)。
+  - OpenResponses (HTTP)：[`/v1/responses`](/gateway/openresponses-http-api)。
+  - Tools Invoke (HTTP)：[`/tools/invoke`](/gateway/tools-invoke-http-api)。
+- 默认在 `canvasHost.port`（默认 `18793`）启动 Canvas 文件服务器，从 `~/.openclaw/workspace/canvas` 提供 `http://<gateway-host>:18793/__openclaw__/canvas/` 服务。通过 `canvasHost.enabled=false` 或 `OPENCLAW_SKIP_CANVAS_HOST=1` 禁用。
+- 日志输出到标准输出；使用 launchd/systemd 保持进程存活并轮转日志。
+- 传入 `--verbose` 可在故障排除时将调试日志（握手、请求/响应、事件）从日志文件镜像到标准输出。
+- `--force` 使用 `lsof` 查找所选端口上的监听进程，发送 SIGTERM，记录被终止的进程，然后启动 Gateway网关（如果缺少 `lsof` 则快速失败）。
+- 如果在 supervisor（launchd/systemd/mac app 子进程模式）下运行，停止/重启通常发送 **SIGTERM**；旧版本可能将其显示为 `pnpm` `ELIFECYCLE` 退出码 **143**（SIGTERM），这是正常关闭，不是崩溃。
+- **SIGUSR1** 在授权时触发进程内重启（Gateway网关工具/配置应用/更新，或启用 `commands.restart` 以进行手动重启）。
+- 默认需要 Gateway网关认证：设置 `gateway.auth.token`（或 `OPENCLAW_GATEWAY_TOKEN`）或 `gateway.auth.password`。客户端必须发送 `connect.params.auth.token/password`，除非使用 Tailscale Serve 身份。
+- 向导现在默认生成令牌，即使在 local loopback 上也是如此。
+- 端口优先级：`--port` > `OPENCLAW_GATEWAY_PORT` > `gateway.port` > 默认 `18789`。
+
+## 远程访问
+
+- 推荐使用 Tailscale/VPN；否则使用 SSH 隧道：
+  ```bash
+  ssh -N -L 18789:127.0.0.1:18789 user@host
+  ```
+- 客户端通过隧道连接到 `ws://127.0.0.1:18789`。
+- 如果配置了令牌，客户端即使通过隧道也必须在 `connect.params.auth.token` 中包含令牌。
+
+## 多个 Gateway网关（同一主机）
+
+通常不需要：一个 Gateway网关可以服务多个消息渠道和智能体。仅在需要冗余或严格隔离（例如：救援机器人）时使用多个 Gateway网关。
+
+如果隔离状态 + 配置并使用唯一端口，则支持多实例。完整指南：[多 Gateway网关](/gateway/multiple-gateways)。
+
+服务名称是配置文件感知的：
+
+- macOS：`bot.molt.<profile>`（旧版 `com.openclaw.*` 可能仍然存在）
+- Linux：`openclaw-gateway-<profile>.service`
+- Windows：`OpenClaw Gateway网关 (<profile>)`
+
+安装元数据嵌入在服务配置中：
+
+- `OPENCLAW_SERVICE_MARKER=openclaw`
+- `OPENCLAW_SERVICE_KIND=gateway`
+- `OPENCLAW_SERVICE_VERSION=<version>`
+
+救援机器人模式：保持第二个 Gateway网关隔离，使用独立的配置文件、状态目录、工作区和基础端口间距。完整指南：[救援机器人指南](/gateway/multiple-gateways#rescue-bot-guide)。
+
+### 开发配置文件（`--dev`）
+
+快速路径：运行完全隔离的开发实例（配置/状态/工作区），不影响主要设置。
+
+```bash
+openclaw --dev setup
+openclaw --dev gateway --allow-unconfigured
+# 然后指向开发实例：
+openclaw --dev status
+openclaw --dev health
+```
+
+默认值（可通过环境变量/标志/配置覆盖）：
+
+- `OPENCLAW_STATE_DIR=~/.openclaw-dev`
+- `OPENCLAW_CONFIG_PATH=~/.openclaw-dev/openclaw.json`
+- `OPENCLAW_GATEWAY_PORT=19001`（Gateway网关 WS + HTTP）
+- 浏览器控制服务端口 = `19003`（派生：`gateway.port+2`，仅 local loopback）
+- `canvasHost.port=19005`（派生：`gateway.port+4`）
+- 在 `--dev` 下运行 `setup`/`onboard` 时，`agents.defaults.workspace` 默认变为 `~/.openclaw/workspace-dev`。
+
+派生端口（经验规则）：
+
+- 基础端口 = `gateway.port`（或 `OPENCLAW_GATEWAY_PORT` / `--port`）
+- 浏览器控制服务端口 = 基础端口 + 2（仅 local loopback）
+- `canvasHost.port = 基础端口 + 4`（或 `OPENCLAW_CANVAS_HOST_PORT` / 配置覆盖）
+- 浏览器配置文件 CDP 端口从 `browser.controlPort + 9 .. + 108` 自动分配（按配置文件持久化）。
+
+每个实例的检查清单：
+
+- 唯一的 `gateway.port`
+- 唯一的 `OPENCLAW_CONFIG_PATH`
+- 唯一的 `OPENCLAW_STATE_DIR`
+- 唯一的 `agents.defaults.workspace`
+- 独立的 WhatsApp 号码（如果使用 WA）
+
+按配置文件安装服务：
+
+```bash
+openclaw --profile main gateway install
+openclaw --profile rescue gateway install
+```
+
+示例：
+
+```bash
+OPENCLAW_CONFIG_PATH=~/.openclaw/a.json OPENCLAW_STATE_DIR=~/.openclaw-a openclaw gateway --port 19001
+OPENCLAW_CONFIG_PATH=~/.openclaw/b.json OPENCLAW_STATE_DIR=~/.openclaw-b openclaw gateway --port 19002
+```
+
+## 协议（运维视角）
+
+- 完整文档：[Gateway网关协议](/gateway/protocol) 和 [Bridge 协议（旧版）](/gateway/bridge-protocol)。
+- 客户端必须发送的第一帧：`req {type:"req", id, method:"connect", params:{minProtocol,maxProtocol,client:{id,displayName?,version,platform,deviceFamily?,modelIdentifier?,mode,instanceId?}, caps, auth?, locale?, userAgent? } }`。
+- Gateway网关回复 `res {type:"res", id, ok:true, payload:hello-ok }`（或 `ok:false` 附带错误信息，然后关闭连接）。
+- 握手完成后：
+  - 请求：`{type:"req", id, method, params}` → `{type:"res", id, ok, payload|error}`
+  - 事件：`{type:"event", event, payload, seq?, stateVersion?}`
+- 结构化在线状态条目：`{host, ip, version, platform?, deviceFamily?, modelIdentifier?, mode, lastInputSeconds?, ts, reason?, tags?[], instanceId? }`（对于 WS 客户端，`instanceId` 来自 `connect.client.instanceId`）。
+- `agent` 响应分两个阶段：首先是 `res` 确认 `{runId,status:"accepted"}`，然后在运行完成后发送最终 `res` `{runId,status:"ok"|"error",summary}`；流式输出以 `event:"agent"` 形式到达。
+
+## 方法（初始集合）
+
+- `health` — 完整健康快照（与 `openclaw health --json` 形状相同）。
+- `status` — 简短摘要。
+- `system-presence` — 当前在线状态列表。
+- `system-event` — 发布在线状态/系统通知（结构化）。
+- `send` — 通过活跃渠道发送消息。
+- `agent` — 运行智能体回合（在同一连接上流式返回事件）。
+- `node.list` — 列出已配对 + 当前已连接的节点（包括 `caps`、`deviceFamily`、`modelIdentifier`、`paired`、`connected` 以及已通告的 `commands`）。
+- `node.describe` — 描述节点（能力 + 支持的 `node.invoke` 命令；适用于已配对节点和当前已连接的未配对节点）。
+- `node.invoke` — 在节点上调用命令（例如 `canvas.*`、`camera.*`）。
+- `node.pair.*` — 配对生命周期（`request`、`list`、`approve`、`reject`、`verify`）。
+
+另请参阅：[在线状态](/concepts/presence) 了解在线状态的生成/去重方式以及稳定的 `client.instanceId` 为何重要。
+
+## 事件
+
+- `agent` — 来自智能体运行的流式工具/输出事件（带 seq 标签）。
+- `presence` — 在线状态更新（带 stateVersion 的增量）推送给所有已连接的客户端。
+- `tick` — 定期心跳/空操作，确认活跃性。
+- `shutdown` — Gateway网关正在退出；负载包含 `reason` 和可选的 `restartExpectedMs`。客户端应重新连接。
+
+## WebChat 集成
+
+- WebChat 是原生 SwiftUI UI，直接通过 Gateway网关 WebSocket 进行历史记录、发送、中止和事件交互。
+- 远程使用通过相同的 SSH/Tailscale 隧道；如果配置了 Gateway网关令牌，客户端在 `connect` 时包含它。
+- macOS 应用通过单个 WS（共享连接）连接；它从初始快照中获取在线状态，并监听 `presence` 事件以更新 UI。
+
+## 类型与验证
+
+- 服务器使用 AJV 根据协议定义生成的 JSON Schema 验证每个入站帧。
+- 客户端（TS/Swift）使用生成的类型（TS 直接使用；Swift 通过仓库的生成器）。
+- 协议定义是唯一的事实来源；通过以下命令重新生成 schema/模型：
+  - `pnpm protocol:gen`
+  - `pnpm protocol:gen:swift`
+
+## 连接快照
+
+- `hello-ok` 包含一个 `snapshot`，其中有 `presence`、`health`、`stateVersion` 和 `uptimeMs`，以及 `policy {maxPayload,maxBufferedBytes,tickIntervalMs}`，使客户端无需额外请求即可立即渲染。
+- `health`/`system-presence` 仍可用于手动刷新，但在连接时不是必需的。
+
+## 错误码（res.error 结构）
+
+- 错误使用 `{ code, message, details?, retryable?, retryAfterMs? }` 格式。
+- 标准错误码：
+  - `NOT_LINKED` — WhatsApp 未认证。
+  - `AGENT_TIMEOUT` — 智能体未在配置的截止时间内响应。
+  - `INVALID_REQUEST` — schema/参数验证失败。
+  - `UNAVAILABLE` — Gateway网关正在关闭或依赖不可用。
+
+## 心跳行为
+
+- `tick` 事件（或 WS ping/pong）会定期发出，以便客户端在没有流量时也能知道 Gateway网关处于活跃状态。
+- 发送/智能体确认仍为独立响应；不要将 tick 用于发送。
+
+## 重放/间隙
+
+- 事件不会重放。客户端检测到 seq 间隙后，应在继续之前刷新（`health` + `system-presence`）。WebChat 和 macOS 客户端现在会在检测到间隙时自动刷新。
+
+## 进程监管（macOS 示例）
+
+- 使用 launchd 保持服务存活：
+  - Program：`openclaw` 的路径
+  - Arguments：`gateway`
+  - KeepAlive：true
+  - StandardOut/Err：文件路径或 `syslog`
+- 失败时 launchd 会重启；致命的配置错误应持续退出，以便运维人员注意到。
+- LaunchAgents 是按用户的，需要已登录的会话；对于无头设置，请使用自定义 LaunchDaemon（未随附）。
+  - `openclaw gateway install` 写入 `~/Library/LaunchAgents/bot.molt.gateway.plist`
+    （或 `bot.molt.<profile>.plist`；旧版 `com.openclaw.*` 会被清理）。
+  - `openclaw doctor` 审计 LaunchAgent 配置，并可将其更新为当前推荐的默认值。
+
+## Gateway网关服务管理（CLI）
+
+使用 Gateway网关 CLI 进行安装/启动/停止/重启/状态查询：
+
+```bash
+openclaw gateway status
+openclaw gateway install
+openclaw gateway stop
+openclaw gateway restart
+openclaw logs --follow
+```
+
+注意事项：
+
+- `gateway status` 默认使用服务解析的端口/配置探测 Gateway网关 RPC（可通过 `--url` 覆盖）。
+- `gateway status --deep` 添加系统级扫描（LaunchDaemons/系统单元）。
+- `gateway status --no-probe` 跳过 RPC 探测（在网络不可用时有用）。
+- `gateway status --json` 输出稳定，适用于脚本。
+- `gateway status` 将 **supervisor 运行时**（launchd/systemd 运行中）与 **RPC 可达性**（WS 连接 + 状态 RPC）分开报告。
+- `gateway status` 打印配置路径 + 探测目标，以避免"localhost vs LAN 绑定"混淆和配置文件不匹配。
+- `gateway status` 在服务看起来正在运行但端口已关闭时包含最后一条 Gateway网关错误行。
+- `logs` 通过 RPC 跟踪 Gateway网关文件日志（无需手动 `tail`/`grep`）。
+- 如果检测到其他类似 Gateway网关的服务，CLI 会发出警告，除非它们是 OpenClaw 配置文件服务。
+  我们仍建议大多数场景下**每台机器一个 Gateway网关**；使用隔离的配置文件/端口实现冗余或救援机器人。参见 [多 Gateway网关](/gateway/multiple-gateways)。
+  - 清理：`openclaw gateway uninstall`（当前服务）和 `openclaw doctor`（旧版迁移）。
+- `gateway install` 在已安装时为空操作；使用 `openclaw gateway install --force` 重新安装（配置文件/环境/路径变更）。
+
+捆绑的 Mac 应用：
+
+- OpenClaw.app 可以捆绑一个基于 Node 的 Gateway网关中继，并安装按用户的 LaunchAgent，标签为
+  `bot.molt.gateway`（或 `bot.molt.<profile>`；旧版 `com.openclaw.*` 标签仍可正常卸载）。
+- 要正常停止，使用 `openclaw gateway stop`（或 `launchctl bootout gui/$UID/bot.molt.gateway`）。
+- 要重启，使用 `openclaw gateway restart`（或 `launchctl kickstart -k gui/$UID/bot.molt.gateway`）。
+  - `launchctl` 仅在 LaunchAgent 已安装时有效；否则先使用 `openclaw gateway install`。
+  - 运行命名配置文件时，将标签替换为 `bot.molt.<profile>`。
+
+## 进程监管（systemd 用户单元）
+
+OpenClaw 在 Linux/WSL2 上默认安装 **systemd 用户服务**。我们推荐单用户机器使用用户服务（更简单的环境，按用户配置）。对于多用户或始终在线的服务器，使用**系统服务**（无需 lingering，共享监管）。
+
+`openclaw gateway install` 写入用户单元。`openclaw doctor` 审计该单元，并可将其更新为当前推荐的默认值。
+
+创建 `~/.config/systemd/user/openclaw-gateway[-<profile>].service`：
+
+```
+[Unit]
+Description=OpenClaw Gateway网关 (profile: <profile>, v<version>)
+After=network-online.target
+Wants=network-online.target
+
+[Service]
+ExecStart=/usr/local/bin/openclaw gateway --port 18789
+Restart=always
+RestartSec=5
+Environment=OPENCLAW_GATEWAY_TOKEN=
+WorkingDirectory=/home/youruser
+
+[Install]
+WantedBy=default.target
+```
+
+启用 lingering（必需，以便用户服务在注销/空闲后继续运行）：
+
+```
+sudo loginctl enable-linger youruser
+```
+
+新手引导在 Linux/WSL2 上会运行此命令（可能提示输入 sudo 密码；写入 `/var/lib/systemd/linger`）。
+然后启用服务：
+
+```
+systemctl --user enable --now openclaw-gateway[-<profile>].service
+```
+
+**替代方案（系统服务）** - 对于始终在线或多用户服务器，可以安装 systemd **系统**单元而非用户单元（无需 lingering）。创建 `/etc/systemd/system/openclaw-gateway[-<profile>].service`（复制上述单元，将 `WantedBy=multi-user.target`，设置 `User=` + `WorkingDirectory=`），然后：
+
+```
+sudo systemctl daemon-reload
+sudo systemctl enable --now openclaw-gateway[-<profile>].service
+```
+
+## Windows (WSL2)
+
+Windows 安装应使用 **WSL2** 并遵循上述 Linux systemd 部分。
+
+## 运维检查
+
+- 存活性：打开 WS 并发送 `req:connect` → 期望收到带有 `payload.type="hello-ok"`（含快照）的 `res`。
+- 就绪性：调用 `health` → 期望 `ok: true` 且 `linkChannel` 中有已连接的渠道（适用时）。
+- 调试：订阅 `tick` 和 `presence` 事件；确保 `status` 显示已连接/认证时间；在线状态条目显示 Gateway网关主机和已连接的客户端。
+
+## 安全保证
+
+- 默认假设每台主机一个 Gateway网关；如果运行多个配置文件，请隔离端口/状态并指向正确的实例。
+- 不会回退到直接 Baileys 连接；如果 Gateway网关不可用，发送会快速失败。
+- 非 connect 的首帧或格式错误的 JSON 会被拒绝并关闭 socket。
+- 优雅关闭：关闭前发出 `shutdown` 事件；客户端必须处理关闭 + 重新连接。
+
+## CLI 辅助工具
+
+- `openclaw gateway health|status` — 通过 Gateway网关 WS 请求健康/状态信息。
+- `openclaw message send --target <num> --message "hi" [--media ...]` — 通过 Gateway网关发送（对 WhatsApp 具有幂等性）。
+- `openclaw agent --message "hi" --to <num>` — 运行智能体回合（默认等待最终结果）。
+- `openclaw gateway call <method> --params '{"k":"v"}'` — 用于调试的原始方法调用器。
+- `openclaw gateway stop|restart` — 停止/重启受监管的 Gateway网关服务（launchd/systemd）。
+- Gateway网关辅助子命令假设 Gateway网关已在 `--url` 上运行；它们不再自动启动 Gateway网关。
+
+## 迁移指南
+
+- 弃用 `openclaw gateway` 和旧版 TCP 控制端口的用法。
+- 更新客户端以使用带有强制 connect 和结构化在线状态的 WS 协议。