Início rápido
Modo Gateway
- Inicie o Gateway.
- Abra a TUI.
- Digite uma mensagem e pressione Enter.
Gateway remoto:
openclaw tui --url ws://<host>:<port> --token <gateway-token>
Use --password se o seu Gateway usa autenticação por senha.
Modo local
Execute a TUI sem um Gateway:
openclaw chat
# or
openclaw tui --local
Observações:
openclaw chat e openclaw terminal são aliases para openclaw tui --local.
--local não pode ser combinado com --url, --token ou --password.
- O modo local usa diretamente o runtime de agente incorporado. A maioria das ferramentas locais funciona, mas recursos exclusivos do Gateway não estão disponíveis.
- Depois que um arquivo de configuração tiver configurações gravadas,
openclaw e openclaw crestodian também usam este shell TUI, com Crestodian como backend local de chat para configuração e reparo.
O que você vê
- Cabeçalho: URL de conexão, agente atual, sessão atual.
- Log de chat: mensagens do usuário, respostas do assistente, avisos do sistema, cartões de ferramenta.
- Linha de status: estado da conexão/execução (conectando, executando, transmitindo, ocioso, erro).
- Rodapé: agente + sessão + modelo + estado da meta + think/fast/verbose/trace/reasoning + contagens de tokens + entrega. Quando
tui.footer.showRemoteHost está habilitado, conexões remotas do Gateway também mostram o host da conexão.
- Entrada: editor de texto com preenchimento automático.
Modelo mental: agentes + sessões
-
Agentes são slugs únicos (por exemplo,
main, research). O Gateway expõe a lista.
-
Sessões pertencem ao agente atual.
-
Chaves de sessão são armazenadas como
agent:<agentId>:<sessionKey>.
- Se você digitar
/session main, a TUI expande para agent:<currentAgent>:main.
- Se você digitar
/session agent:other:main, você muda explicitamente para essa sessão de agente.
-
Escopo da sessão:
per-sender (padrão): cada agente tem muitas sessões.
global: a TUI sempre usa a sessão global (o seletor pode estar vazio).
-
O agente + a sessão atuais ficam sempre visíveis no rodapé.
-
Para mostrar o host do Gateway em conexões não locais baseadas em URL, habilite com:
openclaw config set tui.footer.showRemoteHost true
Conexões de loopback e conexões locais incorporadas nunca mostram um rótulo de host.
-
Se a sessão tiver uma meta, o rodapé mostra seu estado compacto,
como
Pursuing goal, Goal paused (/goal resume) ou
Goal achieved.
-
Quando iniciada sem
--session, a TUI em modo Gateway retoma a última sessão selecionada para o mesmo gateway, agente e escopo de sessão, se essa sessão ainda existir. Passar --session, /session, /new ou /reset continua sendo explícito.
Envio + entrega
- Mensagens são enviadas ao Gateway; a entrega para provedores fica desativada por padrão.
- A TUI é uma superfície de origem interna como o WebChat, não um canal genérico de saída. Harnesses que exigem
tools.message para respostas visíveis podem satisfazer a vez ativa da TUI com um message.send sem destino; a entrega explícita ao provedor ainda usa canais configurados normais e nunca recorre a lastChannel.
- Ative a entrega:
/deliver on
- ou o painel Configurações
- ou inicie com
openclaw tui --deliver
Seletores + sobreposições
- Seletor de modelo: liste os modelos disponíveis e defina a substituição da sessão.
- Seletor de agente: escolha outro agente.
- Seletor de sessão: mostra até 50 sessões do agente atual atualizadas nos últimos 7 dias. Use
/session <key> para ir para uma sessão conhecida mais antiga.
- Configurações: alterne entrega, expansão de saída de ferramentas e visibilidade do raciocínio.
Atalhos de teclado
- Enter: enviar mensagem
- Esc: abortar execução ativa
- Ctrl+C: limpar entrada (pressione duas vezes para sair)
- Ctrl+D: sair
- Ctrl+L: seletor de modelo
- Ctrl+G: seletor de agente
- Ctrl+P: seletor de sessão
- Ctrl+O: alternar expansão de saída de ferramentas
- Ctrl+T: alternar visibilidade do raciocínio (recarrega o histórico)
Comandos de barra
Núcleo:
/help
/status
/agent <id> (ou /agents)
/session <key> (ou /sessions)
/model <provider/model> (ou /models)
Controles de sessão:
/think <off|minimal|low|medium|high>
/fast <status|on|off>
/verbose <on|full|off>
/trace <on|off>
/reasoning <on|off|stream>
/usage <off|tokens|full|reset> (reset/inherit/clear/default limpa a substituição da sessão)
/goal [status] | /goal start <objective> | /goal pause|resume|complete|block|clear
/elevated <on|off|ask|full> (alias: /elev)
/activation <mention|always>
/deliver <on|off>
Ciclo de vida da sessão:
/new ou /reset (redefinir a sessão)
/abort (abortar a execução ativa)
/settings
/exit
Somente modo local:
/auth [provider] abre o fluxo de autenticação/login do provedor dentro da TUI.
Outros comandos de barra do Gateway (por exemplo, /context) são encaminhados ao Gateway e exibidos como saída do sistema. Consulte Comandos de barra.
Comandos de shell locais
- Prefixe uma linha com
! para executar um comando de shell local no host da TUI.
- A TUI solicita uma vez por sessão para permitir a execução local; recusar mantém
! desabilitado para a sessão.
- Comandos são executados em um shell novo e não interativo no diretório de trabalho da TUI (sem
cd/env persistente).
- Comandos de shell locais recebem
OPENCLAW_SHELL=tui-local no ambiente.
- Um
! isolado é enviado como mensagem normal; espaços iniciais não acionam execução local.
Reparar configurações a partir da TUI local
Use o modo local quando a configuração atual já valida e você quer que o
agente incorporado a inspecione na mesma máquina, compare com a documentação
e ajude a reparar divergências sem depender de um Gateway em execução.
Se openclaw config validate já estiver falhando, comece com openclaw configure
ou openclaw doctor --fix primeiro. openclaw chat não ignora a proteção de
configuração inválida.
Fluxo típico:
- Inicie o modo local:
- Peça ao agente o que você quer verificar, por exemplo:
Compare my gateway auth config with the docs and suggest the smallest fix.
- Use comandos de shell locais para evidência e validação exatas:
!openclaw config file
!openclaw docs gateway auth token secretref
!openclaw config validate
!openclaw doctor
- Aplique alterações estreitas com
openclaw config set ou openclaw configure; depois, execute novamente !openclaw config validate.
- Se o Doctor recomendar uma migração ou reparo automático, revise e execute
!openclaw doctor --fix.
Dicas:
- Prefira
openclaw config set ou openclaw configure em vez de editar openclaw.json manualmente.
openclaw docs "<query>" pesquisa o índice de documentação ao vivo na mesma máquina.
openclaw config validate --json é útil quando você quer erros estruturados de esquema e de SecretRef/resolubilidade.
Saída de ferramentas
- Chamadas de ferramenta aparecem como cartões com argumentos + resultados.
- Ctrl+O alterna entre visualizações recolhida/expandida.
- Enquanto ferramentas são executadas, atualizações parciais são transmitidas no mesmo cartão.
Cores do terminal
- A TUI mantém o texto do corpo do assistente no primeiro plano padrão do seu terminal para que terminais escuros e claros permaneçam legíveis.
- Se o seu terminal usa fundo claro e a detecção automática está errada, defina
OPENCLAW_THEME=light antes de iniciar openclaw tui.
- Para forçar a paleta escura original, defina
OPENCLAW_THEME=dark.
Histórico + streaming
- Ao conectar, a TUI carrega o histórico mais recente (padrão de 200 mensagens).
- Respostas em streaming são atualizadas no lugar até serem finalizadas.
- A TUI também escuta eventos de ferramenta do agente para cartões de ferramenta mais ricos.
Detalhes de conexão
- A TUI se registra no Gateway como
mode: "tui".
- Reconexões mostram uma mensagem do sistema; lacunas de eventos são exibidas no log.
Opções
--local: Executar contra o runtime de agente local incorporado
--url <url>: URL WebSocket do Gateway (usa como padrão a configuração ou ws://127.0.0.1:<port>)
--token <token>: token do Gateway (se exigido)
--password <password>: senha do Gateway (se exigida)
--session <key>: chave da sessão (padrão: main, ou global quando o escopo é global)
--deliver: Entregar respostas do assistente ao provedor (desativado por padrão)
--thinking <level>: Substituir o nível de raciocínio para envios
--message <text>: Enviar uma mensagem inicial após conectar
--timeout-ms <ms>: Tempo limite do agente em ms (usa como padrão agents.defaults.timeoutSeconds)
--history-limit <n>: Entradas de histórico a carregar (padrão 200)
Quando você define --url, a TUI não recorre à configuração nem a credenciais de ambiente. Passe --token ou --password explicitamente. Credenciais explícitas ausentes são um erro. No modo local, não passe --url, --token ou --password.
Solução de problemas
Sem saída após enviar uma mensagem:
- Execute
/status na TUI para confirmar que o Gateway está conectado e ocioso/ocupado.
- Verifique os logs do Gateway:
openclaw logs --follow.
- Confirme que o agente consegue executar:
openclaw status e openclaw models status.
- Se você espera mensagens em um canal de chat, habilite a entrega (
/deliver on ou --deliver).
Solução de problemas de conexão
disconnected: confirme que o Gateway está em execução e que seus --url/--token/--password estão corretos.
- Sem agentes no seletor: verifique
openclaw agents list e sua configuração de roteamento.
- Seletor de sessão vazio: você pode estar no escopo global ou ainda não ter sessões.
Relacionados
- Control UI — interface de controle baseada na web
- Config — inspecionar, validar e editar
openclaw.json
- Doctor — verificações guiadas de reparo e migração
- Referência da CLI — referência completa de comandos da CLI