CLI 命令

Gateway 网关

Gateway 网关是 OpenClaw 的 WebSocket 服务器(渠道、节点、会话、钩子)。本页中的子命令位于 openclaw gateway … 之下。

运行 Gateway 网关

运行本地 Gateway 网关进程:

bash
openclaw gateway

前台别名:

bash
openclaw gateway run
启动行为
  • 默认情况下,除非在 ~/.openclaw/openclaw.json 中设置了 gateway.mode=local,否则 Gateway 网关会拒绝启动。对临时/开发运行使用 --allow-unconfigured
  • openclaw onboard --mode localopenclaw setup 应写入 gateway.mode=local。如果文件存在但缺少 gateway.mode,应将其视为损坏或被覆盖的配置并修复,而不是隐式假定为本地模式。
  • 如果文件存在且缺少 gateway.mode,Gateway 网关会将其视为可疑的配置损坏,并拒绝为你“猜测本地模式”。
  • 未经身份验证绑定到 loopback 之外会被阻止(安全防护栏)。
  • SIGUSR1 会在已授权时触发进程内重启(默认启用 commands.restart;设置 commands.restart: false 可阻止手动重启,同时仍允许 Gateway 网关工具/配置应用/更新)。
  • SIGINT/SIGTERM 处理程序会停止 Gateway 网关进程,但不会恢复任何自定义终端状态。如果你用 TUI 或 raw-mode 输入包装 CLI,请在退出前恢复终端。

选项

OPENCLAW_DOCS_MARKER:paramOpen:IHBhdGg9Ii0tcG9ydCA8cG9ydA " type="number"> WebSocket 端口(默认值来自配置/环境;通常为 18789)。

"--bind
"--auth

OPENCLAW_DOCS_MARKER:paramOpen:IHBhdGg9Ii0tdG9rZW4gPHRva2Vu " type="string"> Token 覆盖(也会为该进程设置 OPENCLAW_GATEWAY_TOKEN)。

"--password
"--tailscale
--tailscale-reset-on-exitboolean

关闭时重置 Tailscale serve/funnel 配置。

--allow-unconfiguredboolean

允许在配置中没有 gateway.mode=local 的情况下启动 Gateway 网关。仅为临时/开发 bootstrap 绕过启动防护;不会写入或修复配置文件。

--devboolean

如果缺失,则创建开发配置 + 工作区(跳过 BOOTSTRAP.md)。

--resetboolean

重置开发配置 + 凭据 + 会话 + 工作区(需要 --dev)。

--forceboolean

启动前杀掉所选端口上的任何现有监听器。

--verboseboolean

详细日志。

--cli-backend-logsboolean

仅在控制台显示 CLI 后端日志(并启用 stdout/stderr)。

"--ws-log
--compactboolean

--ws-log compact 的别名。

--raw-streamboolean

将原始模型流事件记录到 jsonl。

重启 Gateway 网关

bash
openclaw gateway restartopenclaw gateway restart --safeopenclaw gateway restart --safe --skip-deferralopenclaw gateway restart --force

openclaw gateway restart --safe 会要求正在运行的 Gateway 网关在重启前预检活跃的 OpenClaw 工作。如果队列操作、回复投递、嵌入式运行或任务运行处于活跃状态,Gateway 网关会报告阻塞项、合并重复的安全重启请求,并在活跃工作排空后重启。普通 restart 会保留现有服务管理器行为以保持兼容性。仅当你明确需要立即覆盖路径时才使用 --force

openclaw gateway restart --safe --skip-deferral 会运行与 --safe 相同的 OpenClaw 感知协调重启,但会绕过活跃工作延迟门控,因此即使报告了阻塞项,Gateway 网关也会立即发出重启。当延迟被卡住的任务运行固定住,而单独使用 --safe 会无限期等待时,可将其作为操作员逃生口。--skip-deferral 需要 --safe

启动性能分析

  • 设置 OPENCLAW_GATEWAY_STARTUP_TRACE=1 以记录 Gateway 网关启动期间的阶段耗时,包括每个阶段的 eventLoopMax 延迟,以及 installed-index、清单注册表、启动规划和 owner-map 工作的插件查找表耗时。
  • 设置 OPENCLAW_DIAGNOSTICS=timeline 并配合 OPENCLAW_DIAGNOSTICS_TIMELINE_PATH=<path>,为外部 QA harness 写入尽力而为的 JSONL 启动诊断时间线。你也可以在配置中通过 diagnostics.flags: ["timeline"] 启用该标志;路径仍由环境提供。添加 OPENCLAW_DIAGNOSTICS_EVENT_LOOP=1 可包含事件循环采样。
  • 运行 pnpm test:startup:gateway -- --runs 5 --warmup 1 来基准测试 Gateway 网关启动。该基准会记录首次进程输出、/healthz/readyz、启动跟踪耗时、事件循环延迟,以及插件查找表耗时详情。

