网关 CLI

网关�?OpenClaw �?WebSocket 服务器(频道、节点、会话、钩子)�?

本页面中的子命令位于 openclaw gateway … 下�?

相关文档�?

运行网关

运行本地网关进程�?

openclaw gateway

前台运行别名�?

openclaw gateway run

注意事项�?

  • 默认情况下,除非�?~/.openclaw/openclaw.json 中设�?gateway.mode=local,否则网关拒绝启动。使�?--allow-unconfigured 进行临时/开发运行�?
  • 在环回之外绑定需要认证(安全护栏)�?
  • SIGUSR1 在获得授权时触发进程内重启(commands.restart 默认启用;设�?commands.restart: false 阻止手动重启,但允许网关工具/配置应用/更新)�?
  • SIGINT/SIGTERM 处理器停止网关进程,但不会恢复任何自定义终端状态。如果你�?TUI 或原始模式输入包�?CLI,请在退出前恢复终端�?

选项

  • --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 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:等�?最�?响应(智能体调用)�?

注意:当你设�?--url 时,CLI 不会回退到配置或环境凭证。需要显式传�?--token �?--password。缺少显式凭证会导致错误�?

gateway health

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

gateway status

gateway status 显示网关服务(launchd/systemd/schtasks)以及可选的 RPC 探测�?

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 �?调试一�?命令。它始终探测�?

  • 你配置的远程网关(如果已设置),�?
  • 本地环回�?即使已配置远�?)�?

如果可以访问多个网关,它会打印所有网关。当你使用隔离的配置文件/端口时支持多个网关(例如救援机器人),但大多数安装仍运行单个网关�?

openclaw gateway probe
openclaw gateway probe --json

远程 SSH(Mac 应用 parity�?

macOS 应用”远程 SSH”模式使用本地端口转发,使远程网关(可能仅绑定到环回)�?ws://127.0.0.1:<port> 可访问�?

CLI 等效命令�?

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.sshTarget
  • gateway.remote.sshIdentity

gateway call <method>

低级 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

注意事项�?

  • 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

openclaw gateway discover

选项�?

  • --timeout <ms>:每命令超时(浏�?解析);默认 2000�?
  • --json:机器可读输出(也禁用样�?旋转器)�?

示例�?

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