> ## 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 O Gateway é o servidor WebSocket do OpenClaw (canais, nós, sessões, hooks). Os subcomandos nesta página ficam sob `openclaw gateway …`. Documentos relacionados: * [/gateway/bonjour](/gateway/bonjour) * [/gateway/discovery](/gateway/discovery) * [/gateway/configuration](/gateway/configuration) ## Executar o Gateway Execute um processo local do Gateway: ```bash theme={"theme":{"light":"min-light","dark":"min-dark"}} openclaw gateway ``` Alias em primeiro plano: ```bash theme={"theme":{"light":"min-light","dark":"min-dark"}} openclaw gateway run ``` Notas: * Por padrão, o Gateway se recusa a iniciar a menos que `gateway.mode=local` esteja definido em `~/.openclaw/openclaw.json`. Use `--allow-unconfigured` para execuções ad-hoc/dev. * Fazer bind além do loopback sem autenticação é bloqueado (proteção de segurança). * `SIGUSR1` dispara uma reinicialização em processo quando autorizado (habilite `commands.restart` ou use a ferramenta/configuração do gateway apply/update). * Os handlers `SIGINT`/`SIGTERM` interrompem o processo do gateway, mas não restauram nenhum estado personalizado do terminal. Se você envolver a CLI com uma TUI ou entrada em modo raw, restaure o terminal antes de sair. ### Opções * `--port `: porta WebSocket (o padrão vem da configuração/variáveis de ambiente; geralmente `18789`). * `--bind `: modo de bind do listener. * `--auth `: substituição do modo de autenticação. * `--token `: substituição do token (também define `OPENCLAW_GATEWAY_TOKEN` para o processo). * `--password `: substituição da senha (também define `OPENCLAW_GATEWAY_PASSWORD` para o processo). * `--tailscale `: expor o Gateway via Tailscale. * `--tailscale-reset-on-exit`: redefinir a configuração de serve/funnel do Tailscale ao encerrar. * `--allow-unconfigured`: permitir iniciar o gateway sem `gateway.mode=local` na configuração. * `--dev`: criar uma configuração de dev + workspace se ausentes (ignora BOOTSTRAP.md). * `--reset`: redefinir configuração de dev + credenciais + sessões + workspace (requer `--dev`). * `--force`: encerrar qualquer listener existente na porta selecionada antes de iniciar. * `--verbose`: logs verbosos. * `--claude-cli-logs`: mostrar apenas logs do claude-cli no console (e habilitar stdout/stderr dele). * `--ws-log `: estilo de log do websocket (padrão `auto`). * `--compact`: alias para `--ws-log compact`. * `--raw-stream`: registrar eventos brutos do stream do modelo em jsonl. * `--raw-stream-path `: caminho do jsonl do stream bruto. ## Consultar um Gateway em execução Todos os comandos de consulta usam RPC via WebSocket. Modos de saída: * Padrão: legível para humanos (colorido em TTY). * `--json`: JSON legível por máquina (sem estilo/spinner). * `--no-color` (ou `NO_COLOR=1`): desabilitar ANSI mantendo o layout humano. Opções compartilhadas (quando suportadas): * `--url `: URL do WebSocket do Gateway. * `--token `: token do Gateway. * `--password `: senha do Gateway. * `--timeout `: timeout/orçamento (varia por comando). * `--expect-final`: aguardar uma resposta “final” (chamadas de agente). Nota: quando você define `--url`, a CLI não faz fallback para credenciais de configuração ou de ambiente. Passe `--token` ou `--password` explicitamente. A ausência de credenciais explícitas é um erro. ### `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` mostra o serviço do Gateway (launchd/systemd/schtasks) além de uma sonda RPC opcional. ```bash theme={"theme":{"light":"min-light","dark":"min-dark"}} openclaw gateway status openclaw gateway status --json ``` Opções: * `--url `: substituir a URL da sonda. * `--token `: autenticação por token para a sonda. * `--password `: autenticação por senha para a sonda. * `--timeout `: timeout da sonda (padrão `10000`). * `--no-probe`: pular a sonda RPC (visualização apenas do serviço). * `--deep`: escanear serviços em nível de sistema também. ### `gateway probe` `gateway probe` é o comando “depurar tudo”. Ele sempre faz sondagem de: * seu gateway remoto configurado (se definido), e * localhost (loopback) **mesmo se um remoto estiver configurado**. Se vários gateways estiverem acessíveis, ele imprime todos. Vários gateways são suportados quando você usa perfis/portas isolados (por exemplo, um bot de resgate), mas a maioria das instalações ainda executa um único gateway. ```bash theme={"theme":{"light":"min-light","dark":"min-dark"}} openclaw gateway probe openclaw gateway probe --json ``` #### Remoto via SSH (paridade com app Mac) O modo “Remote over SSH” do app macOS usa um encaminhamento de porta local para que o gateway remoto (que pode estar vinculado apenas ao loopback) fique acessível em `ws://127.0.0.1:`. Equivalente na CLI: ```bash theme={"theme":{"light":"min-light","dark":"min-dark"}} openclaw gateway probe --ssh user@gateway-host ``` Opções: * `--ssh `: `user@host` ou `user@host:port` (a porta padrão é `22`). * `--ssh-identity `: arquivo de identidade. * `--ssh-auto`: escolher o primeiro host do gateway descoberto como alvo SSH (apenas LAN/WAB). Configuração (opcional, usada como padrão): * `gateway.remote.sshTarget` * `gateway.remote.sshIdentity` ### `gateway call ` Auxiliar de RPC de baixo nível. ```bash theme={"theme":{"light":"min-light","dark":"min-dark"}} openclaw gateway call status openclaw gateway call logs.tail --params '{"sinceMs": 60000}' ``` ## Gerenciar o serviço do Gateway ```bash theme={"theme":{"light":"min-light","dark":"min-dark"}} openclaw gateway install openclaw gateway start openclaw gateway stop openclaw gateway restart openclaw gateway uninstall ``` Notas: * `gateway install` oferece suporte a `--port`, `--runtime`, `--token`, `--force`, `--json`. * Comandos de ciclo de vida aceitam `--json` para scripts. ## Descobrir gateways (Bonjour) `gateway discover` varre por beacons do Gateway (`_openclaw-gw._tcp`). * Multicast DNS-SD: `local.` * Unicast DNS-SD (Wide-Area Bonjour): escolha um domínio (exemplo: `openclaw.internal.`) e configure split DNS + um servidor DNS; veja [/gateway/bonjour](/gateway/bonjour) Apenas gateways com descoberta Bonjour habilitada (padrão) anunciam o beacon. Registros de descoberta Wide-Area incluem (TXT): * `role` (dica de função do gateway) * `transport` (dica de transporte, por exemplo `gateway`) * `gatewayPort` (porta WebSocket, geralmente `18789`) * `sshPort` (porta SSH; padrão `22` se ausente) * `tailnetDns` (hostname MagicDNS, quando disponível) * `gatewayTls` / `gatewayTlsSha256` (TLS habilitado + fingerprint do certificado) * `cliPath` (dica opcional para instalações remotas) ### `gateway discover` ```bash theme={"theme":{"light":"min-light","dark":"min-dark"}} openclaw gateway discover ``` Opções: * `--timeout `: timeout por comando (browse/resolve); padrão `2000`. * `--json`: saída legível por máquina (também desabilita estilo/spinner). Exemplos: ```bash theme={"theme":{"light":"min-light","dark":"min-dark"}} openclaw gateway discover --timeout 4000 openclaw gateway discover --json | jq '.beacons[].wsUrl' ```