查询正在运行的 Gateway 网关

所有查询命令都使用 WebSocket RPC。

输出模式

  • 默认:人类可读(TTY 中带颜色)。
  • --json:机器可读 JSON(无样式/加载动画)。
  • --no-color(或 NO_COLOR=1):在保留人类布局的同时禁用 ANSI。

共享选项

  • --url <url>:Gateway 网关 WebSocket URL。
  • --token <token>:Gateway 网关 token。
  • --password <password>:Gateway 网关密码。
  • --timeout <ms>:超时/预算(因命令而异)。
  • --expect-final:等待“final”响应(智能体调用)。

gateway health

bash
openclaw gateway health --url ws://127.0.0.1:18789

HTTP /healthz 端点是存活探针:服务器能够响应 HTTP 后即返回。HTTP /readyz 端点更严格,在启动插件 sidecar、渠道或已配置钩子仍在稳定期间会保持红色。本地或已认证的详细就绪响应会包含一个 eventLoop 诊断块,其中有事件循环延迟、事件循环利用率、CPU 核心比率和 degraded 标志。

gateway usage-cost

从会话日志获取 usage-cost 摘要。

bash
openclaw gateway usage-costopenclaw gateway usage-cost --days 7openclaw gateway usage-cost --json
"--days

gateway stability

从正在运行的 Gateway 网关获取最近的诊断稳定性记录器。

bash
openclaw gateway stabilityopenclaw gateway stability --type payload.largeopenclaw gateway stability --bundle latestopenclaw gateway stability --bundle latest --exportopenclaw gateway stability --json

OPENCLAW_DOCS_MARKER:paramOpen:IHBhdGg9Ii0tbGltaXQgPGxpbWl0 " type="number" default="25"> 要包含的最近事件最大数量(最大 1000)。

OPENCLAW_DOCS_MARKER:paramOpen:IHBhdGg9Ii0tdHlwZSA8dHlwZQ " type="string"> 按诊断事件类型过滤,例如 payload.largediagnostic.memory.pressure

"--since-seq
--bundle [path]string

读取已持久化的稳定性包,而不是调用正在运行的 Gateway 网关。使用 --bundle latest(或仅 --bundle)读取状态目录下的最新包,或直接传入包 JSON 路径。

--exportboolean

写入可共享的支持诊断 zip,而不是打印稳定性详情。

OPENCLAW_DOCS_MARKER:paramOpen:IHBhdGg9Ii0tb3V0cHV0IDxwYXRo " type="string"> --export 的输出路径。

隐私和包行为
  • 记录会保留运行元数据:事件名称、计数、字节大小、内存读数、队列/会话状态、渠道/插件名称,以及已脱敏的会话摘要。它们不会保留聊天文本、webhook 正文、工具输出、原始请求或响应正文、token、cookie、密钥值、主机名或原始会话 ID。设置 diagnostics.enabled: false 可完全禁用记录器。
  • 在 Gateway 网关致命退出、关闭超时和重启启动失败时,如果记录器有事件,OpenClaw 会将同一诊断快照写入 ~/.openclaw/logs/stability/openclaw-stability-*.json。使用 openclaw gateway stability --bundle latest 检查最新包;--limit--type--since-seq 也适用于包输出。

gateway diagnostics export

写入本地诊断 zip,设计用于附加到错误报告。有关隐私模型和包内容,请参阅 诊断导出

bash
openclaw gateway diagnostics exportopenclaw gateway diagnostics export --output openclaw-diagnostics.zipopenclaw gateway diagnostics export --json
"--log-lines
"--log-bytes
"--url
"--token
"--password
"--timeout
--no-stability-bundleboolean

跳过已持久化稳定性包查找。

--jsonboolean

将写入路径、大小和清单打印为 JSON。

导出内容包含清单、Markdown 摘要、配置形状、已清理的配置详情、已清理的日志摘要、已清理的 Gateway 网关 Status/健康快照,以及存在时的最新稳定性包。

