Files
openclaw-skill/openclaw-knowhow-skill/docs/reference/cli/gateway.md
Selig 4c966a3ad2 Initial commit: OpenClaw Skill Collection
6 custom skills (assign-task, dispatch-webhook, daily-briefing,
task-capture, qmd-brain, tts-voice) with technical documentation.
Compatible with Claude Code, OpenClaw, Codex CLI, and OpenCode.
2026-03-13 10:58:30 +08:00

1.5 KiB

gateway

openclaw gateway

The Gateway serves as OpenClaw's WebSocket server managing channels, nodes, sessions, and hooks. All subcommands operate under the openclaw gateway namespace.

Running the Gateway

Launch a local Gateway with:

openclaw gateway

Key startup requirements include setting gateway.mode=local in configuration, though --allow-unconfigured bypasses this for development. The system blocks loopback binding without authentication as a safety measure.

Query Commands

Gateway queries use WebSocket RPC with flexible output formatting (human-readable by default, JSON via --json flag).

Available commands:

  • gateway health: checks Gateway connectivity
  • gateway status: displays service status plus optional RPC probe
  • gateway probe: comprehensive debug command scanning configured and localhost gateways
  • gateway call <method>: low-level RPC helper for custom operations

Service Management

Standard lifecycle commands include:

openclaw gateway install
openclaw gateway start
openclaw gateway stop
openclaw gateway restart
openclaw gateway uninstall

Gateway Discovery

The gateway discover command scans for Gateway beacons using multicast DNS-SD (_openclaw-gw._tcp). Discovery records include details like WebSocket ports, SSH configuration, and TLS fingerprints when applicable.

Related documentation sections: Bonjour configuration, discovery protocols, and system configuration settings.