网关 CLI
网关是 openclaw 的 WebSocket 服务器(频道、节点、会话、钩子)。
本页面中的子命令位于 openclaw gateway … 下。
相关文档:
运行网关
运行本地网关进程:
bash
openclaw gateway前台别名:
bash
openclaw gateway run注意事项:
- 默认情况下,除非在
~/.clawdbot/openclaw.json中设置了gateway.mode=local,否则网关拒绝启动。使用--allow-unconfigured进行临时/开发运行。 - 没有认证的情况下绑定到环回地址之外是被阻止的(安全护栏)。
SIGUSR1在授权时触发进程内重启(启用commands.restart或使用网关工具/配置应用/更新)。SIGINT/SIGTERM处理程序停止网关进程,但它们不恢复任何自定义终端状态。如果您使用 TUI 或原始模式输入包装 CLI,请在退出前恢复终端。
选项
--port <port>: WebSocket 端口(默认来自配置/环境变量;通常为18789)。--bind <loopback|lan|tailnet|auto|custom>: 监听器绑定模式。--auth <token|password>: 认证模式覆盖。--token <token>: 令牌覆盖(同时为进程设置CLAWDBOT_GATEWAY_TOKEN)。--password <password>: 密码覆盖(同时为进程设置CLAWDBOT_GATEWAY_PASSWORD)。--tailscale <off|serve|funnel>: 通过 Tailscale 暴露网关。--tailscale-reset-on-exit: 在关闭时重置 Tailscale serve/funnel 配置。--allow-unconfigured: 允许网关启动,无需在配置中设置gateway.mode=local。--dev: 如果缺少则创建开发配置 + 工作空间(跳过 BOOTSTRAP.md)。--reset: 重置开发配置 + 凭据 + 会话 + 工作空间(需要--dev)。--force: 在启动前终止选定端口上的任何现有监听器。--verbose: 详细日志。--claude-cli-logs: 仅在控制台中显示 claude-cli 日志(并启用其 stdout/stderr)。--ws-log <auto|full|compact>: websocket 日志样式(默认auto)。--compact:--ws-log compact的别名。--raw-stream: 将原始模型流事件记录到 jsonl。--raw-stream-path <path>: 原始流 jsonl 路径。
查询运行中的网关
所有查询命令都使用 WebSocket RPC。
输出模式:
- 默认:人类可读(在 TTY 中着色)。
--json: 机器可读的 JSON(无样式/旋转器)。--no-color(或NO_COLOR=1):禁用 ANSI,同时保持人类布局。
共享选项(在支持的地方):
--url <url>: 网关 WebSocket URL。--token <token>: 网关令牌。--password <password>: 网关密码。--timeout <ms>: 超时/预算(因命令而异)。--expect-final: 等待"最终"响应(代理调用)。
gateway health
bash
openclaw gateway health --url ws://127.0.0.1:18789gateway status
gateway status 显示网关服务(launchd/systemd/schtasks)以及可选的 RPC 探测。
bash
openclaw gateway status
openclaw gateway status --json选项:
--url <url>:覆盖探测 URL。--token <token>:探测的令牌认证。--password <password>:探测的密码认证。--timeout <ms>:探测超时(默认10000)。--no-probe:跳过 RPC 探测(仅服务视图)。--deep:扫描系统级服务。
gateway probe
gateway probe 是"调试所有内容"的命令。它总是探测:
- 您配置的远程网关(如果已设置),以及
- 本地主机(环回)即使配置了远程网关。
如果多个网关可达,它会打印所有网关。当您使用隔离的配置文件/端口时(例如,救援机器人),支持多个网关,但大多数安装仍然运行单个网关。
bash
openclaw gateway probe
openclaw gateway probe --json通过 SSH 远程(Mac 应用对等)
macOS 应用的"通过 SSH 远程"模式使用本地端口转发,使远程网关(可能仅绑定到环回)在 ws://127.0.0.1:<port> 可达。
CLI 等效:
bash
openclaw gateway probe --ssh user@gateway-host选项:
--ssh <target>:user@host或user@host:port(端口默认为22)。--ssh-identity <path>:身份文件。--ssh-auto:选择第一个发现的网关主机作为 SSH 目标(仅限 LAN/WAB)。
配置(可选,用作默认值):
gateway.remote.sshTargetgateway.remote.sshIdentity
gateway call <method>
低级 RPC 助手。
bash
openclaw gateway call status
openclaw gateway call logs.tail --params '{"sinceMs": 60000}'管理网关服务
bash
openclaw gateway install
openclaw gateway start
openclaw gateway stop
openclaw gateway restart
openclaw gateway uninstall注意事项:
gateway install支持--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
bash
openclaw gateway discover选项:
--timeout <ms>:每个命令的超时(浏览/解析);默认2000。--json:机器可读的输出(同时禁用样式/旋转器)。
示例:
bash
openclaw gateway discover --timeout 4000
openclaw gateway discover --json | jq '.beacons[].wsUrl'