它用于共享。它会保留有助于调试的运行细节,例如安全的 OpenClaw 日志字段、子系统名称、状态码、时长、已配置模式、端口、插件 ID、提供商 ID、非密钥功能设置,以及已脱敏的运行日志消息。它会省略或脱敏聊天文本、webhook 正文、工具输出、凭据、cookie、账号/消息标识符、提示/指令文本、主机名和密钥值。当 LogTape 风格的消息看起来像用户/聊天/工具载荷文本时,导出只保留一条消息被省略及其字节数。

gateway status

gateway status 会显示 Gateway 网关服务(launchd/systemd/schtasks),以及一个可选的连通性/身份验证能力探针。

bash
openclaw gateway statusopenclaw gateway status --jsonopenclaw gateway status --require-rpc
"--url
"--token
"--password
"--timeout
--no-probeboolean

跳过连通性探测(仅服务视图)。

--deepboolean

同时扫描系统级服务。

--require-rpcboolean

将默认连通性探测升级为读取探测,并在该读取探测失败时以非零状态退出。不能与 --no-probe 组合使用。

Status 语义
  • 即使本地 CLI 配置缺失或无效,gateway status 仍可用于诊断。
  • 默认的 gateway status 会证明服务状态、WebSocket 连接,以及握手时可见的认证能力。它不会证明读/写/管理操作。
  • 对首次设备认证,诊断探测不会产生变更:当已有缓存设备令牌时会复用它们,但不会仅为检查状态而创建新的 CLI 设备身份或只读设备配对记录。
  • 可行时,gateway status 会解析已配置的认证 SecretRefs 用于探测认证。
  • 如果此命令路径中所需的认证 SecretRef 未解析,gateway status --json 会在探测连通性/认证失败时报告 rpc.authWarning;请显式传入 --token/--password,或先解析密钥来源。
  • 如果探测成功,未解析的认证引用警告会被抑制,以避免误报。
  • 当监听服务本身还不够,而你还需要读取范围的 RPC 调用也健康时,请在脚本和自动化中使用 --require-rpc
  • --deep 会添加对额外 launchd/systemd/schtasks 安装的尽力扫描。当检测到多个类似 Gateway 网关的服务时,人类可读输出会打印清理提示,并警告大多数设置应在每台机器上运行一个 Gateway 网关。
  • 当服务进程为外部监督器重启而干净退出时,--deep 也会报告最近一次 Gateway 网关监督器重启交接。
  • --deep 会以插件感知模式(pluginValidation: "full")运行配置验证,并显示已配置插件清单警告(例如缺少渠道配置元数据),以便安装和更新冒烟检查能捕获它们。默认的 gateway status 保持快速只读路径,跳过插件验证。
  • 人类可读输出包含解析后的文件日志路径,以及 CLI 与服务配置路径/有效性快照,用于帮助诊断配置文件或状态目录漂移。
Linux systemd 认证漂移检查
  • 在 Linux systemd 安装上,服务认证漂移检查会从单元中读取 Environment=EnvironmentFile= 值(包括 %h、带引号的路径、多个文件以及可选的 - 文件)。
  • 漂移检查会使用合并后的运行时环境解析 gateway.auth.token SecretRefs(先使用服务命令环境,再回退到进程环境)。
  • 如果令牌认证实际上未启用(显式 gateway.auth.modepassword/none/trusted-proxy,或模式未设置且密码可能优先、没有令牌候选可能优先),令牌漂移检查会跳过配置令牌解析。

gateway probe

gateway probe 是“调试所有内容”的命令。它始终会探测:

  • 你已配置的远程 Gateway 网关(如果已设置),以及
  • localhost(loopback),即使已配置远程目标

如果你传入 --url,该显式目标会被添加到两者之前。人类可读输出会将目标标记为:

  • URL (explicit)
  • Remote (configured)Remote (configured, inactive)
  • Local loopback
bash
openclaw gateway probeopenclaw gateway probe --json
解读
  • Reachable: yes 表示至少一个目标接受了 WebSocket 连接。
  • Capability: read-only|write-capable|admin-capable|pairing-pending|connect-only 报告探测能证明的认证情况。它与可达性是分开的。
  • Read probe: ok 表示读取范围的详细 RPC 调用(health/status/system-presence/config.get)也成功了。
  • Read probe: limited - missing scope: operator.read 表示连接成功,但读取范围的 RPC 受限。这会被报告为降级可达性,而不是完全失败。
  • Connect: ok 之后的 Read probe: failed 表示 Gateway 网关接受了 WebSocket 连接,但后续读取诊断超时或失败。这同样是降级可达性,而不是 Gateway 网关不可达。
  • gateway status 一样,probe 会复用现有缓存设备认证,但不会创建首次设备身份或配对状态。
  • 只有在没有任何被探测目标可达时,退出码才为非零。
