CLI commands

Referensi CLI

openclaw adalah titik masuk utama CLI. Setiap perintah inti memiliki halaman referensi khusus atau didokumentasikan bersama perintah yang menjadi aliasnya; indeks ini mencantumkan perintah, flag global, dan aturan penataan gaya keluaran yang berlaku di seluruh CLI.

Perintah penyiapan berdasarkan tujuan:

  • openclaw setup dan openclaw onboard memverifikasi inferensi terlebih dahulu, lalu memulai Crestodian untuk penyiapan Gateway, ruang kerja, saluran, Skills, dan kesehatan.
  • openclaw setup --baseline membuat konfigurasi dasar dan ruang kerja tanpa menjalani alur orientasi terpandu.
  • openclaw configure mengubah bagian tertentu dari penyiapan yang sudah ada: autentikasi model, Gateway, saluran, Plugin, atau Skills.
  • openclaw channels add mengonfigurasi akun saluran setelah konfigurasi dasar tersedia; jalankan tanpa flag untuk penyiapan terpandu, atau dengan flag khusus saluran untuk skrip.

Halaman perintah

Area Perintah
Penyiapan dan orientasi crestodian · setup · onboard · configure · config · completion · doctor · dashboard
Pengaturan ulang, pencadangan, dan migrasi backup · migrate · reset · uninstall · update
Perpesanan dan agen message · agent · agents · attach · acp · mcp
Kesehatan dan sesi status · health · sessions · audit
Gateway dan log gateway · logs · system
Model dan inferensi models · promos · infer · capability (alias untuk infer) · memory · commitments · wiki
Jaringan dan Node directory · nodes · devices · node
Runtime dan sandbox approvals · exec-policy (lihat approvals) · sandbox · tui · chat/terminal (alias untuk tui --local) · browser
Otomatisasi cron · tasks · hooks · webhooks · transcripts
Penemuan dan dokumentasi dns · docs
Penyandingan dan saluran pairing · qr · channels
Keamanan dan Plugin security · secrets · skills · plugins · proxy
Alias lama daemon (layanan Gateway) · clawbot (ruang nama)
Plugin (opsional) path · policy · voicecall · workboard (jika terpasang)

Flag global

Flag Tujuan
--dev Mengisolasi status di bawah ~/.openclaw-dev, menetapkan port Gateway bawaan ke 19001, dan menggeser port turunannya
--profile <name> Mengisolasi status di bawah ~/.openclaw-<name> (OPENCLAW_STATE_DIR/OPENCLAW_CONFIG_PATH)
--container <name> Menjalankan CLI di dalam kontainer Podman/Docker yang sedang berjalan dengan nama <name> (bawaan: env OPENCLAW_CONTAINER)
--log-level <level> Mengganti tingkat log global untuk keluaran berkas + konsol
--no-color Menonaktifkan warna ANSI (NO_COLOR=1 juga dipatuhi)
--update Bentuk singkat untuk openclaw update; berfungsi untuk checkout sumber maupun instalasi paket
-V, --version, -v Menampilkan versi dan keluar

Mode keluaran

  • Warna ANSI dan indikator kemajuan hanya dirender dalam sesi TTY.
  • Hyperlink OSC-8 dirender sebagai tautan yang dapat diklik jika didukung; jika tidak, CLI kembali menggunakan URL teks biasa.
  • --json (dan --plain jika didukung) menonaktifkan penataan gaya untuk keluaran yang bersih.
  • Perintah yang berjalan lama menampilkan indikator kemajuan (OSC 9;4 jika didukung).

Palet warna

OpenClaw menggunakan palet lobster untuk keluaran CLI:

Token Heksadesimal Digunakan untuk
accent #FF5A2D Judul, label, sorotan utama
accentBright #FF7A3D Nama perintah, penekanan
accentDim #D14A22 Teks sorotan sekunder
info #FF8A5B Nilai informasional
success #2FBF71 Status berhasil
warn #FFB020 Peringatan, flag opsi, fallback
error #E23D2D Kesalahan, kegagalan
muted #8B7F77 Pengurangan penekanan, metadata

Sumber acuan palet: packages/terminal-core/src/palette.ts.

Pohon perintah

Pohon perintah lengkap

Peta ini mencakup perintah inti dan subperintah utamanya. Subperintah yang ditambahkan Plugin (misalnya di bawah skills, plugins, dan wiki) berkembang secara independen; jalankan <command> --help untuk daftar terkini yang otoritatif.

Code
openclaw [--dev] [--profile <name>] <command>crestodiansetuponboardconfigureconfig  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  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)

Plugin dapat menambahkan perintah tingkat atas tambahan, seperti openclaw workboard atau openclaw voicecall.

Perintah garis miring chat

Pesan chat mendukung perintah /.... Lihat perintah garis miring.

Sorotan:

  • /status - diagnostik cepat.
  • /trace - baris pelacakan/debug Plugin dengan cakupan sesi.
  • /config - perubahan konfigurasi yang dipersistenkan.
  • /debug - penggantian konfigurasi khusus waktu proses (memori, bukan disk; memerlukan commands.debug: true).

Pelacakan penggunaan

openclaw status --usage dan UI Kontrol menampilkan penggunaan/kuota penyedia saat kredensial OAuth/API tersedia. Data berasal langsung dari titik akhir penggunaan penyedia dan dinormalisasi menjadi X% tersisa. Penyedia dengan jendela penggunaan saat ini: Anthropic, Gemini CLI, GitHub Copilot, MiniMax, OpenAI Codex, Xiaomi, dan z.ai.

Lihat Pelacakan penggunaan untuk detail.

Terkait

Was this useful?
On this page

On this page