CLI commands

مرجع CLI

openclaw نقطهٔ ورود اصلی CLI است. هر فرمان هسته یک صفحهٔ مرجع اختصاصی دارد یا همراه با فرمانی که نام مستعار آن است مستند شده است؛ این نمایه فرمان‌ها، پرچم‌های سراسری و قواعد قالب‌بندی خروجی را که در سراسر CLI اعمال می‌شوند فهرست می‌کند.

فرمان‌های راه‌اندازی بر اساس هدف:

  • openclaw setup و openclaw onboard ابتدا استنتاج را بررسی می‌کنند، سپس Crestodian را برای راه‌اندازی Gateway، فضای کاری، کانال‌ها، Skills و سلامت آغاز می‌کنند.
  • openclaw setup --baseline پیکربندی پایه و فضای کاری را بدون پیمودن فرایند هدایت‌شدهٔ آغاز به کار ایجاد می‌کند.
  • openclaw configure بخش‌های مشخصی از یک راه‌اندازی موجود را تغییر می‌دهد: احراز هویت مدل، Gateway، کانال‌ها، Pluginها یا Skills.
  • openclaw channels add پس از ایجاد پیکربندی پایه، حساب‌های کانال را پیکربندی می‌کند؛ برای راه‌اندازی هدایت‌شده آن را بدون پرچم اجرا کنید، یا برای اسکریپت‌ها از پرچم‌های مختص هر کانال استفاده کنید.

صفحه‌های فرمان

حوزه فرمان‌ها
راه‌اندازی و آغاز به کار crestodian · setup · onboard · configure · config · completion · doctor · dashboard
بازنشانی، پشتیبان‌گیری و مهاجرت backup · migrate · reset · uninstall · update
پیام‌رسانی و عامل‌ها message · agent · agents · attach · acp · mcp
سلامت و نشست‌ها status · health · sessions · audit
Gateway و گزارش‌ها gateway · logs · system
مدل‌ها و استنتاج models · promos · infer · capability (نام مستعار infer) · memory · commitments · wiki
شبکه و Nodeها directory · nodes · devices · node
زمان اجرا و محیط ایزوله approvals · exec-policy (به approvals مراجعه کنید) · sandbox · tui · chat/terminal (نام‌های مستعار tui --local) · browser
خودکارسازی cron · tasks · hooks · webhooks · transcripts
کشف و مستندات dns · docs
جفت‌سازی و کانال‌ها pairing · qr · channels
امنیت و Pluginها security · secrets · skills · plugins · proxy
نام‌های مستعار قدیمی daemon (سرویس Gateway) · clawbot (فضای نام)
Pluginها (اختیاری) path · policy · voicecall · workboard (در صورت نصب بودن)

پرچم‌های سراسری

پرچم هدف
--dev وضعیت را در ~/.openclaw-dev ایزوله می‌کند، درگاه پیش‌فرض Gateway را روی ۱۹۰۰۱ قرار می‌دهد و درگاه‌های مشتق‌شده را جابه‌جا می‌کند
--profile <name> وضعیت را در ~/.openclaw-<name> ایزوله می‌کند (OPENCLAW_STATE_DIR/OPENCLAW_CONFIG_PATH)
--container <name> CLI را داخل کانتینر در حال اجرای Podman/Docker با نام <name> اجرا می‌کند (پیش‌فرض: متغیر محیطی OPENCLAW_CONTAINER)
--log-level <level> سطح سراسری گزارش‌گیری را برای خروجی فایل و کنسول بازنویسی می‌کند
--no-color رنگ‌های ANSI را غیرفعال می‌کند (NO_COLOR=1 نیز رعایت می‌شود)
--update شکل کوتاه openclaw update؛ هم برای نسخه‌های دریافت‌شدهٔ کد منبع و هم نصب‌های بسته کار می‌کند
-V، --version، -v نسخه را چاپ می‌کند و خارج می‌شود

حالت‌های خروجی

  • رنگ‌های ANSI و نشانگرهای پیشرفت فقط در نشست‌های TTY نمایش داده می‌شوند.
  • پیوندهای OSC-8 در محیط‌های پشتیبانی‌شده به‌صورت پیوندهای قابل کلیک نمایش داده می‌شوند؛ در غیر این صورت CLI از URLهای ساده استفاده می‌کند.
  • --json--plain در موارد پشتیبانی‌شده) قالب‌بندی را برای خروجی پاک غیرفعال می‌کند.
  • فرمان‌های طولانی‌مدت یک نشانگر پیشرفت نمایش می‌دهند (در صورت پشتیبانی، OSC 9;4).

پالت رنگ

OpenClaw برای خروجی CLI از پالت خرچنگ دریایی استفاده می‌کند:

نشانه هگز کاربرد
accent #FF5A2D عنوان‌ها، برچسب‌ها، برجسته‌سازی‌های اصلی
accentBright #FF7A3D نام فرمان‌ها، تأکید
accentDim #D14A22 متن برجسته‌سازی ثانویه
info #FF8A5B مقادیر اطلاعاتی
success #2FBF71 وضعیت‌های موفقیت
warn #FFB020 هشدارها، پرچم‌های گزینه، راهکارهای جایگزین
error #E23D2D خطاها، شکست‌ها
muted #8B7F77 کم‌رنگ‌سازی، فراداده

منبع مرجع پالت: packages/terminal-core/src/palette.ts.

درخت فرمان‌ها

درخت کامل فرمان‌ها

این نقشه فرمان‌های هسته و زیرفرمان‌های اصلی آن‌ها را پوشش می‌دهد. زیرفرمان‌هایی که Pluginها اضافه می‌کنند (برای مثال زیر skills، plugins و wiki) به‌طور مستقل تکامل می‌یابند؛ برای مشاهدهٔ فهرست معتبر و به‌روز، <command> --help را اجرا کنید.

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ها می‌توانند فرمان‌های سطح‌بالای دیگری نیز اضافه کنند، مانند openclaw workboard یا openclaw voicecall.

فرمان‌های اسلش در گفت‌وگو

پیام‌های گفت‌وگو از فرمان‌های /... پشتیبانی می‌کنند. به فرمان‌های اسلش مراجعه کنید.

نکات برجسته:

  • /status - عیب‌یابی سریع.
  • /trace - خطوط ردیابی و اشکال‌زدایی Plugin در محدوده نشست.
  • /config - تغییرات ماندگار پیکربندی.
  • /debug - بازنویسی‌های پیکربندی فقط در زمان اجرا (در حافظه، نه روی دیسک؛ نیازمند commands.debug: true).

ردیابی مصرف

هنگامی که اعتبارنامه‌های OAuth/API در دسترس باشند، openclaw status --usage و رابط کاربری کنترل، میزان مصرف و سهمیه ارائه‌دهنده را نمایش می‌دهند. داده‌ها مستقیماً از نقاط پایانی مصرف ارائه‌دهندگان دریافت و به قالب X% left نرمال‌سازی می‌شوند. ارائه‌دهندگانی که در حال حاضر بازه‌های مصرف دارند عبارت‌اند از: Anthropic، Gemini CLI، GitHub Copilot، MiniMax، OpenAI Codex، Xiaomi و z.ai.

برای جزئیات، به ردیابی مصرف مراجعه کنید.

مرتبط

Was this useful?
On this page

On this page