mirror of
https://github.com/openclaw/openclaw.git
synced 2026-04-19 11:18:37 +00:00
Docs: normalize zh-CN terminology + tone
What: switch to 你/你的 tone; standardize Skills/Gateway网关/local loopback/私信 wording Why: align zh-CN docs with issue 6995 feedback + idiomatic tech style Tests: pnpm docs:build
This commit is contained in:
@@ -1,7 +1,7 @@
|
||||
---
|
||||
read_when:
|
||||
- 设置基于 ACP 的 IDE 集成
|
||||
- 调试 ACP 会话到 Gateway 的路由
|
||||
- 调试 ACP 会话到 Gateway网关的路由
|
||||
summary: 运行用于 IDE 集成的 ACP 桥接
|
||||
title: acp
|
||||
x-i18n:
|
||||
@@ -15,16 +15,16 @@ x-i18n:
|
||||
|
||||
# acp
|
||||
|
||||
运行与 OpenClaw Gateway 通信的 ACP(Agent Client Protocol)桥接。
|
||||
运行与 OpenClaw Gateway网关通信的 ACP(Agent Client Protocol)桥接。
|
||||
|
||||
此命令通过 stdio 使用 ACP 协议与 IDE 通信,并通过 WebSocket 将提示转发到 Gateway。它将 ACP 会话映射到 Gateway 会话密钥。
|
||||
此命令通过 stdio 使用 ACP 协议与 IDE 通信,并通过 WebSocket 将提示转发到 Gateway网关。它将 ACP 会话映射到 Gateway网关会话密钥。
|
||||
|
||||
## 用法
|
||||
|
||||
```bash
|
||||
openclaw acp
|
||||
|
||||
# 远程 Gateway
|
||||
# 远程 Gateway网关
|
||||
openclaw acp --url wss://gateway-host:18789 --token <token>
|
||||
|
||||
# 附加到现有会话密钥
|
||||
@@ -45,7 +45,7 @@ openclaw acp --session agent:main:main --reset-session
|
||||
```bash
|
||||
openclaw acp client
|
||||
|
||||
# 将启动的桥接指向远程 Gateway
|
||||
# 将启动的桥接指向远程 Gateway网关
|
||||
openclaw acp client --server-args --url wss://gateway-host:18789 --token <token>
|
||||
|
||||
# 覆盖服务器命令(默认:openclaw)
|
||||
@@ -54,10 +54,10 @@ openclaw acp client --server "node" --server-args openclaw.mjs acp --url ws://12
|
||||
|
||||
## 如何使用
|
||||
|
||||
当 IDE(或其他客户端)使用 Agent Client Protocol 并且你希望它驱动 OpenClaw Gateway 会话时,请使用 ACP。
|
||||
当 IDE(或其他客户端)使用 Agent Client Protocol 并且你希望它驱动 OpenClaw Gateway网关会话时,请使用 ACP。
|
||||
|
||||
1. 确保 Gateway 正在运行(本地或远程)。
|
||||
2. 配置 Gateway 目标(通过配置文件或标志)。
|
||||
1. 确保 Gateway网关正在运行(本地或远程)。
|
||||
2. 配置 Gateway网关目标(通过配置文件或标志)。
|
||||
3. 将你的 IDE 配置为通过 stdio 运行 `openclaw acp`。
|
||||
|
||||
示例配置(持久化):
|
||||
@@ -75,7 +75,7 @@ openclaw acp --url wss://gateway-host:18789 --token <token>
|
||||
|
||||
## 选择智能体
|
||||
|
||||
ACP 不直接选择智能体。它通过 Gateway 会话密钥进行路由。
|
||||
ACP 不直接选择智能体。它通过 Gateway网关会话密钥进行路由。
|
||||
|
||||
使用智能体作用域的会话密钥来指定特定智能体:
|
||||
|
||||
@@ -85,7 +85,7 @@ openclaw acp --session agent:design:main
|
||||
openclaw acp --session agent:qa:bug-123
|
||||
```
|
||||
|
||||
每个 ACP 会话映射到单个 Gateway 会话密钥。一个智能体可以有多个会话;除非你覆盖密钥或标签,否则 ACP 默认使用隔离的 `acp:<uuid>` 会话。
|
||||
每个 ACP 会话映射到单个 Gateway网关会话密钥。一个智能体可以有多个会话;除非你覆盖密钥或标签,否则 ACP 默认使用隔离的 `acp:<uuid>` 会话。
|
||||
|
||||
## Zed 编辑器设置
|
||||
|
||||
@@ -104,7 +104,7 @@ openclaw acp --session agent:qa:bug-123
|
||||
}
|
||||
```
|
||||
|
||||
要指定特定的 Gateway 或智能体:
|
||||
要指定特定的 Gateway网关或智能体:
|
||||
|
||||
```json
|
||||
{
|
||||
@@ -131,10 +131,10 @@ openclaw acp --session agent:qa:bug-123
|
||||
|
||||
## 会话映射
|
||||
|
||||
默认情况下,ACP 会话会获得一个带有 `acp:` 前缀的隔离 Gateway 会话密钥。
|
||||
默认情况下,ACP 会话会获得一个带有 `acp:` 前缀的隔离 Gateway网关会话密钥。
|
||||
要复用已知会话,请传递会话密钥或标签:
|
||||
|
||||
- `--session <key>`:使用特定的 Gateway 会话密钥。
|
||||
- `--session <key>`:使用特定的 Gateway网关会话密钥。
|
||||
- `--session-label <label>`:通过标签解析现有会话。
|
||||
- `--reset-session`:为该密钥生成新的会话 ID(相同密钥,新的对话记录)。
|
||||
|
||||
@@ -154,9 +154,9 @@ openclaw acp --session agent:qa:bug-123
|
||||
|
||||
## 选项
|
||||
|
||||
- `--url <url>`:Gateway WebSocket URL(配置后默认使用 gateway.remote.url)。
|
||||
- `--token <token>`:Gateway 认证令牌。
|
||||
- `--password <password>`:Gateway 认证密码。
|
||||
- `--url <url>`:Gateway网关 WebSocket URL(配置后默认使用 gateway.remote.url)。
|
||||
- `--token <token>`:Gateway网关认证令牌。
|
||||
- `--password <password>`:Gateway网关认证密码。
|
||||
- `--session <key>`:默认会话密钥。
|
||||
- `--session-label <label>`:要解析的默认会话标签。
|
||||
- `--require-existing`:如果会话密钥/标签不存在则失败。
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
read_when:
|
||||
- 您想从脚本中运行一次智能体轮次(可选择投递回复)
|
||||
summary: "`openclaw agent` 的 CLI 参考(通过 Gateway 发送一次智能体轮次)"
|
||||
- 你想从脚本中运行一次智能体轮次(可选择投递回复)
|
||||
summary: "`openclaw agent` 的 CLI 参考(通过 Gateway网关发送一次智能体轮次)"
|
||||
title: agent
|
||||
x-i18n:
|
||||
generated_at: "2026-02-01T19:58:31Z"
|
||||
@@ -14,7 +14,7 @@ x-i18n:
|
||||
|
||||
# `openclaw agent`
|
||||
|
||||
通过 Gateway 运行一次智能体轮次(使用 `--local` 进行嵌入式运行)。
|
||||
通过 Gateway网关运行一次智能体轮次(使用 `--local` 进行嵌入式运行)。
|
||||
使用 `--agent <id>` 直接指定一个已配置的智能体。
|
||||
|
||||
相关内容:
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
read_when:
|
||||
- 您需要多个隔离的智能体(工作区 + 路由 + 认证)
|
||||
- 你需要多个隔离的智能体(工作区 + 路由 + 认证)
|
||||
summary: "`openclaw agents` 的 CLI 参考(列出/添加/删除/设置身份)"
|
||||
title: agents
|
||||
x-i18n:
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
---
|
||||
read_when:
|
||||
- 您想通过 CLI 编辑执行审批
|
||||
- 您需要管理 Gateway 或节点主机上的允许列表
|
||||
summary: "`openclaw approvals` 的 CLI 参考(用于 Gateway 或节点主机的执行审批)"
|
||||
- 你想通过 CLI 编辑执行审批
|
||||
- 你需要管理 Gateway网关或节点主机上的允许列表
|
||||
summary: "`openclaw approvals` 的 CLI 参考(用于 Gateway网关或节点主机的执行审批)"
|
||||
title: approvals
|
||||
x-i18n:
|
||||
generated_at: "2026-02-01T19:58:39Z"
|
||||
@@ -15,8 +15,8 @@ x-i18n:
|
||||
|
||||
# `openclaw approvals`
|
||||
|
||||
管理**本地主机**、**Gateway 主机**或**节点主机**的执行审批。
|
||||
默认情况下,命令针对磁盘上的本地审批文件。使用 `--gateway` 针对 Gateway,或使用 `--node` 针对特定节点。
|
||||
管理**本地主机**、**Gateway网关主机**或**节点主机**的执行审批。
|
||||
默认情况下,命令针对磁盘上的本地审批文件。使用 `--gateway` 针对 Gateway网关,或使用 `--node` 针对特定节点。
|
||||
|
||||
相关内容:
|
||||
|
||||
|
||||
@@ -25,8 +25,8 @@ x-i18n:
|
||||
|
||||
## 常用标志
|
||||
|
||||
- `--url <gatewayWsUrl>`:Gateway WebSocket URL(默认使用配置值)。
|
||||
- `--token <token>`:Gateway 令牌(如需要)。
|
||||
- `--url <gatewayWsUrl>`:Gateway网关 WebSocket URL(默认使用配置值)。
|
||||
- `--token <token>`:Gateway网关令牌(如需要)。
|
||||
- `--timeout <ms>`:请求超时时间(毫秒)。
|
||||
- `--browser-profile <name>`:选择浏览器配置文件(默认使用配置值)。
|
||||
- `--json`:机器可读输出(在支持的情况下)。
|
||||
@@ -107,7 +107,7 @@ openclaw browser extension path
|
||||
|
||||
## 远程浏览器控制(节点主机代理)
|
||||
|
||||
如果 Gateway 与浏览器运行在不同的机器上,请在安装了 Chrome/Brave/Edge/Chromium 的机器上运行**节点主机**。Gateway 会将浏览器操作代理到该节点(无需单独的浏览器控制服务器)。
|
||||
如果 Gateway网关与浏览器运行在不同的机器上,请在安装了 Chrome/Brave/Edge/Chromium 的机器上运行**节点主机**。Gateway网关会将浏览器操作代理到该节点(无需单独的浏览器控制服务器)。
|
||||
|
||||
使用 `gateway.nodes.browser.mode` 控制自动路由,使用 `gateway.nodes.browser.node` 在多个节点连接时固定到特定节点。
|
||||
|
||||
|
||||
@@ -15,12 +15,12 @@ x-i18n:
|
||||
|
||||
# `openclaw channels`
|
||||
|
||||
管理 Gateway 上的聊天渠道账号及其运行时状态。
|
||||
管理 Gateway网关上的聊天渠道账号及其运行时状态。
|
||||
|
||||
相关文档:
|
||||
|
||||
- 渠道指南:[渠道](/channels/index)
|
||||
- Gateway 配置:[配置](/gateway/configuration)
|
||||
- Gateway网关配置:[配置](/gateway/configuration)
|
||||
|
||||
## 常用命令
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
read_when:
|
||||
- 您想以非交互方式读取或编辑配置
|
||||
- 你想以非交互方式读取或编辑配置
|
||||
summary: "`openclaw config` 的 CLI 参考(获取/设置/删除配置值)"
|
||||
title: config
|
||||
x-i18n:
|
||||
@@ -53,4 +53,4 @@ openclaw config set gateway.port 19001 --json
|
||||
openclaw config set channels.whatsapp.groups '["*"]' --json
|
||||
```
|
||||
|
||||
编辑后请重启 Gateway。
|
||||
编辑后请重启 Gateway网关。
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
read_when:
|
||||
- 您想通过交互方式调整凭据、设备或智能体默认设置
|
||||
- 你想通过交互方式调整凭据、设备或智能体默认设置
|
||||
summary: "`openclaw configure` 的 CLI 参考(交互式配置提示)"
|
||||
title: configure
|
||||
x-i18n:
|
||||
@@ -24,13 +24,13 @@ x-i18n:
|
||||
|
||||
相关内容:
|
||||
|
||||
- Gateway 配置参考:[配置](/gateway/configuration)
|
||||
- Gateway网关配置参考:[配置](/gateway/configuration)
|
||||
- Config CLI:[Config](/cli/config)
|
||||
|
||||
注意事项:
|
||||
|
||||
- 选择 Gateway 运行位置时会始终更新 `gateway.mode`。如果您只需要修改这一项,可以直接选择"继续"而无需配置其他部分。
|
||||
- 面向渠道的服务(Slack/Discord/Matrix/Microsoft Teams)在设置过程中会提示配置渠道/房间允许列表。您可以输入名称或 ID;向导会尽可能将名称解析为 ID。
|
||||
- 选择 Gateway网关运行位置时会始终更新 `gateway.mode`。如果你只需要修改这一项,可以直接选择"继续"而无需配置其他部分。
|
||||
- 面向渠道的服务(Slack/Discord/Matrix/Microsoft Teams)在设置过程中会提示配置渠道/房间允许列表。你可以输入名称或 ID;向导会尽可能将名称解析为 ID。
|
||||
|
||||
## 示例
|
||||
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
read_when:
|
||||
- 您需要定时任务和唤醒功能
|
||||
- 您正在调试定时任务的执行和日志
|
||||
- 你需要定时任务和唤醒功能
|
||||
- 你正在调试定时任务的执行和日志
|
||||
summary: "`openclaw cron` 的 CLI 参考(调度和运行后台任务)"
|
||||
title: cron
|
||||
x-i18n:
|
||||
@@ -15,7 +15,7 @@ x-i18n:
|
||||
|
||||
# `openclaw cron`
|
||||
|
||||
管理 Gateway 调度器的定时任务。
|
||||
管理 Gateway网关调度器的定时任务。
|
||||
|
||||
相关内容:
|
||||
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
read_when:
|
||||
- 您正在审批设备配对请求
|
||||
- 您需要轮换或吊销设备令牌
|
||||
- 你正在审批设备配对请求
|
||||
- 你需要轮换或吊销设备令牌
|
||||
summary: "`openclaw devices` 的 CLI 参考(设备配对 + 令牌轮换/吊销)"
|
||||
title: devices
|
||||
x-i18n:
|
||||
@@ -62,9 +62,9 @@ openclaw devices revoke --device <deviceId> --role node
|
||||
|
||||
## 通用选项
|
||||
|
||||
- `--url <url>`:Gateway WebSocket URL(配置后默认使用 `gateway.remote.url`)。
|
||||
- `--token <token>`:Gateway 令牌(如需要)。
|
||||
- `--password <password>`:Gateway 密码(密码认证)。
|
||||
- `--url <url>`:Gateway网关 WebSocket URL(配置后默认使用 `gateway.remote.url`)。
|
||||
- `--token <token>`:Gateway网关令牌(如需要)。
|
||||
- `--password <password>`:Gateway网关密码(密码认证)。
|
||||
- `--timeout <ms>`:RPC 超时时间。
|
||||
- `--json`:JSON 输出(推荐用于脚本)。
|
||||
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
read_when:
|
||||
- 您需要通过 Tailscale + CoreDNS 实现广域发现(DNS-SD)
|
||||
- 您正在为自定义发现域名设置分离 DNS(例如:openclaw.internal)
|
||||
- 你需要通过 Tailscale + CoreDNS 实现广域发现(DNS-SD)
|
||||
- 你正在为自定义发现域名设置分离 DNS(例如:openclaw.internal)
|
||||
summary: "`openclaw dns` 的 CLI 参考(广域发现辅助工具)"
|
||||
title: dns
|
||||
x-i18n:
|
||||
@@ -19,7 +19,7 @@ x-i18n:
|
||||
|
||||
相关内容:
|
||||
|
||||
- Gateway 发现:[发现](/gateway/discovery)
|
||||
- Gateway网关发现:[发现](/gateway/discovery)
|
||||
- 广域发现配置:[配置](/gateway/configuration)
|
||||
|
||||
## 设置
|
||||
|
||||
@@ -15,7 +15,7 @@ x-i18n:
|
||||
|
||||
# `openclaw doctor`
|
||||
|
||||
Gateway 和渠道的健康检查 + 快速修复。
|
||||
Gateway网关和渠道的健康检查 + 快速修复。
|
||||
|
||||
相关内容:
|
||||
|
||||
|
||||
@@ -1,9 +1,9 @@
|
||||
---
|
||||
read_when:
|
||||
- 从 CLI 运行 Gateway(开发或服务器环境)
|
||||
- 调试 Gateway 认证、绑定模式和连接问题
|
||||
- 通过 Bonjour 发现 Gateway(局域网 + tailnet)
|
||||
summary: OpenClaw Gateway CLI(`openclaw gateway`)— 运行、查询和发现 Gateway
|
||||
- 从 CLI 运行 Gateway网关(开发或服务器环境)
|
||||
- 调试 Gateway网关认证、绑定模式和连接问题
|
||||
- 通过 Bonjour 发现 Gateway网关(局域网 + tailnet)
|
||||
summary: OpenClaw Gateway网关 CLI(`openclaw gateway`)— 运行、查询和发现 Gateway网关
|
||||
title: gateway
|
||||
x-i18n:
|
||||
generated_at: "2026-02-01T19:59:19Z"
|
||||
@@ -14,9 +14,9 @@ x-i18n:
|
||||
workflow: 14
|
||||
---
|
||||
|
||||
# Gateway CLI
|
||||
# Gateway网关 CLI
|
||||
|
||||
Gateway 是 OpenClaw 的 WebSocket 服务器(渠道、节点、会话、钩子)。
|
||||
Gateway网关是 OpenClaw 的 WebSocket 服务器(渠道、节点、会话、钩子)。
|
||||
|
||||
本页中的子命令位于 `openclaw gateway …` 下。
|
||||
|
||||
@@ -26,9 +26,7 @@ Gateway 是 OpenClaw 的 WebSocket 服务器(渠道、节点、会话、钩子
|
||||
- [/gateway/discovery](/gateway/discovery)
|
||||
- [/gateway/configuration](/gateway/configuration)
|
||||
|
||||
## 运行 Gateway
|
||||
|
||||
运行本地 Gateway 进程:
|
||||
## 运行 Gateway网关运行本地 Gateway网关进程:
|
||||
|
||||
```bash
|
||||
openclaw gateway
|
||||
@@ -42,10 +40,10 @@ openclaw gateway run
|
||||
|
||||
注意事项:
|
||||
|
||||
- 默认情况下,除非在 `~/.openclaw/openclaw.json` 中设置了 `gateway.mode=local`,否则 Gateway 会拒绝启动。使用 `--allow-unconfigured` 进行临时/开发运行。
|
||||
- 在没有认证的情况下绑定到回环地址以外的地址会被阻止(安全防护措施)。
|
||||
- 授权后 `SIGUSR1` 会触发进程内重启(需启用 `commands.restart` 或使用 Gateway 工具/配置应用/更新)。
|
||||
- `SIGINT`/`SIGTERM` 处理程序会停止 Gateway 进程,但不会恢复任何自定义终端状态。如果您使用 TUI 或原始模式输入包装 CLI,请在退出前恢复终端。
|
||||
- 默认情况下,除非在 `~/.openclaw/openclaw.json` 中设置了 `gateway.mode=local`,否则 Gateway网关会拒绝启动。使用 `--allow-unconfigured` 进行临时/开发运行。
|
||||
- 在没有认证的情况下绑定到 local loopback 以外的地址会被阻止(安全防护措施)。
|
||||
- 授权后 `SIGUSR1` 会触发进程内重启(需启用 `commands.restart` 或使用 Gateway网关工具/配置应用/更新)。
|
||||
- `SIGINT`/`SIGTERM` 处理程序会停止 Gateway网关进程,但不会恢复任何自定义终端状态。如果你使用 TUI 或原始模式输入包装 CLI,请在退出前恢复终端。
|
||||
|
||||
### 选项
|
||||
|
||||
@@ -54,9 +52,9 @@ openclaw gateway run
|
||||
- `--auth <token|password>`:认证模式覆盖。
|
||||
- `--token <token>`:令牌覆盖(同时为进程设置 `OPENCLAW_GATEWAY_TOKEN`)。
|
||||
- `--password <password>`:密码覆盖(同时为进程设置 `OPENCLAW_GATEWAY_PASSWORD`)。
|
||||
- `--tailscale <off|serve|funnel>`:通过 Tailscale 暴露 Gateway。
|
||||
- `--tailscale <off|serve|funnel>`:通过 Tailscale 暴露 Gateway网关。
|
||||
- `--tailscale-reset-on-exit`:关闭时重置 Tailscale serve/funnel 配置。
|
||||
- `--allow-unconfigured`:允许在配置中没有 `gateway.mode=local` 的情况下启动 Gateway。
|
||||
- `--allow-unconfigured`:允许在配置中没有 `gateway.mode=local` 的情况下启动 Gateway网关。
|
||||
- `--dev`:如果缺失则创建开发配置和工作区(跳过 BOOTSTRAP.md)。
|
||||
- `--reset`:重置开发配置 + 凭据 + 会话 + 工作区(需要 `--dev`)。
|
||||
- `--force`:启动前终止所选端口上的现有监听器。
|
||||
@@ -67,9 +65,7 @@ openclaw gateway run
|
||||
- `--raw-stream`:将原始模型流事件记录到 jsonl。
|
||||
- `--raw-stream-path <path>`:原始流 jsonl 路径。
|
||||
|
||||
## 查询运行中的 Gateway
|
||||
|
||||
所有查询命令使用 WebSocket RPC。
|
||||
## 查询运行中的 Gateway网关所有查询命令使用 WebSocket RPC。
|
||||
|
||||
输出模式:
|
||||
|
||||
@@ -79,9 +75,9 @@ openclaw gateway run
|
||||
|
||||
共享选项(在支持的命令中):
|
||||
|
||||
- `--url <url>`:Gateway WebSocket URL。
|
||||
- `--token <token>`:Gateway 令牌。
|
||||
- `--password <password>`:Gateway 密码。
|
||||
- `--url <url>`:Gateway网关 WebSocket URL。
|
||||
- `--token <token>`:Gateway网关令牌。
|
||||
- `--password <password>`:Gateway网关密码。
|
||||
- `--timeout <ms>`:超时时间/预算(因命令而异)。
|
||||
- `--expect-final`:等待"最终"响应(智能体调用)。
|
||||
|
||||
@@ -93,7 +89,7 @@ openclaw gateway health --url ws://127.0.0.1:18789
|
||||
|
||||
### `gateway status`
|
||||
|
||||
`gateway status` 显示 Gateway 服务(launchd/systemd/schtasks)以及可选的 RPC 探测。
|
||||
`gateway status` 显示 Gateway网关服务(launchd/systemd/schtasks)以及可选的 RPC 探测。
|
||||
|
||||
```bash
|
||||
openclaw gateway status
|
||||
@@ -113,10 +109,10 @@ openclaw gateway status --json
|
||||
|
||||
`gateway probe` 是"全面调试"命令。它始终会探测:
|
||||
|
||||
- 您配置的远程 Gateway(如已设置),以及
|
||||
- localhost(回环地址),**即使已配置远程 Gateway**。
|
||||
- 你配置的远程 Gateway网关(如已设置),以及
|
||||
- localhost(local loopback),**即使已配置远程 Gateway网关**。
|
||||
|
||||
如果有多个 Gateway 可达,它会全部输出。当您使用隔离的配置文件/端口时(例如救援机器人),支持多个 Gateway,但大多数安装仍然运行单个 Gateway。
|
||||
如果有多个 Gateway网关可达,它会全部输出。当你使用隔离的配置文件/端口时(例如救援机器人),支持多个 Gateway网关,但大多数安装仍然运行单个 Gateway网关。
|
||||
|
||||
```bash
|
||||
openclaw gateway probe
|
||||
@@ -125,7 +121,7 @@ openclaw gateway probe --json
|
||||
|
||||
#### 通过 SSH 远程连接(Mac 应用对等模式)
|
||||
|
||||
macOS 应用的"通过 SSH 远程连接"模式使用本地端口转发,使远程 Gateway(可能仅绑定到回环地址)可通过 `ws://127.0.0.1:<port>` 访问。
|
||||
macOS 应用的"通过 SSH 远程连接"模式使用本地端口转发,使远程 Gateway网关(可能仅绑定到 local loopback)可通过 `ws://127.0.0.1:<port>` 访问。
|
||||
|
||||
CLI 等效命令:
|
||||
|
||||
@@ -137,7 +133,7 @@ openclaw gateway probe --ssh user@gateway-host
|
||||
|
||||
- `--ssh <target>`:`user@host` 或 `user@host:port`(端口默认为 `22`)。
|
||||
- `--ssh-identity <path>`:身份文件。
|
||||
- `--ssh-auto`:自动选择第一个发现的 Gateway 主机作为 SSH 目标(仅限局域网/WAB)。
|
||||
- `--ssh-auto`:自动选择第一个发现的 Gateway网关主机作为 SSH 目标(仅限局域网/WAB)。
|
||||
|
||||
配置(可选,用作默认值):
|
||||
|
||||
@@ -153,7 +149,7 @@ openclaw gateway call status
|
||||
openclaw gateway call logs.tail --params '{"sinceMs": 60000}'
|
||||
```
|
||||
|
||||
## 管理 Gateway 服务
|
||||
## 管理 Gateway网关服务
|
||||
|
||||
```bash
|
||||
openclaw gateway install
|
||||
@@ -168,18 +164,18 @@ openclaw gateway uninstall
|
||||
- `gateway install` 支持 `--port`、`--runtime`、`--token`、`--force`、`--json`。
|
||||
- 生命周期命令接受 `--json` 用于脚本编写。
|
||||
|
||||
## 发现 Gateway(Bonjour)
|
||||
## 发现 Gateway网关(Bonjour)
|
||||
|
||||
`gateway discover` 扫描 Gateway 信标(`_openclaw-gw._tcp`)。
|
||||
`gateway discover` 扫描 Gateway网关信标(`_openclaw-gw._tcp`)。
|
||||
|
||||
- 组播 DNS-SD:`local.`
|
||||
- 单播 DNS-SD(广域 Bonjour):选择一个域名(例如:`openclaw.internal.`)并设置分离 DNS + DNS 服务器;参见 [/gateway/bonjour](/gateway/bonjour)
|
||||
|
||||
只有启用了 Bonjour 发现(默认启用)的 Gateway 才会广播信标。
|
||||
只有启用了 Bonjour 发现(默认启用)的 Gateway网关才会广播信标。
|
||||
|
||||
广域发现记录包含(TXT):
|
||||
|
||||
- `role`(Gateway 角色提示)
|
||||
- `role`(Gateway网关角色提示)
|
||||
- `transport`(传输提示,例如 `gateway`)
|
||||
- `gatewayPort`(WebSocket 端口,通常为 `18789`)
|
||||
- `sshPort`(SSH 端口;如未指定默认为 `22`)
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
read_when:
|
||||
- 您想快速检查正在运行的 Gateway 的健康状态
|
||||
summary: "`openclaw health` 的 CLI 参考(通过 RPC 访问 Gateway 健康端点)"
|
||||
- 你想快速检查正在运行的 Gateway网关的健康状态
|
||||
summary: "`openclaw health` 的 CLI 参考(通过 RPC 访问 Gateway网关健康端点)"
|
||||
title: health
|
||||
x-i18n:
|
||||
generated_at: "2026-02-01T19:58:57Z"
|
||||
@@ -14,7 +14,7 @@ x-i18n:
|
||||
|
||||
# `openclaw health`
|
||||
|
||||
从正在运行的 Gateway 获取健康状态。
|
||||
从正在运行的 Gateway网关获取健康状态。
|
||||
|
||||
```bash
|
||||
openclaw health
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
read_when:
|
||||
- 您想管理智能体钩子
|
||||
- 您想安装或更新钩子
|
||||
- 你想管理智能体钩子
|
||||
- 你想安装或更新钩子
|
||||
summary: "`openclaw hooks` 的 CLI 参考(智能体钩子)"
|
||||
title: hooks
|
||||
x-i18n:
|
||||
@@ -15,7 +15,7 @@ x-i18n:
|
||||
|
||||
# `openclaw hooks`
|
||||
|
||||
管理智能体钩子(用于 `/new`、`/reset` 等命令以及 Gateway 启动的事件驱动自动化)。
|
||||
管理智能体钩子(用于 `/new`、`/reset` 等命令以及 Gateway网关启动的事件驱动自动化)。
|
||||
|
||||
相关内容:
|
||||
|
||||
@@ -160,7 +160,7 @@ openclaw hooks enable session-memory
|
||||
|
||||
**启用后:**
|
||||
|
||||
- 重启 Gateway 以重新加载钩子(macOS 上重启菜单栏应用,或在开发环境中重启 Gateway 进程)。
|
||||
- 重启 Gateway网关以重新加载钩子(macOS 上重启菜单栏应用,或在开发环境中重启 Gateway网关进程)。
|
||||
|
||||
## 禁用钩子
|
||||
|
||||
@@ -188,7 +188,7 @@ openclaw hooks disable command-logger
|
||||
|
||||
**禁用后:**
|
||||
|
||||
- 重启 Gateway 以重新加载钩子
|
||||
- 重启 Gateway网关以重新加载钩子
|
||||
|
||||
## 安装钩子
|
||||
|
||||
@@ -244,7 +244,7 @@ openclaw hooks update --all
|
||||
|
||||
### session-memory
|
||||
|
||||
在您执行 `/new` 时将会话上下文保存到记忆中。
|
||||
在你执行 `/new` 时将会话上下文保存到记忆中。
|
||||
|
||||
**启用:**
|
||||
|
||||
@@ -297,7 +297,7 @@ openclaw hooks enable soul-evil
|
||||
|
||||
### boot-md
|
||||
|
||||
在 Gateway 启动时(渠道启动之后)运行 `BOOT.md`。
|
||||
在 Gateway网关启动时(渠道启动之后)运行 `BOOT.md`。
|
||||
|
||||
**事件**:`gateway:startup`
|
||||
|
||||
|
||||
@@ -249,7 +249,7 @@ openclaw [--dev] [--profile <name>] <command>
|
||||
## 安全
|
||||
|
||||
- `openclaw security audit` — 审计配置和本地状态中常见的安全隐患。
|
||||
- `openclaw security audit --deep` — 尽力进行实时 Gateway 探测。
|
||||
- `openclaw security audit --deep` — 尽力进行实时 Gateway网关探测。
|
||||
- `openclaw security audit --fix` — 收紧安全默认设置并修改状态/配置文件权限。
|
||||
|
||||
## 插件
|
||||
@@ -262,7 +262,7 @@ openclaw [--dev] [--profile <name>] <command>
|
||||
- `openclaw plugins enable <id>` / `disable <id>` — 切换 `plugins.entries.<id>.enabled`。
|
||||
- `openclaw plugins doctor` — 报告插件加载错误。
|
||||
|
||||
大多数插件变更需要重启 Gateway。参见 [/plugin](/plugin)。
|
||||
大多数插件变更需要重启 Gateway网关。参见 [/plugin](/plugin)。
|
||||
|
||||
## 记忆
|
||||
|
||||
@@ -282,7 +282,7 @@ openclaw [--dev] [--profile <name>] <command>
|
||||
- `/config` 用于持久化配置更改。
|
||||
- `/debug` 用于仅运行时的配置覆盖(内存中,不写入磁盘;需要 `commands.debug: true`)。
|
||||
|
||||
## 设置与上手引导
|
||||
## 设置与新手引导
|
||||
|
||||
### `setup`
|
||||
|
||||
@@ -291,17 +291,17 @@ openclaw [--dev] [--profile <name>] <command>
|
||||
选项:
|
||||
|
||||
- `--workspace <dir>`:智能体工作区路径(默认 `~/.openclaw/workspace`)。
|
||||
- `--wizard`:运行上手引导向导。
|
||||
- `--wizard`:运行新手引导向导。
|
||||
- `--non-interactive`:无提示运行向导。
|
||||
- `--mode <local|remote>`:向导模式。
|
||||
- `--remote-url <url>`:远程 Gateway URL。
|
||||
- `--remote-token <token>`:远程 Gateway 令牌。
|
||||
- `--remote-url <url>`:远程 Gateway网关 URL。
|
||||
- `--remote-token <token>`:远程 Gateway网关令牌。
|
||||
|
||||
当存在任何向导参数(`--non-interactive`、`--mode`、`--remote-url`、`--remote-token`)时,向导会自动运行。
|
||||
|
||||
### `onboard`
|
||||
|
||||
交互式向导,用于设置 Gateway、工作区和技能。
|
||||
交互式向导,用于设置 Gateway网关、工作区和 Skills。
|
||||
|
||||
选项:
|
||||
|
||||
@@ -341,12 +341,12 @@ openclaw [--dev] [--profile <name>] <command>
|
||||
- `--skip-skills`
|
||||
- `--skip-health`
|
||||
- `--skip-ui`
|
||||
- `--node-manager <npm|pnpm|bun>`(推荐 pnpm;不建议将 bun 用于 Gateway 运行时)
|
||||
- `--node-manager <npm|pnpm|bun>`(推荐 pnpm;不建议将 bun 用于 Gateway网关运行时)
|
||||
- `--json`
|
||||
|
||||
### `configure`
|
||||
|
||||
交互式配置向导(模型、渠道、技能、Gateway)。
|
||||
交互式配置向导(模型、渠道、Skills、Gateway网关)。
|
||||
|
||||
### `config`
|
||||
|
||||
@@ -360,14 +360,14 @@ openclaw [--dev] [--profile <name>] <command>
|
||||
|
||||
### `doctor`
|
||||
|
||||
健康检查和快速修复(配置 + Gateway + 旧版服务)。
|
||||
健康检查和快速修复(配置 + Gateway网关 + 旧版服务)。
|
||||
|
||||
选项:
|
||||
|
||||
- `--no-workspace-suggestions`:禁用工作区记忆提示。
|
||||
- `--yes`:无需提示接受默认值(无头模式)。
|
||||
- `--non-interactive`:跳过提示;仅应用安全迁移。
|
||||
- `--deep`:扫描系统服务以查找额外的 Gateway 安装。
|
||||
- `--deep`:扫描系统服务以查找额外的 Gateway网关安装。
|
||||
|
||||
## 渠道辅助工具
|
||||
|
||||
@@ -378,9 +378,9 @@ openclaw [--dev] [--profile <name>] <command>
|
||||
子命令:
|
||||
|
||||
- `channels list`:显示已配置的渠道和认证配置。
|
||||
- `channels status`:检查 Gateway 可达性和渠道健康状态(`--probe` 运行额外检查;使用 `openclaw health` 或 `openclaw status --deep` 进行 Gateway 健康探测)。
|
||||
- `channels status`:检查 Gateway网关可达性和渠道健康状态(`--probe` 运行额外检查;使用 `openclaw health` 或 `openclaw status --deep` 进行 Gateway网关健康探测)。
|
||||
- 提示:`channels status` 在检测到常见配置错误时会打印警告并提供修复建议(然后引导你使用 `openclaw doctor`)。
|
||||
- `channels logs`:显示来自 Gateway 日志文件的最近渠道日志。
|
||||
- `channels logs`:显示来自 Gateway网关日志文件的最近渠道日志。
|
||||
- `channels add`:不传参数时以向导模式设置;传入参数则切换为非交互模式。
|
||||
- `channels remove`:默认仅禁用;传入 `--delete` 可无提示删除配置条目。
|
||||
- `channels login`:交互式渠道登录(仅限 WhatsApp Web)。
|
||||
@@ -428,21 +428,21 @@ openclaw status --deep
|
||||
|
||||
### `skills`
|
||||
|
||||
列出和检查可用技能及就绪信息。
|
||||
列出和检查可用 Skills 及就绪信息。
|
||||
|
||||
子命令:
|
||||
|
||||
- `skills list`:列出技能(无子命令时的默认行为)。
|
||||
- `skills info <name>`:显示某个技能的详情。
|
||||
- `skills list`:列出 Skills(无子命令时的默认行为)。
|
||||
- `skills info <name>`:显示某个 Skills 的详情。
|
||||
- `skills check`:就绪与缺失需求的摘要。
|
||||
|
||||
选项:
|
||||
|
||||
- `--eligible`:仅显示就绪的技能。
|
||||
- `--eligible`:仅显示就绪的 Skills。
|
||||
- `--json`:输出 JSON(无样式)。
|
||||
- `-v`、`--verbose`:包含缺失需求的详情。
|
||||
|
||||
提示:使用 `npx clawhub` 搜索、安装和同步技能。
|
||||
提示:使用 `npx clawhub` 搜索、安装和同步 Skills。
|
||||
|
||||
### `pairing`
|
||||
|
||||
@@ -497,7 +497,7 @@ Gmail Pub/Sub 钩子设置与运行。参见 [/automation/gmail-pubsub](/automat
|
||||
|
||||
### `agent`
|
||||
|
||||
通过 Gateway(或 `--local` 嵌入模式)运行一个智能体回合。
|
||||
通过 Gateway网关(或 `--local` 嵌入模式)运行一个智能体回合。
|
||||
|
||||
必需:
|
||||
|
||||
@@ -554,7 +554,7 @@ Gmail Pub/Sub 钩子设置与运行。参见 [/automation/gmail-pubsub](/automat
|
||||
|
||||
### `acp`
|
||||
|
||||
运行将 IDE 连接到 Gateway 的 ACP 桥接。
|
||||
运行将 IDE 连接到 Gateway网关的 ACP 桥接。
|
||||
|
||||
参见 [`acp`](/cli/acp) 获取完整选项和示例。
|
||||
|
||||
@@ -574,7 +574,7 @@ Gmail Pub/Sub 钩子设置与运行。参见 [/automation/gmail-pubsub](/automat
|
||||
|
||||
说明:
|
||||
|
||||
- 概览在可用时包含 Gateway + 节点主机服务状态。
|
||||
- 概览在可用时包含 Gateway网关 + 节点主机服务状态。
|
||||
|
||||
### 用量追踪
|
||||
|
||||
@@ -595,7 +595,7 @@ Gmail Pub/Sub 钩子设置与运行。参见 [/automation/gmail-pubsub](/automat
|
||||
|
||||
### `health`
|
||||
|
||||
从运行中的 Gateway 获取健康状态。
|
||||
从运行中的 Gateway网关获取健康状态。
|
||||
|
||||
选项:
|
||||
|
||||
@@ -633,7 +633,7 @@ Gmail Pub/Sub 钩子设置与运行。参见 [/automation/gmail-pubsub](/automat
|
||||
|
||||
### `uninstall`
|
||||
|
||||
卸载 Gateway 服务和本地数据(CLI 保留)。
|
||||
卸载 Gateway网关服务和本地数据(CLI 保留)。
|
||||
|
||||
选项:
|
||||
|
||||
@@ -650,11 +650,11 @@ Gmail Pub/Sub 钩子设置与运行。参见 [/automation/gmail-pubsub](/automat
|
||||
|
||||
- `--non-interactive` 需要 `--yes` 和明确的范围(或 `--all`)。
|
||||
|
||||
## Gateway
|
||||
## Gateway网关
|
||||
|
||||
### `gateway`
|
||||
|
||||
运行 WebSocket Gateway。
|
||||
运行 WebSocket Gateway网关。
|
||||
|
||||
选项:
|
||||
|
||||
@@ -678,11 +678,11 @@ Gmail Pub/Sub 钩子设置与运行。参见 [/automation/gmail-pubsub](/automat
|
||||
|
||||
### `gateway service`
|
||||
|
||||
管理 Gateway 服务(launchd/systemd/schtasks)。
|
||||
管理 Gateway网关服务(launchd/systemd/schtasks)。
|
||||
|
||||
子命令:
|
||||
|
||||
- `gateway status`(默认探测 Gateway RPC)
|
||||
- `gateway status`(默认探测 Gateway网关 RPC)
|
||||
- `gateway install`(服务安装)
|
||||
- `gateway uninstall`
|
||||
- `gateway start`
|
||||
@@ -691,9 +691,9 @@ Gmail Pub/Sub 钩子设置与运行。参见 [/automation/gmail-pubsub](/automat
|
||||
|
||||
说明:
|
||||
|
||||
- `gateway status` 默认使用服务解析的端口/配置探测 Gateway RPC(可通过 `--url/--token/--password` 覆盖)。
|
||||
- `gateway status` 默认使用服务解析的端口/配置探测 Gateway网关 RPC(可通过 `--url/--token/--password` 覆盖)。
|
||||
- `gateway status` 支持 `--no-probe`、`--deep` 和 `--json` 用于脚本编写。
|
||||
- `gateway status` 还会在检测到旧版或额外的 Gateway 服务时展示(`--deep` 添加系统级扫描)。以配置文件命名的 OpenClaw 服务被视为正式服务,不会被标记为"额外"。
|
||||
- `gateway status` 还会在检测到旧版或额外的 Gateway网关服务时展示(`--deep` 添加系统级扫描)。以配置文件命名的 OpenClaw 服务被视为正式服务,不会被标记为"额外"。
|
||||
- `gateway status` 会打印 CLI 使用的配置路径与服务可能使用的配置(服务环境变量),以及解析后的探测目标 URL。
|
||||
- `gateway install|uninstall|start|stop|restart` 支持 `--json` 用于脚本编写(默认输出保持人类可读)。
|
||||
- `gateway install` 默认使用 Node 运行时;**不建议**使用 bun(WhatsApp/Telegram 存在 bug)。
|
||||
@@ -701,7 +701,7 @@ Gmail Pub/Sub 钩子设置与运行。参见 [/automation/gmail-pubsub](/automat
|
||||
|
||||
### `logs`
|
||||
|
||||
通过 RPC 追踪 Gateway 文件日志。
|
||||
通过 RPC 追踪 Gateway网关文件日志。
|
||||
|
||||
说明:
|
||||
|
||||
@@ -720,7 +720,7 @@ openclaw logs --no-color
|
||||
|
||||
### `gateway <subcommand>`
|
||||
|
||||
Gateway CLI 辅助工具(RPC 子命令使用 `--url`、`--token`、`--password`、`--timeout`、`--expect-final`)。
|
||||
Gateway网关 CLI 辅助工具(RPC 子命令使用 `--url`、`--token`、`--password`、`--timeout`、`--expect-final`)。
|
||||
|
||||
子命令:
|
||||
|
||||
@@ -859,7 +859,7 @@ openclaw models status
|
||||
|
||||
### `system event`
|
||||
|
||||
入队系统事件并可选触发心跳(Gateway RPC)。
|
||||
入队系统事件并可选触发心跳(Gateway网关 RPC)。
|
||||
|
||||
必需:
|
||||
|
||||
@@ -873,7 +873,7 @@ openclaw models status
|
||||
|
||||
### `system heartbeat last|enable|disable`
|
||||
|
||||
心跳控制(Gateway RPC)。
|
||||
心跳控制(Gateway网关 RPC)。
|
||||
|
||||
选项:
|
||||
|
||||
@@ -882,7 +882,7 @@ openclaw models status
|
||||
|
||||
### `system presence`
|
||||
|
||||
列出系统存在条目(Gateway RPC)。
|
||||
列出系统存在条目(Gateway网关 RPC)。
|
||||
|
||||
选项:
|
||||
|
||||
@@ -891,7 +891,7 @@ openclaw models status
|
||||
|
||||
## 定时任务
|
||||
|
||||
管理调度作业(Gateway RPC)。参见 [/automation/cron-jobs](/automation/cron-jobs)。
|
||||
管理调度作业(Gateway网关 RPC)。参见 [/automation/cron-jobs](/automation/cron-jobs)。
|
||||
|
||||
子命令:
|
||||
|
||||
@@ -922,7 +922,7 @@ openclaw models status
|
||||
|
||||
## 节点
|
||||
|
||||
`nodes` 与 Gateway 通信并操作已配对的节点。参见 [/nodes](/nodes)。
|
||||
`nodes` 与 Gateway网关通信并操作已配对的节点。参见 [/nodes](/nodes)。
|
||||
|
||||
通用选项:
|
||||
|
||||
@@ -1018,7 +1018,7 @@ openclaw models status
|
||||
|
||||
### `tui`
|
||||
|
||||
打开连接到 Gateway 的终端 UI。
|
||||
打开连接到 Gateway网关的终端 UI。
|
||||
|
||||
选项:
|
||||
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
---
|
||||
read_when:
|
||||
- 需要远程查看 Gateway 日志(无需 SSH)
|
||||
- 需要远程查看 Gateway网关日志(无需 SSH)
|
||||
- 需要 JSON 格式的日志行以供工具使用
|
||||
summary: 通过 RPC 查看 Gateway 日志的 `openclaw logs` CLI 参考
|
||||
summary: 通过 RPC 查看 Gateway网关日志的 `openclaw logs` CLI 参考
|
||||
title: logs
|
||||
x-i18n:
|
||||
generated_at: "2026-02-01T20:21:08Z"
|
||||
@@ -15,7 +15,7 @@ x-i18n:
|
||||
|
||||
# `openclaw logs`
|
||||
|
||||
通过 RPC 实时查看 Gateway 文件日志(支持远程模式)。
|
||||
通过 RPC 实时查看 Gateway网关文件日志(支持远程模式)。
|
||||
|
||||
相关内容:
|
||||
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
read_when:
|
||||
- 您想要索引或搜索语义记忆
|
||||
- 您正在调试记忆可用性或索引问题
|
||||
- 你想要索引或搜索语义记忆
|
||||
- 你正在调试记忆可用性或索引问题
|
||||
summary: "`openclaw memory`(status/index/search)的 CLI 参考"
|
||||
title: memory
|
||||
x-i18n:
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
read_when:
|
||||
- 您想更改默认模型或查看提供商认证状态
|
||||
- 您想扫描可用的模型/提供商并调试认证配置
|
||||
- 你想更改默认模型或查看提供商认证状态
|
||||
- 你想扫描可用的模型/提供商并调试认证配置
|
||||
summary: "`openclaw models` 的 CLI 参考(status/list/set/scan、别名、回退、认证)"
|
||||
title: models
|
||||
x-i18n:
|
||||
|
||||
@@ -15,7 +15,7 @@ x-i18n:
|
||||
|
||||
# `openclaw node`
|
||||
|
||||
运行一个**无头节点主机**,连接到 Gateway WebSocket 并在本机上暴露
|
||||
运行一个**无头节点主机**,连接到 Gateway网关 WebSocket 并在本机上暴露
|
||||
`system.run` / `system.which`。
|
||||
|
||||
## 为什么使用节点主机?
|
||||
@@ -25,7 +25,7 @@ x-i18n:
|
||||
常见用例:
|
||||
|
||||
- 在远程 Linux/Windows 机器上运行命令(构建服务器、实验室机器、NAS)。
|
||||
- 在 Gateway 上保持执行**沙箱化**,但将已批准的运行委派给其他主机。
|
||||
- 在 Gateway网关上保持执行**沙箱隔离**,但将已批准的运行委派给其他主机。
|
||||
- 为自动化或 CI 节点提供轻量级、无头的执行目标。
|
||||
|
||||
执行仍受**执行审批**和节点主机上的按智能体白名单保护,因此你可以保持命令访问的范围明确可控。
|
||||
@@ -54,9 +54,9 @@ openclaw node run --host <gateway-host> --port 18789
|
||||
|
||||
选项:
|
||||
|
||||
- `--host <host>`:Gateway WebSocket 主机(默认:`127.0.0.1`)
|
||||
- `--port <port>`:Gateway WebSocket 端口(默认:`18789`)
|
||||
- `--tls`:为 Gateway 连接使用 TLS
|
||||
- `--host <host>`:Gateway网关 WebSocket 主机(默认:`127.0.0.1`)
|
||||
- `--port <port>`:Gateway网关 WebSocket 端口(默认:`18789`)
|
||||
- `--tls`:为 Gateway网关连接使用 TLS
|
||||
- `--tls-fingerprint <sha256>`:预期的 TLS 证书指纹(sha256)
|
||||
- `--node-id <id>`:覆盖节点 ID(清除配对令牌)
|
||||
- `--display-name <name>`:覆盖节点显示名称
|
||||
@@ -71,9 +71,9 @@ openclaw node install --host <gateway-host> --port 18789
|
||||
|
||||
选项:
|
||||
|
||||
- `--host <host>`:Gateway WebSocket 主机(默认:`127.0.0.1`)
|
||||
- `--port <port>`:Gateway WebSocket 端口(默认:`18789`)
|
||||
- `--tls`:为 Gateway 连接使用 TLS
|
||||
- `--host <host>`:Gateway网关 WebSocket 主机(默认:`127.0.0.1`)
|
||||
- `--port <port>`:Gateway网关 WebSocket 端口(默认:`18789`)
|
||||
- `--tls`:为 Gateway网关连接使用 TLS
|
||||
- `--tls-fingerprint <sha256>`:预期的 TLS 证书指纹(sha256)
|
||||
- `--node-id <id>`:覆盖节点 ID(清除配对令牌)
|
||||
- `--display-name <name>`:覆盖节点显示名称
|
||||
@@ -95,7 +95,7 @@ openclaw node uninstall
|
||||
|
||||
## 配对
|
||||
|
||||
首次连接会在 Gateway 上创建一个待处理的节点配对请求。
|
||||
首次连接会在 Gateway网关上创建一个待处理的节点配对请求。
|
||||
通过以下方式批准:
|
||||
|
||||
```bash
|
||||
@@ -103,7 +103,7 @@ openclaw nodes pending
|
||||
openclaw nodes approve <requestId>
|
||||
```
|
||||
|
||||
节点主机将其节点 ID、令牌、显示名称和 Gateway 连接信息存储在
|
||||
节点主机将其节点 ID、令牌、显示名称和 Gateway网关连接信息存储在
|
||||
`~/.openclaw/node.json` 中。
|
||||
|
||||
## 执行审批
|
||||
@@ -112,4 +112,4 @@ openclaw nodes approve <requestId>
|
||||
|
||||
- `~/.openclaw/exec-approvals.json`
|
||||
- [执行审批](/tools/exec-approvals)
|
||||
- `openclaw approvals --node <id|name|ip>`(从 Gateway 编辑)
|
||||
- `openclaw approvals --node <id|name|ip>`(从 Gateway网关编辑)
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
read_when:
|
||||
- 您想要通过引导式设置配置 Gateway、工作区、认证、渠道和技能
|
||||
summary: "`openclaw onboard`(交互式上手引导向导)的 CLI 参考"
|
||||
- 你想要通过引导式设置配置 Gateway网关、工作区、认证、渠道和 Skills
|
||||
summary: "`openclaw onboard`(交互式新手引导向导)的 CLI 参考"
|
||||
title: onboard
|
||||
x-i18n:
|
||||
generated_at: "2026-02-01T20:21:15Z"
|
||||
@@ -14,11 +14,11 @@ x-i18n:
|
||||
|
||||
# `openclaw onboard`
|
||||
|
||||
交互式上手引导向导(本地或远程 Gateway 设置)。
|
||||
交互式新手引导向导(本地或远程 Gateway网关设置)。
|
||||
|
||||
相关内容:
|
||||
|
||||
- 向导指南:[上手引导](/start/onboarding)
|
||||
- 向导指南:[新手引导](/start/onboarding)
|
||||
|
||||
## 示例
|
||||
|
||||
@@ -31,6 +31,6 @@ openclaw onboard --mode remote --remote-url ws://gateway-host:18789
|
||||
|
||||
流程说明:
|
||||
|
||||
- `quickstart`:最少提示,自动生成 Gateway 令牌。
|
||||
- `quickstart`:最少提示,自动生成 Gateway网关令牌。
|
||||
- `manual`:完整的端口/绑定/认证提示(`advanced` 的别名)。
|
||||
- 最快开始聊天的方式:`openclaw dashboard`(控制台 UI,无需渠道设置)。
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
read_when:
|
||||
- 您正在使用配对模式的私信功能,需要批准发送者
|
||||
- 你正在使用配对模式的私信功能,需要批准发送者
|
||||
summary: "`openclaw pairing`(批准/列出配对请求)的 CLI 参考"
|
||||
title: pairing
|
||||
x-i18n:
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
read_when:
|
||||
- 您想安装或管理进程内 Gateway 插件
|
||||
- 您想调试插件加载失败问题
|
||||
- 你想安装或管理进程内 Gateway网关插件
|
||||
- 你想调试插件加载失败问题
|
||||
summary: "`openclaw plugins` 的 CLI 参考(list、install、enable/disable、doctor)"
|
||||
title: plugins
|
||||
x-i18n:
|
||||
@@ -15,7 +15,7 @@ x-i18n:
|
||||
|
||||
# `openclaw plugins`
|
||||
|
||||
管理 Gateway 插件/扩展(进程内加载)。
|
||||
管理 Gateway网关插件/扩展(进程内加载)。
|
||||
|
||||
相关内容:
|
||||
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
---
|
||||
read_when: 您正在管理沙箱容器或调试沙箱/工具策略行为。
|
||||
read_when: 你正在管理沙箱容器或调试沙箱/工具策略行为。
|
||||
status: active
|
||||
summary: 管理沙箱容器并检查生效的沙箱策略
|
||||
title: Sandbox CLI
|
||||
@@ -18,7 +18,7 @@ x-i18n:
|
||||
|
||||
## 概述
|
||||
|
||||
OpenClaw 可以在隔离的 Docker 容器中运行智能体以确保安全性。`sandbox` 命令帮助您管理这些容器,尤其是在更新或配置变更之后。
|
||||
OpenClaw 可以在隔离的 Docker 容器中运行智能体以确保安全性。`sandbox` 命令帮助你管理这些容器,尤其是在更新或配置变更之后。
|
||||
|
||||
## 命令
|
||||
|
||||
@@ -115,7 +115,7 @@ openclaw sandbox recreate --agent alfred
|
||||
|
||||
## 为什么需要这样做?
|
||||
|
||||
**问题:** 当您更新沙箱 Docker 镜像或配置时:
|
||||
**问题:** 当你更新沙箱 Docker 镜像或配置时:
|
||||
|
||||
- 现有容器会继续使用旧设置运行
|
||||
- 容器仅在空闲 24 小时后才会被清理
|
||||
@@ -123,7 +123,7 @@ openclaw sandbox recreate --agent alfred
|
||||
|
||||
**解决方案:** 使用 `openclaw sandbox recreate` 强制移除旧容器。它们会在下次需要时自动使用当前设置重新创建。
|
||||
|
||||
提示:建议使用 `openclaw sandbox recreate` 而非手动执行 `docker rm`。它使用 Gateway 的容器命名规则,避免在作用域/会话键发生变化时出现不匹配问题。
|
||||
提示:建议使用 `openclaw sandbox recreate` 而非手动执行 `docker rm`。它使用 Gateway网关的容器命名规则,避免在作用域/会话键发生变化时出现不匹配问题。
|
||||
|
||||
## 配置
|
||||
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
read_when:
|
||||
- 您在不使用完整上手引导向导的情况下进行首次设置
|
||||
- 您想设置默认工作区路径
|
||||
- 你在不使用完整新手引导向导的情况下进行首次设置
|
||||
- 你想设置默认工作区路径
|
||||
summary: "`openclaw setup` 的 CLI 参考(初始化配置 + 工作区)"
|
||||
title: setup
|
||||
x-i18n:
|
||||
@@ -20,7 +20,7 @@ x-i18n:
|
||||
相关内容:
|
||||
|
||||
- 快速开始:[快速开始](/start/getting-started)
|
||||
- 向导:[上手引导](/start/onboarding)
|
||||
- 向导:[新手引导](/start/onboarding)
|
||||
|
||||
## 示例
|
||||
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
---
|
||||
read_when:
|
||||
- 想要查看哪些技能可用且可以运行
|
||||
- 想要调试技能缺失的二进制文件/环境变量/配置
|
||||
summary: 技能列表/信息/检查及技能资格的 `openclaw skills` CLI 参考
|
||||
- 想要查看哪些 Skills 可用且可以运行
|
||||
- 想要调试 Skills 缺失的二进制文件/环境变量/配置
|
||||
summary: Skills 列表/信息/检查及 Skills 资格的 `openclaw skills` CLI 参考
|
||||
title: skills
|
||||
x-i18n:
|
||||
generated_at: "2026-02-01T20:21:28Z"
|
||||
@@ -15,12 +15,12 @@ x-i18n:
|
||||
|
||||
# `openclaw skills`
|
||||
|
||||
检查技能(内置 + 工作区 + 托管覆盖),查看哪些符合条件以及哪些缺少依赖。
|
||||
检查 Skills(内置 + 工作区 + 托管覆盖),查看哪些符合条件以及哪些缺少依赖。
|
||||
|
||||
相关内容:
|
||||
|
||||
- 技能系统:[技能](/tools/skills)
|
||||
- 技能配置:[技能配置](/tools/skills-config)
|
||||
- Skills 系统:[Skills](/tools/skills)
|
||||
- Skills配置:[Skills配置](/tools/skills-config)
|
||||
- ClawHub 安装:[ClawHub](/tools/clawhub)
|
||||
|
||||
## 命令
|
||||
|
||||
@@ -28,6 +28,6 @@ openclaw status --usage
|
||||
|
||||
- `--deep` 会运行实时探测(WhatsApp Web + Telegram + Discord + Google Chat + Slack + Signal)。
|
||||
- 当配置了多个智能体时,输出包含每个智能体的会话存储。
|
||||
- 概览包含 Gateway 和节点主机服务的安装/运行状态(如可用)。
|
||||
- 概览包含 Gateway网关和节点主机服务的安装/运行状态(如可用)。
|
||||
- 概览包含更新渠道和 git SHA(适用于源码检出)。
|
||||
- 更新信息会显示在概览中;如果有可用更新,状态会提示运行 `openclaw update`(参见[更新](/install/updating))。
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
---
|
||||
read_when:
|
||||
- 您想在不创建 cron 任务的情况下将系统事件加入队列
|
||||
- 您需要启用或禁用心跳
|
||||
- 您想检查系统存在状态条目
|
||||
- 你想在不创建 cron 任务的情况下将系统事件加入队列
|
||||
- 你需要启用或禁用心跳
|
||||
- 你想检查系统存在状态条目
|
||||
summary: "`openclaw system` 的 CLI 参考(系统事件、心跳、存在状态)"
|
||||
title: system
|
||||
x-i18n:
|
||||
@@ -16,7 +16,7 @@ x-i18n:
|
||||
|
||||
# `openclaw system`
|
||||
|
||||
Gateway 的系统级辅助工具:将系统事件加入队列、控制心跳以及查看存在状态。
|
||||
Gateway网关的系统级辅助工具:将系统事件加入队列、控制心跳以及查看存在状态。
|
||||
|
||||
## 常用命令
|
||||
|
||||
@@ -51,7 +51,7 @@ openclaw system presence
|
||||
|
||||
## `system presence`
|
||||
|
||||
列出 Gateway 已知的当前系统存在状态条目(节点、实例及类似状态行)。
|
||||
列出 Gateway网关已知的当前系统存在状态条目(节点、实例及类似状态行)。
|
||||
|
||||
标志:
|
||||
|
||||
@@ -59,5 +59,5 @@ openclaw system presence
|
||||
|
||||
## 注意事项
|
||||
|
||||
- 需要当前配置(本地或远程)可访问的运行中 Gateway。
|
||||
- 需要当前配置(本地或远程)可访问的运行中 Gateway网关。
|
||||
- 系统事件是临时的,不会在重启后持久化。
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
---
|
||||
read_when:
|
||||
- 想要使用 Gateway 的终端 UI(支持远程)
|
||||
- 想要使用 Gateway网关的终端 UI(支持远程)
|
||||
- 想要从脚本传递 url/token/session
|
||||
summary: 连接到 Gateway 的终端 UI 的 `openclaw tui` CLI 参考
|
||||
summary: 连接到 Gateway网关的终端 UI 的 `openclaw tui` CLI 参考
|
||||
title: tui
|
||||
x-i18n:
|
||||
generated_at: "2026-02-01T20:21:31Z"
|
||||
@@ -15,7 +15,7 @@ x-i18n:
|
||||
|
||||
# `openclaw tui`
|
||||
|
||||
打开连接到 Gateway 的终端 UI。
|
||||
打开连接到 Gateway网关的终端 UI。
|
||||
|
||||
相关内容:
|
||||
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
---
|
||||
read_when:
|
||||
- 您想移除 Gateway 服务和/或本地状态
|
||||
- 您想先进行试运行
|
||||
summary: "`openclaw uninstall`(移除 Gateway 服务 + 本地数据)的 CLI 参考"
|
||||
- 你想移除 Gateway网关服务和/或本地状态
|
||||
- 你想先进行试运行
|
||||
summary: "`openclaw uninstall`(移除 Gateway网关服务 + 本地数据)的 CLI 参考"
|
||||
title: uninstall
|
||||
x-i18n:
|
||||
generated_at: "2026-02-01T20:21:33Z"
|
||||
@@ -15,7 +15,7 @@ x-i18n:
|
||||
|
||||
# `openclaw uninstall`
|
||||
|
||||
卸载 Gateway 服务 + 本地数据(CLI 保留)。
|
||||
卸载 Gateway网关服务 + 本地数据(CLI 保留)。
|
||||
|
||||
```bash
|
||||
openclaw uninstall
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
read_when:
|
||||
- 你想安全地更新源码检出
|
||||
- 你需要了解 `--update` 简写行为
|
||||
summary: "`openclaw update`(安全的源码更新 + Gateway 自动重启)的 CLI 参考"
|
||||
summary: "`openclaw update`(安全的源码更新 + Gateway网关自动重启)的 CLI 参考"
|
||||
title: update
|
||||
x-i18n:
|
||||
generated_at: "2026-02-01T20:21:45Z"
|
||||
@@ -35,7 +35,7 @@ openclaw --update
|
||||
|
||||
## 选项
|
||||
|
||||
- `--no-restart`:成功更新后跳过重启 Gateway 服务。
|
||||
- `--no-restart`:成功更新后跳过重启 Gateway网关服务。
|
||||
- `--channel <stable|beta|dev>`:设置更新渠道(git + npm;持久化到配置中)。
|
||||
- `--tag <dist-tag|version>`:仅为本次更新覆盖 npm dist-tag 或版本。
|
||||
- `--json`:输出机器可读的 `UpdateRunResult` JSON。
|
||||
@@ -60,7 +60,7 @@ openclaw update status --timeout 10
|
||||
|
||||
## `update wizard`
|
||||
|
||||
交互式流程,用于选择更新渠道并确认更新后是否重启 Gateway(默认重启)。如果你选择 `dev` 但没有 git 检出,它会提供创建一个的选项。
|
||||
交互式流程,用于选择更新渠道并确认更新后是否重启 Gateway网关(默认重启)。如果你选择 `dev` 但没有 git 检出,它会提供创建一个的选项。
|
||||
|
||||
## 工作原理
|
||||
|
||||
|
||||
@@ -38,4 +38,4 @@ openclaw voicecall expose --mode funnel
|
||||
openclaw voicecall unexpose
|
||||
```
|
||||
|
||||
安全提示:仅将 webhook 端点暴露给您信任的网络。尽可能优先使用 Tailscale Serve 而非 Funnel。
|
||||
安全提示:仅将 webhook 端点暴露给你信任的网络。尽可能优先使用 Tailscale Serve 而非 Funnel。
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
read_when:
|
||||
- 您想将 Gmail Pub/Sub 事件接入 OpenClaw
|
||||
- 您需要 Webhook 辅助命令
|
||||
- 你想将 Gmail Pub/Sub 事件接入 OpenClaw
|
||||
- 你需要 Webhook 辅助命令
|
||||
summary: "`openclaw webhooks`(Webhook 辅助工具 + Gmail Pub/Sub)的 CLI 参考"
|
||||
title: webhooks
|
||||
x-i18n:
|
||||
|
||||
Reference in New Issue
Block a user