English简体中文繁體中文日本語EspañolPortuguês (BR)한국어DeutschFrançaisالعربيةItalianoTiếng ViệtNederlandsTürkçeУкраїнськаBahasa IndonesiaPolskiفارسیไทย
View as MarkdownView this page as plain textOpen in ChatGPTAsk questions about this pageOpen in ClaudeAsk questions about this pageOpen in PerplexityAsk questions about this page

CLI commands

CLI reference

openclaw is the main CLI entry point. Each core command has either a dedicated reference page or is documented with the command it aliases; this index lists the commands, the global flags, and the output styling rules that apply across the CLI.

Use the setup commands by intent:

  • openclaw setup creates the baseline config and workspace without walking the full guided onboarding flow.
  • openclaw onboard is the full guided first-run path for gateway, model auth, workspace, channels, skills, and health.
  • openclaw configure changes targeted parts of an existing setup, such as model auth, gateway, channels, plugins, or skills.
  • openclaw channels add configures channel accounts after the baseline exists; run it without flags for guided channel setup or with channel-specific flags for scripts.

Command pages

Area Commands
Setup and onboarding crestodian · setup · onboard · configure · config · completion · doctor · dashboard
Reset and uninstall backup · reset · uninstall · update
Messaging and agents message · agent · agents · acp · mcp
Health and sessions status · health · sessions
Gateway and logs gateway · logs · system
Models and inference models · infer · capability (alias for infer) · memory · commitments · wiki
Network and nodes directory · nodes · devices · node
Runtime and sandbox approvals · exec-policy (see approvals) · sandbox · tui · chat/terminal (aliases for tui --local) · browser
Automation cron · tasks · hooks · webhooks · transcripts
Discovery and docs dns · docs
Pairing and channels pairing · qr · channels
Security and plugins security · secrets · skills · plugins · proxy
Legacy aliases daemon (gateway service) · clawbot (namespace)
Plugins (optional) path · policy · voicecall · workboard (if installed)

Global flags

Flag Purpose
--dev Isolate state under ~/.openclaw-dev and shift default ports
--profile <name> Isolate state under ~/.openclaw-<name>
--container <name> Target a named container for execution
--no-color Disable ANSI colors (NO_COLOR=1 is also respected)
--update Shorthand for openclaw update (source installs only)
-V, --version, -v Print version and exit

Output modes

  • ANSI colors and progress indicators render only in TTY sessions.
  • OSC-8 hyperlinks render as clickable links where supported; otherwise the CLI falls back to plain URLs.
  • --json (and --plain where supported) disables styling for clean output.
  • Long-running commands show a progress indicator (OSC 9;4 when supported).

Palette source of truth: src/terminal/palette.ts.

Command tree

Full command tree
Code
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-identityacpmcp  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 can add additional top-level commands, such as openclaw workboard or openclaw voicecall.

Chat slash commands

Chat messages support /... commands. See slash commands.

Highlights:

  • /status — quick diagnostics.
  • /trace — session-scoped plugin trace/debug lines.
  • /config — persisted config changes.
  • /debug — runtime-only config overrides (memory, not disk; requires commands.debug: true).

Usage tracking

openclaw status --usage and the Control UI surface provider usage/quota when OAuth/API credentials are available. Data comes directly from provider usage endpoints and is normalized to X% left. Providers with current usage windows: Anthropic, GitHub Copilot, Gemini CLI, OpenAI Codex, MiniMax, Xiaomi, and z.ai.

See Usage tracking for details.

Was this useful?
On this page

On this page