> ## Documentation Index > Fetch the complete documentation index at: https://openclaw.veiseule.ai/llms.txt > Use this file to discover all available pages before exploring further. # gateway # Gateway CLI De Gateway is de WebSocket-server van OpenClaw (kanalen, nodes, sessies, hooks). Subopdrachten op deze pagina vallen onder `openclaw gateway …`. Gerelateerde documentatie: * [/gateway/bonjour](/gateway/bonjour) * [/gateway/discovery](/gateway/discovery) * [/gateway/configuration](/gateway/configuration) ## De Gateway uitvoeren Start een lokaal Gateway-proces: ```bash theme={"theme":{"light":"min-light","dark":"min-dark"}} openclaw gateway ``` Foreground-alias: ```bash theme={"theme":{"light":"min-light","dark":"min-dark"}} openclaw gateway run ``` Notities: * Standaard weigert de Gateway te starten tenzij `gateway.mode=local` is ingesteld in `~/.openclaw/openclaw.json`. Gebruik `--allow-unconfigured` voor ad-hoc/dev-runs. * Binden buiten loopback zonder authenticatie is geblokkeerd (veiligheidsvangrail). * `SIGUSR1` triggert een herstart in het proces wanneer geautoriseerd (schakel `commands.restart` in of gebruik de gateway tool/config apply/update). * `SIGINT`/`SIGTERM`-handlers stoppen het gateway-proces, maar herstellen geen aangepaste terminalstatus. Als je de CLI omwikkelt met een TUI of raw-mode invoer, herstel de terminal vóór afsluiten. ### Opties * `--port `: WebSocket-poort (standaard komt uit config/env; meestal `18789`). * `--bind `: listener bind-modus. * `--auth `: override voor auth-modus. * `--token `: token-override (stelt ook `OPENCLAW_GATEWAY_TOKEN` in voor het proces). * `--password `: wachtwoord-override (stelt ook `OPENCLAW_GATEWAY_PASSWORD` in voor het proces). * `--tailscale `: de Gateway blootstellen via Tailscale. * `--tailscale-reset-on-exit`: Tailscale serve/funnel-config resetten bij afsluiten. * `--allow-unconfigured`: gateway-start toestaan zonder `gateway.mode=local` in de config. * `--dev`: een dev-config + werkruimte aanmaken indien ontbrekend (BOOTSTRAP.md overslaan). * `--reset`: dev-config + credentials + sessies + werkruimte resetten (vereist `--dev`). * `--force`: elke bestaande listener op de geselecteerde poort beëindigen vóór het starten. * `--verbose`: uitgebreide logs. * `--claude-cli-logs`: alleen claude-cli-logs in de console tonen (en stdout/stderr inschakelen). * `--ws-log `: websocket-logstijl (standaard `auto`). * `--compact`: alias voor `--ws-log compact`. * `--raw-stream`: ruwe model-streamgebeurtenissen loggen naar jsonl. * `--raw-stream-path `: pad voor ruwe stream-jsonl. ## Een draaiende Gateway bevragen Alle query-opdrachten gebruiken WebSocket RPC. Uitvoermodi: * Standaard: leesbaar voor mensen (gekleurd in TTY). * `--json`: machineleesbare JSON (geen styling/spinner). * `--no-color` (of `NO_COLOR=1`): ANSI uitschakelen met behoud van de menselijke lay-out. Gedeelde opties (waar ondersteund): * `--url `: Gateway WebSocket-URL. * `--token `: Gateway-token. * `--password `: Gateway-wachtwoord. * `--timeout `: timeout/budget (varieert per opdracht). * `--expect-final`: wachten op een “finale” respons (agent-calls). Let op: wanneer je `--url` instelt, valt de CLI niet terug op config- of omgevingscredentials. Geef `--token` of `--password` expliciet door. Ontbrekende expliciete credentials is een fout. ### `gateway health` ```bash theme={"theme":{"light":"min-light","dark":"min-dark"}} openclaw gateway health --url ws://127.0.0.1:18789 ``` ### `gateway status` `gateway status` toont de Gateway-service (launchd/systemd/schtasks) plus een optionele RPC-probe. ```bash theme={"theme":{"light":"min-light","dark":"min-dark"}} openclaw gateway status openclaw gateway status --json ``` Opties: * `--url `: de probe-URL overschrijven. * `--token `: token-authenticatie voor de probe. * `--password `: wachtwoord-authenticatie voor de probe. * `--timeout `: probe-timeout (standaard `10000`). * `--no-probe`: de RPC-probe overslaan (alleen service-weergave). * `--deep`: ook services op systeemniveau scannen. ### `gateway probe` `gateway probe` is de “debug alles”-opdracht. Deze probeert altijd: * je geconfigureerde externe gateway (indien ingesteld), en * localhost (loopback) **zelfs als remote is geconfigureerd**. Als meerdere gateways bereikbaar zijn, worden ze allemaal weergegeven. Meerdere gateways worden ondersteund wanneer je geïsoleerde profielen/poorten gebruikt (bijv. een rescue-bot), maar de meeste installaties draaien nog steeds één gateway. ```bash theme={"theme":{"light":"min-light","dark":"min-dark"}} openclaw gateway probe openclaw gateway probe --json ``` #### Op afstand via SSH (Mac-app-pariteit) De macOS-appmodus “Remote over SSH” gebruikt een lokale port-forward zodat de externe gateway (die mogelijk alleen aan loopback is gebonden) bereikbaar wordt op `ws://127.0.0.1:`. CLI-equivalent: ```bash theme={"theme":{"light":"min-light","dark":"min-dark"}} openclaw gateway probe --ssh user@gateway-host ``` Opties: * `--ssh `: `user@host` of `user@host:port` (poort standaard `22`). * `--ssh-identity `: identity-bestand. * `--ssh-auto`: kies de eerst ontdekte Gateway-host als SSH-doel (alleen LAN/WAB). Config (optioneel, gebruikt als standaardwaarden): * `gateway.remote.sshTarget` * `gateway.remote.sshIdentity` ### `gateway call ` Low-level RPC-helper. ```bash theme={"theme":{"light":"min-light","dark":"min-dark"}} openclaw gateway call status openclaw gateway call logs.tail --params '{"sinceMs": 60000}' ``` ## De Gateway-service beheren ```bash theme={"theme":{"light":"min-light","dark":"min-dark"}} openclaw gateway install openclaw gateway start openclaw gateway stop openclaw gateway restart openclaw gateway uninstall ``` Notities: * `gateway install` ondersteunt `--port`, `--runtime`, `--token`, `--force`, `--json`. * Lifecycle-opdrachten accepteren `--json` voor scripting. ## Gateways ontdekken (Bonjour) `gateway discover` scant naar Gateway-beacons (`_openclaw-gw._tcp`). * Multicast DNS-SD: `local.` * Unicast DNS-SD (Wide-Area Bonjour): kies een domein (voorbeeld: `openclaw.internal.`) en stel split DNS + een DNS-server in; zie [/gateway/bonjour](/gateway/bonjour) Alleen gateways met Bonjour-discovery ingeschakeld (standaard) adverteren de beacon. Wide-Area discovery-records bevatten (TXT): * `role` (gateway-rolhint) * `transport` (transporthint, bijv. `gateway`) * `gatewayPort` (WebSocket-poort, meestal `18789`) * `sshPort` (SSH-poort; standaard `22` indien niet aanwezig) * `tailnetDns` (MagicDNS-hostnaam, indien beschikbaar) * `gatewayTls` / `gatewayTlsSha256` (TLS ingeschakeld + certificaatvingerafdruk) * `cliPath` (optionele hint voor externe installaties) ### `gateway discover` ```bash theme={"theme":{"light":"min-light","dark":"min-dark"}} openclaw gateway discover ``` Opties: * `--timeout `: timeout per opdracht (browse/resolve); standaard `2000`. * `--json`: machineleesbare uitvoer (schakelt ook styling/spinner uit). Voorbeelden: ```bash theme={"theme":{"light":"min-light","dark":"min-dark"}} openclaw gateway discover --timeout 4000 openclaw gateway discover --json | jq '.beacons[].wsUrl' ```