CLI commands
Referência da CLI
openclaw é o principal ponto de entrada da CLI. Cada comando principal tem uma
página de referência dedicada ou é documentado com o comando para o qual é alias; este
índice lista os comandos, as flags globais e as regras de estilo de saída que
se aplicam em toda a CLI.
Use os comandos de configuração por intenção:
openclaw setupeopenclaw onboardexecutam o caminho guiado completo da primeira execução para Gateway, autenticação de modelo, workspace, canais, Skills e integridade.openclaw setup --baselinecria a configuração de baseline e o workspace sem percorrer o fluxo guiado de onboarding.openclaw configurealtera partes específicas de uma configuração existente, como autenticação de modelo, Gateway, canais, Plugins ou Skills.openclaw channels addconfigura contas de canal depois que o baseline existe; execute sem flags para configuração guiada de canal ou com flags específicas do canal para scripts.
Páginas de comandos
| Área | Comandos |
|---|---|
| Configuração e onboarding | crestodian · setup · onboard · configure · config · completion · doctor · dashboard |
| Redefinição e desinstalação | backup · reset · uninstall · update |
| Mensagens e agentes | message · agent · agents · attach · acp · mcp |
| Integridade e sessões | status · health · sessions |
| Gateway e logs | gateway · logs · system |
| Modelos e inferência | models · infer · capability (alias para infer) · memory · commitments · wiki |
| Rede e nós | directory · nodes · devices · node |
| Runtime e sandbox | approvals · exec-policy (consulte approvals) · sandbox · tui · chat/terminal (aliases para tui --local) · browser |
| Automação | cron · tasks · hooks · webhooks · transcripts |
| Descoberta e docs | dns · docs |
| Pareamento e canais | pairing · qr · channels |
| Segurança e Plugins | security · secrets · skills · plugins · proxy |
| Aliases legados | daemon (serviço de Gateway) · clawbot (namespace) |
| Plugins (opcionais) | path · policy · voicecall · workboard (se instalado) |
Flags globais
| Flag | Finalidade |
|---|---|
--dev |
Isola o estado em ~/.openclaw-dev e desloca as portas padrão |
--profile <name> |
Isola o estado em ~/.openclaw-<name> |
--container <name> |
Direciona um contêiner nomeado para execução |
--no-color |
Desabilita cores ANSI (NO_COLOR=1 também é respeitado) |
--update |
Atalho para openclaw update (somente instalações a partir do código-fonte) |
-V, --version, -v |
Imprime a versão e sai |
Modos de saída
- Cores ANSI e indicadores de progresso são renderizados somente em sessões TTY.
- Hiperlinks OSC-8 são renderizados como links clicáveis onde houver suporte; caso contrário, a CLI volta para URLs simples.
--json(e--plainonde houver suporte) desabilita o estilo para uma saída limpa.- Comandos de longa duração mostram um indicador de progresso (OSC 9;4 quando houver suporte).
Fonte da verdade da paleta: src/terminal/palette.ts.
Árvore de comandos
Árvore completa de comandos
openclaw [--dev] [--profile <name>] <command>crestodiansetuponboardconfigureconfig get set unset file schema validatecompletiondoctordashboardbackup create verifysecurity auditsecrets reload audit configure applyresetuninstallupdate wizard statuschannels list status capabilities resolve logs add remove login logoutdirectory self peers list groups list|membersskills search install update list info checkplugins list inspect install uninstall update enable disable doctor marketplace listworkboard list create show dispatchmemory status index searchtranscripts list show pathpath resolve find set validate emitcommitments list dismisswiki status doctor init ingest compile lint search get apply bridge import unsafe-local import obsidian status|search|open|command|dailymessage send broadcast poll react reactions read edit delete pin unpin pins permissions search thread create|list|reply emoji list|upload sticker send|upload role info|add|remove channel info|list member info voice status event list|create timeout kick banagentagents list add delete bindings bind unbind set-identityattachacpmcp serve list show set unsetstatushealthsessions cleanuptasks list audit maintenance show notify cancel flow list|show|cancelgateway call usage-cost health status probe discover install uninstall start stop restart rundaemon status install uninstall start stop restartlogssystem event heartbeat last|enable|disable presencemodels list status set set-image aliases list|add|remove fallbacks list|add|remove|clear image-fallbacks list|add|remove|clear scaninfer (alias: capability) list inspect model run|list|inspect|providers|auth login|logout|status image generate|edit|describe|describe-many|providers audio transcribe|providers tts convert|voices|providers|status|enable|disable|set-provider video generate|describe|providers web search|fetch|providers embedding create|providers auth add|login|login-github-copilot|setup-token|paste-token auth order get|set|clearsandbox list recreate explaincron status list get add edit rm enable disable runs runnodes status describe list pending approve reject rename invoke notify push canvas snapshot|present|hide|navigate|eval canvas a2ui push|reset camera list|snap|clip screen record location getdevices list remove clear approve reject rotate revokenode run status install uninstall stop restartapprovals get set allowlist add|removeexec-policy show preset setbrowser status start stop reset-profile tabs open focus close profiles create-profile delete-profile screenshot snapshot navigate resize click type press hover drag select upload fill dialog wait evaluate console pdfhooks list info check enable disable install updatewebhooks gmail setup|runproxy start run coverage sessions query blob purgepairing list approveqrclawbot qrdocsdns setuptuichat (alias: tui --local)terminal (alias: tui --local)Plugins podem adicionar outros comandos de nível superior, como
openclaw workboard ou openclaw voicecall.
Comandos slash de chat
Mensagens de chat oferecem suporte a comandos /.... Consulte comandos slash.
Destaques:
/status— diagnósticos rápidos./trace— linhas de trace/debug de Plugin no escopo da sessão./config— alterações persistidas de configuração./debug— substituições de configuração somente de runtime (memória, não disco; requercommands.debug: true).
Rastreamento de uso
openclaw status --usage e a Control UI expõem uso/cota do provedor quando
credenciais OAuth/API estão disponíveis. Os dados vêm diretamente dos endpoints
de uso do provedor e são normalizados para X% left. Provedores com janelas
de uso atuais: Anthropic, GitHub Copilot, Gemini CLI, OpenAI Codex, MiniMax,
Xiaomi e z.ai.
Consulte Rastreamento de uso para obter detalhes.