Skip to main content

​
网关 CLI

网关是 OpenClaw 的 WebSocket 服务器，负责管理通道、节点、会话和钩子。 本页面中的子命令位于 openclaw gateway … 下。 相关文档：

​
运行网关

运行本地网关进程： 
openclaw gateway
前台别名： 
openclaw gateway run
注意事项：
  • 默认情况下，网关会拒绝启动，除非在 ~/.openclaw/openclaw.json 中设置了 gateway.mode=local。对于临时或开发环境的运行，可以使用 --allow-unconfigured。
  • 在没有身份验证的情况下绑定到环回以外的地址会被阻止（作为一项安全防护机制）。
  • 当获得授权时，设置 SIGUSR1 会触发进程内重启（通过启用 commands.restart 或使用 gateway 工具/配置执行 apply/update 操作）。
  • 处理程序 SIGINT/SIGTERM 会停止网关进程，但不会恢复任何自定义终端状态。如果你将 CLI 包装在 TUI 或原始模式输入中，请在退出前恢复终端。

​
选项

  • --port <port>: WebSocket 端口（默认来自配置或环境变量；通常为 18789）。
  • --bind <loopback|lan|tailnet|auto|custom>: 监听器绑定模式。
  • --auth <token|password>: 身份验证模式覆盖。
  • --token <token>: 令牌覆盖（同时为进程设置 OPENCLAW_GATEWAY_TOKEN）。
  • --password <password>: 密码覆盖（同时为进程设置 OPENCLAW_GATEWAY_PASSWORD）。
  • --tailscale <off|serve|funnel>: 通过 Tailscale 公开网关。
  • --tailscale-reset-on-exit: 关机时重置 Tailscale 服务/隧道配置。
  • --allow-unconfigured: 全球网关
  • gateway.mode=local: 全球网关
  • gateway.mode=local: 允许在配置中缺少 --dev 的情况下启动网关。
  • --reset: 如果缺失，则创建开发配置 + 工作区（跳过 BOOTSTRAP.md）。
  • --dev: 重置开发配置 + 凭据 + 会话 + 工作区（需要 --force）。
  • --verbose: 在启动之前杀死选定端口上的任何现有监听器。
  • --claude-cli-logs: 详细日志。
  • --ws-log <auto|full|compact>: 仅在控制台中显示 claude-cli 日志（并启用其 stdout/stderr）。
  • auto: WebSocket 日志样式（默认为 --compact）。
  • --ws-log compact: 是 --raw-stream 的别名。
  • --raw-stream-path <path>: 将原始模型流事件记录到 jsonl。
  • --json: 原始流 jsonl 路径。

​
查询正在运行的网关

所有查询命令都使用 WebSocket RPC。 输出模式：
  • 默认：人类可读（TTY 中有颜色）。
  • --no-color: 机器可读 JSON（无样式/加载动画）。
  • NO_COLOR=1（或 --url <url>）：禁用 ANSI，但仍保持人类友好的布局。
共享选项（在支持的情况下）：
  • --token <token>: 网关 WebSocket URL。
  • --password <password>: 网关令牌。
  • --timeout <ms>: 网关密码。
  • --expect-final: 超时/预算（因命令而异）。
  • gateway health: 等待“最终”响应（代理调用）。

​
gateway status

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

​
gateway status

--url <url> 显示网关服务（launchd/systemd/schtasks），并可选地进行 RPC 探测。 
openclaw gateway status
openclaw gateway status --json
选项：
  • --token <token>: 覆盖探测 URL。
  • --password <password>: 探测的令牌认证。
  • --timeout <ms>: 探测的密码认证。
  • 10000: 探测超时（默认为 --no-probe）。
  • --deep: 跳过 RPC 探测（仅查看服务）。
  • gateway probe: 同时扫描系统级服务。

​
gateway probe

ws://127.0.0.1:<port> 是“调试一切”的命令。它始终探测：
  • 您配置的远程网关（如果已设置），以及
  • 本地主机（环回）即使已配置远程网关。
如果可以访问多个网关，它会打印所有网关。在使用隔离的配置文件或端口时（例如救援机器人），支持多个网关；不过，大多数安装仍然只运行一个网关。 
openclaw gateway probe
openclaw gateway probe --json

​
通过 SSH 进行远程连接（与 Mac 应用程序功能一致）

macOS 应用程序的“通过 SSH 进行远程连接”模式使用本地端口转发，使可能仅绑定到环回的远程网关能够在 --ssh <target> 上被访问。 CLI等效： 
openclaw gateway probe --ssh user@gateway-host
选项：
  • user@host: user@host:port 或 22（端口默认为 --ssh-identity <path>）。
  • --ssh-auto: 身份文件。
  • gateway.remote.sshTarget: 将第一个发现的网关主机作为 SSH 目标（仅限 LAN/WAB）。
配置（可选，用作默认值）：
  • gateway.remote.sshIdentity
  • gateway call <method>

​
gateway install

低级RPC辅助工具。 
openclaw gateway call status
openclaw gateway call logs.tail --params '{"sinceMs": 60000}'

​
管理网关服务

openclaw gateway install
openclaw gateway start
openclaw gateway stop
openclaw gateway restart
openclaw gateway uninstall
注意事项：
  • --port 支持 --runtime、--token、--force、--json。
  • 生命周期命令接受 --json 用于脚本编写。

​
发现网关（Bonjour）

gateway discover 扫描网关信标（_openclaw-gw._tcp）。
  • 多播 DNS-SD：local.
  • 单播 DNS-SD（广域 Bonjour）：选择一个域名（例如 openclaw.internal.），并设置拆分 DNS + DNS 服务器；请参阅 /gateway/bonjour
只有启用了 Bonjour 发现功能的网关才会广播信标。 广域发现记录包括（TXT）：
  • role（网关角色提示）
  • transport（传输提示，例如 gateway）
  • gatewayPort（WebSocket 端口，通常为 18789）
  • sshPort（SSH 端口；如果未指定，默认为 22）
  • tailnetDns（MagicDNS 主机名，如果可用）
  • gatewayTls / gatewayTlsSha256（TLS 已启用 + 证书指纹）
  • cliPath（远程安装的可选提示）

​
gateway discover

openclaw gateway discover
选项：
  • --timeout <ms>: 每个命令的超时时间（浏览/解析）；默认为 2000。
  • --json: 机器可读输出（同时禁用样式/加载动画）。
示例： 
openclaw gateway discover --timeout 4000
openclaw gateway discover --json | jq '.beacons[].wsUrl'