JSON 输出

顶层:

  • ok:至少一个目标可达。
  • degraded:至少一个目标接受了连接,但未完成完整的详细 RPC 诊断。
  • capability:在可达目标中看到的最佳能力(read_onlywrite_capableadmin_capablepairing_pendingconnected_no_operator_scopeunknown)。
  • primaryTargetId:按以下顺序视为当前活跃胜出者的最佳目标:显式 URL、SSH 隧道、已配置远程目标,然后是 local loopback。
  • warnings[]:尽力而为的警告记录,包含 codemessage 和可选的 targetIds
  • network:从当前配置和主机网络派生的 local loopback/tailnet URL 提示。
  • discovery.timeoutMsdiscovery.count:此探测轮次使用的实际设备发现预算/结果数量。

每个目标(targets[].connect):

  • ok:连接后的可达性 + 降级分类。
  • rpcOk:完整详细 RPC 成功。
  • scopeLimited:详细 RPC 因缺少 operator scope 而失败。

每个目标(targets[].auth):

  • role:可用时,hello-ok 中报告的认证角色。
  • scopes:可用时,hello-ok 中报告的已授予 scope。
  • capability:该目标显示的认证能力分类。
常见警告代码
  • ssh_tunnel_failed:SSH 隧道设置失败;命令回退到直接探测。
  • multiple_gateways:多个目标可达;除非你有意运行隔离的配置文件(例如救援 bot),否则这并不常见。
  • auth_secretref_unresolved:无法为失败目标解析已配置的认证 SecretRef。
  • probe_scope_limited:WebSocket 连接成功,但读取探测因缺少 operator.read 而受限。

通过 SSH 访问远程目标(与 Mac 应用一致)

macOS 应用的“通过 SSH 访问远程目标”模式使用本地端口转发,因此远程 Gateway 网关(它可能只绑定到 loopback)会在 ws://127.0.0.1:<port> 可达。

CLI 等效命令:

bash
openclaw gateway probe --ssh user@gateway-host

OPENCLAW_DOCS_MARKER:paramOpen:IHBhdGg9Ii0tc3NoIDx0YXJnZXQ " type="string"> user@hostuser@host:port(端口默认为 22)。

--ssh-autoboolean

从解析后的设备发现端点(local. 加上已配置的广域域名,如果有)中选择第一个发现的 Gateway 网关主机作为 SSH 目标。仅 TXT 的提示会被忽略。

配置(可选,用作默认值):

  • gateway.remote.sshTarget
  • gateway.remote.sshIdentity

gateway call <method>

低层 RPC 辅助命令。

bash
openclaw gateway call statusopenclaw gateway call logs.tail --params '{"sinceMs": 60000}'
"--params
"--url
"--token
"--password
"--timeout
--expect-finalboolean

主要用于 agent 风格的 RPC,这类 RPC 会在最终载荷之前流式传输中间事件。

--jsonboolean

机器可读的 JSON 输出。

管理 Gateway 网关服务

bash
openclaw gateway installopenclaw gateway startopenclaw gateway stopopenclaw gateway restartopenclaw gateway uninstall

使用包装器安装

当托管服务必须通过另一个可执行文件启动时,请使用 --wrapper,例如密钥管理器 shim 或 run-as 辅助程序。包装器会接收普通 Gateway 网关参数,并负责最终用这些参数 exec openclaw 或 Node。

bash
cat > ~/.local/bin/openclaw-doppler <<'EOF'#!/usr/bin/env bashset -euo pipefailexec doppler run --project my-project --config production -- openclaw "$@"EOFchmod +x ~/.local/bin/openclaw-doppler openclaw gateway install --wrapper ~/.local/bin/openclaw-doppler --forceopenclaw gateway restart

你也可以通过环境设置包装器。gateway install 会验证路径是可执行文件,将包装器写入服务 ProgramArguments,并在服务环境中持久化 OPENCLAW_WRAPPER,供后续强制重新安装、更新和 Doctor 修复使用。

