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 do qual é um alias; este índice lista os comandos, as opções globais e as regras de estilo de saída aplicáveis em toda a CLI.

Comandos de configuração por finalidade:

openclaw setup e openclaw onboard verificam primeiro a inferência e depois iniciam o OpenClaw para configurar Gateway, espaço de trabalho, canais, Skills e integridade.
openclaw setup --baseline cria a configuração e o espaço de trabalho básicos sem percorrer o fluxo de integração guiada.
openclaw configure altera partes específicas de uma configuração existente: autenticação do modelo, Gateway, canais, plugins ou Skills.
openclaw channels add configura contas de canais após a criação da base; execute sem opções para a configuração guiada ou com opções específicas do canal em scripts.

Páginas de comandos

Área	Comandos
Configuração e integração	`openclaw` · `setup` · `onboard` · `configure` · `config` · `completion` · `doctor` · `dashboard`
Redefinição, backup e migração	`backup` · `migrate` · `reset` · `uninstall` · `update`
Mensagens e agentes	`message` · `agent` · `agents` · `attach` · `acp` · `mcp`
Integridade e sessões	`status` · `health` · `sessions` · `audit`
Gateway e logs	`gateway` · `logs` · `system`
Modelos e inferência	`models` · `promos` · `infer` · `capability` (alias de `infer`) · `memory` · `commitments` · `wiki`
Rede e Nodes	`directory` · `nodes` · `devices` · `node` · `worker`
Runtime e sandbox	`approvals` · `exec-policy` (consulte `approvals`) · `sandbox` · `tui` · `chat`/`terminal` (aliases de `tui --local`) · `browser`
Automação	`cron` · `tasks` · `hooks` · `webhooks` · `transcripts`
Descoberta e documentação	`dns` · `docs`
Pareamento e canais	`pairing` · `qr` · `channels`
Segurança e plugins	`security` · `secrets` · `skills` · `plugins` · `proxy`
Aliases legados	`daemon` (serviço do Gateway) · `clawbot` (namespace)
Plugins (opcionais)	`path` · `policy` · `voicecall` · `workboard` (se instalado)

Opções globais

Opção	Finalidade
`--dev`	Isola o estado em `~/.openclaw-dev`, define 19001 como a porta padrão do Gateway e desloca as portas derivadas
`--profile <name>`	Isola o estado em `~/.openclaw-<name>` (`OPENCLAW_STATE_DIR`/`OPENCLAW_CONFIG_PATH`)
`--container <name>`	Executa a CLI dentro de um contêiner Podman/Docker em execução chamado `<name>` (padrão: variável de ambiente `OPENCLAW_CONTAINER`)
`--log-level <level>`	Substitui o nível de log global da saída em arquivo e no console
`--no-color`	Desativa as cores ANSI (`NO_COLOR=1` também é respeitada)
`--update`	Forma abreviada de `openclaw update`; funciona tanto para checkouts do código-fonte quanto para instalações de pacotes
`-V`, `--version`, `-v`	Exibe a versão e encerra

Modos de saída

As cores ANSI e os indicadores de progresso são renderizados somente em sessões TTY.
Os hiperlinks OSC-8 são renderizados como links clicáveis quando compatíveis; caso contrário, a CLI usa URLs em texto simples.
--json (e --plain quando compatível) desativa a estilização para gerar uma saída limpa.
Comandos de longa duração exibem um indicador de progresso (OSC 9;4 quando compatível).

Paleta de cores

O OpenClaw usa uma paleta inspirada em lagosta na saída da CLI:

Token	Hex	Usado para
`accent`	`#FF5A2D`	Títulos, rótulos e destaques principais
`accentBright`	`#FF7A3D`	Nomes de comandos e ênfase
`accentDim`	`#D14A22`	Texto de destaque secundário
`info`	`#FF8A5B`	Valores informativos
`success`	`#2FBF71`	Estados de sucesso
`warn`	`#FFB020`	Avisos, opções e alternativas
`error`	`#E23D2D`	Erros e falhas
`muted`	`#8B7F77`	Menor ênfase e metadados

Fonte oficial da paleta: packages/terminal-core/src/palette.ts.

Árvore de comandos

Árvore de comandos completa

Este mapa abrange os comandos principais e seus subcomandos primários. Os subcomandos adicionados por plugins (por exemplo, em skills, plugins e wiki) evoluem de forma independente; execute <command> --help para obter a lista atual e oficial.

Code

openclaw [--dev] [--profile <name>] <command>openclawsetuponboardconfigureconfig  get  set  unset  file  schema  validatecompletiondoctordashboardbackup  create  verifymigrate  list  plan <provider>  apply <provider>security  auditsecrets  reload  audit  configure  applyresetuninstallupdate  wizard  status  repairchannels  list  status  capabilities  resolve  logs  add  remove  login  logoutdirectory  self  peers list  groups list|membersskills  search  install  update  verify  workshop list|inspect|propose-create|propose-update|revise|apply|reject|quarantine  list  info  checkplugins  list  search  inspect  install  uninstall  update  enable  disable  doctor  build  validate  init  registry  marketplace list|entries|refreshworkboard  list  create  show  dispatchmemory  status  index  searchtranscripts  list  show  pathpath  resolve  find  set  validate  emitcommitments  list  dismisswiki  status  doctor  init  compile  lint  ingest  okf import  search  get  apply synthesis|metadata  bridge import  unsafe-local import  chatgpt import|rollback  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  cleanupaudittasks  list  audit  maintenance  show  notify  cancel  flow list|show|cancelgateway  call  usage-cost  health  stability  diagnostics export  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  scan  auth list|add|login|setup-token|paste-token|paste-api-key|login-github-copilot  auth order get|set|clearpromos  list  claim <slug>infer (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|personas|providers|status|enable|disable|set-provider|set-persona  video generate|describe|providers  web search|fetch|providers  embedding create|providerssandbox  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  restartworkerapprovals  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 de barra no chat

As mensagens de chat são compatíveis com comandos /.... Consulte comandos de barra.

Destaques:

/status - diagnósticos rápidos.
/trace - linhas de rastreamento/depuração do Plugin com escopo de sessão.
/config - alterações persistentes de configuração.
/debug - substituições de configuração somente em tempo de execução (memória, não disco; requer commands.debug: true).

Monitoramento de uso

openclaw status --usage e a interface de controle exibem o uso/a cota do provedor quando as credenciais OAuth/API estão disponíveis. Os dados vêm diretamente dos endpoints de uso dos provedores e são normalizados para X% left. Provedores com janelas de uso atuais: Anthropic, Gemini CLI, GitHub Copilot, MiniMax, OpenAI Codex, Xiaomi e z.ai.

Consulte Monitoramento de uso para obter detalhes.

Relacionados

Was this useful?

Nesta página