CLI commands
مرجع CLI
openclaw نقطهٔ ورود اصلی CLI است. هر فرمان هسته یا صفحهٔ مرجع اختصاصی دارد یا همراه با فرمانی که نام مستعار آن است مستند شده است؛ این فهرست فرمانها، پرچمهای سراسری، و قواعد سبکدهی خروجی را که در سراسر CLI اعمال میشوند، فهرست میکند.
فرمانهای راهاندازی را بر اساس هدف استفاده کنید:
openclaw setupوopenclaw onboardمسیر کامل و راهنمای اجرای نخست را برای Gateway، احراز هویت مدل، فضای کاری، کانالها، Skills، و سلامت اجرا میکنند.openclaw setup --baselineپیکربندی پایه و فضای کاری را بدون پیمودن جریان راهنمای ورود اولیه ایجاد میکند.openclaw configureبخشهای هدفمند یک راهاندازی موجود، مانند احراز هویت مدل، Gateway، کانالها، پلاگینها، یا Skills را تغییر میدهد.openclaw channels addحسابهای کانال را پس از وجود داشتن پایه پیکربندی میکند؛ برای راهاندازی راهنمای کانال آن را بدون پرچم اجرا کنید، یا برای اسکریپتها با پرچمهای ویژهٔ کانال اجرا کنید.
صفحههای فرمان
| حوزه | فرمانها |
|---|---|
| راهاندازی و ورود اولیه | crestodian · setup · onboard · configure · config · completion · doctor · dashboard |
| بازنشانی و حذف نصب | backup · reset · uninstall · update |
| پیامرسانی و عاملها | message · agent · agents · attach · acp · mcp |
| سلامت و نشستها | status · health · sessions |
| Gateway و گزارشها | gateway · logs · system |
| مدلها و استنتاج | models · infer · capability (نام مستعار برای infer) · memory · commitments · wiki |
| شبکه و گرهها | directory · nodes · devices · node |
| Runtime و sandbox | approvals · exec-policy (ببینید approvals) · sandbox · tui · chat/terminal (نامهای مستعار برای tui --local) · browser |
| خودکارسازی | cron · tasks · hooks · webhooks · transcripts |
| کشف و مستندات | dns · docs |
| جفتسازی و کانالها | pairing · qr · channels |
| امنیت و پلاگینها | security · secrets · skills · plugins · proxy |
| نامهای مستعار قدیمی | daemon (سرویس Gateway) · clawbot (فضای نام) |
| پلاگینها (اختیاری) | path · policy · voicecall · workboard (در صورت نصب بودن) |
پرچمهای سراسری
| پرچم | هدف |
|---|---|
--dev |
وضعیت را زیر ~/.openclaw-dev ایزوله میکند و پورتهای پیشفرض را جابهجا میکند |
--profile <name> |
وضعیت را زیر ~/.openclaw-<name> ایزوله میکند |
--container <name> |
یک کانتینر نامگذاریشده را برای اجرا هدف میگیرد |
--no-color |
رنگهای ANSI را غیرفعال میکند (NO_COLOR=1 نیز رعایت میشود) |
--update |
شکل کوتاه openclaw update (فقط نصبهای منبعی) |
-V, --version, -v |
نسخه را چاپ میکند و خارج میشود |
حالتهای خروجی
- رنگهای ANSI و نشانگرهای پیشرفت فقط در نشستهای TTY رندر میشوند.
- پیوندهای OSC-8 در جاهایی که پشتیبانی میشود بهصورت پیوندهای قابل کلیک رندر میشوند؛ در غیر این صورت CLI به URLهای ساده بازمیگردد.
--json(و--plainدر جاهایی که پشتیبانی میشود) سبکدهی را برای خروجی تمیز غیرفعال میکند.- فرمانهای طولانیمدت یک نشانگر پیشرفت نشان میدهند (OSC 9;4 در صورت پشتیبانی).
منبع قطعی پالت: src/terminal/palette.ts.
درخت فرمان
Full command tree
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)پلاگینها میتوانند فرمانهای سطحبالای بیشتری اضافه کنند، مانند
openclaw workboard یا openclaw voicecall.
فرمانهای اسلش چت
پیامهای چت از فرمانهای /... پشتیبانی میکنند. ببینید فرمانهای اسلش.
نکات برجسته:
/status— عیبیابی سریع./trace— خطهای ردیابی/اشکالزدایی Plugin در محدودهٔ نشست./config— تغییرات پیکربندی پایدارشده./debug— بازنویسیهای پیکربندی فقط در runtime (حافظه، نه دیسک؛ نیازمندcommands.debug: true).
ردیابی مصرف
openclaw status --usage و Control UI مصرف/سهمیهٔ ارائهدهنده را زمانی که
اعتبارنامههای OAuth/API در دسترس باشند نمایش میدهند. دادهها مستقیماً از نقاط پایانی مصرف ارائهدهنده میآیند
و به X% left نرمالسازی میشوند. ارائهدهندگان با پنجرههای مصرف فعلی:
Anthropic، GitHub Copilot، Gemini CLI، OpenAI Codex، MiniMax،
Xiaomi، و z.ai.
برای جزئیات، ردیابی مصرف را ببینید.