bash
OPENCLAW_WRAPPER="$HOME/.local/bin/openclaw-doppler" openclaw gateway install --forceopenclaw doctor

要移除已持久化的包装器,请在重新安装时清空 OPENCLAW_WRAPPER

bash
OPENCLAW_WRAPPER= openclaw gateway install --forceopenclaw gateway restart
命令选项
  • gateway status--url--token--password--timeout--no-probe--require-rpc--deep--json
  • gateway install--port--runtime <node|bun>--token--wrapper <path>--force--json
  • gateway restart--safe--skip-deferral--force--wait <duration>--json
  • gateway uninstall|start--json
  • gateway stop--disable--json
生命周期行为
  • 使用 gateway restart 重启托管服务。不要把 gateway stopgateway start 串联起来作为重启替代方式。
  • 在 macOS 上,gateway stop 默认使用 launchctl bootout,这会从当前启动会话中移除 LaunchAgent,但不会持久化禁用设置 —— KeepAlive 自动恢复会在后续崩溃时继续生效,并且 gateway start 可以干净地重新启用,无需手动执行 launchctl enable。传入 --disable 可持久化抑制 KeepAlive 和 RunAtLoad,使 Gateway 网关在下一次显式执行 gateway start 之前不会重新生成;当手动停止需要在重启或系统重启后仍然保持时,请使用此选项。
  • gateway restart --safe 会要求正在运行的 Gateway 网关预检活跃的 OpenClaw 工作,并将重启推迟到回复交付、嵌入式运行和任务运行全部排空之后。--safe 不能与 --force--wait 组合使用。
  • gateway restart --wait 30s 会覆盖该次重启配置的重启排空预算。裸数字表示毫秒;也接受 smh 等单位。--wait 0 会无限期等待。
  • gateway restart --safe --skip-deferral 会运行感知 OpenClaw 的安全重启,但绕过延迟门控,因此即使报告了阻塞项,Gateway 网关也会立即发出重启。用于任务运行延迟卡住时的操作员逃生口;需要 --safe
  • gateway restart --force 会跳过活跃工作排空并立即重启。当操作员已经检查过列出的任务阻塞项,并希望 Gateway 网关立即恢复时使用。
  • 生命周期命令接受 --json,用于脚本编写。
安装时的认证和 SecretRefs
  • 当令牌认证需要令牌且 gateway.auth.token 由 SecretRef 管理时,gateway install 会验证 SecretRef 可解析,但不会将解析后的令牌持久化到服务环境元数据中。
  • 如果令牌认证需要令牌,而配置的令牌 SecretRef 未解析,安装会关闭失败,而不是持久化回退明文。
  • 对于 gateway run 上的密码认证,优先使用 OPENCLAW_GATEWAY_PASSWORD--password-file,或由 SecretRef 支持的 gateway.auth.password,而不是内联 --password
  • 在推断认证模式下,仅存在于 shell 中的 OPENCLAW_GATEWAY_PASSWORD 不会放宽安装令牌要求;安装托管服务时,请使用持久化配置(gateway.auth.password 或配置 env)。
  • 如果同时配置了 gateway.auth.tokengateway.auth.password,并且 gateway.auth.mode 未设置,安装会被阻止,直到显式设置模式。

发现 Gateway 网关(Bonjour)

gateway discover 会扫描 Gateway 网关信标(_openclaw-gw._tcp)。

  • 组播 DNS-SD:local.
  • 单播 DNS-SD(广域 Bonjour):选择一个域(示例:openclaw.internal.)并设置拆分 DNS + DNS 服务器;请参阅 Bonjour

只有启用了 Bonjour 发现(默认)的 Gateway 网关才会广播该信标。

广域发现记录可以包含这些 TXT 提示:

  • role(Gateway 网关角色提示)
  • transport(传输提示,例如 gateway
  • gatewayPort(WebSocket 端口,通常为 18789
  • sshPort(仅完整发现模式;缺失时,客户端默认 SSH 目标为 22
  • tailnetDns(MagicDNS 主机名,可用时)
  • gatewayTls / gatewayTlsSha256(已启用 TLS + 证书指纹)
  • cliPath(仅完整发现模式)

gateway discover

bash
openclaw gateway discover
"--timeout
--jsonboolean

机器可读输出(也会禁用样式和 spinner)。

示例:

bash
openclaw gateway discover --timeout 4000openclaw gateway discover --json | jq '.beacons[].wsUrl'

相关

Was this useful?