CLI commands
مرجع CLI
openclaw نقطهٔ ورود اصلی CLI است. هر فرمان اصلی یک صفحهٔ مرجع اختصاصی دارد
یا همراه با فرمانی که نام مستعار آن است مستند شده است؛ این فهرست
فرمانها، پرچمهای سراسری و قواعد قالببندی خروجی را که در سراسر CLI اعمال میشوند، فهرست میکند.
فرمانهای راهاندازی بر اساس هدف:
openclaw setupوopenclaw onboardابتدا استنتاج را بررسی میکنند، سپس OpenClaw را برای راهاندازی Gateway، فضای کاری، کانالها، Skills و سلامت آغاز میکنند.openclaw setup --baselineپیکربندی پایه و فضای کاری را بدون طیکردن جریان هدایتشدهٔ آغاز به کار ایجاد میکند.openclaw configureبخشهای مشخصی از یک راهاندازی موجود را تغییر میدهد: احراز هویت مدل، Gateway، کانالها، Pluginها یا Skills.openclaw channels addپس از ایجاد پیکربندی پایه، حسابهای کانال را پیکربندی میکند؛ انتخاب کانال بهتنهایی از راهاندازی هدایتشده استفاده میکند، درحالیکه پرچمهای حساب، اعتبارنامه یا پیکربندی کانال از مسیر مستقیم برای اسکریپتها استفاده میکنند.
صفحههای فرمان
| حوزه | فرمانها |
|---|---|
| راهاندازی و آغاز به کار | openclaw · 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 · worker |
| محیط اجرا و جعبهشنی | 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 روی 19001 و جابهجایی پورتهای مشتقشده |
--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 را اجرا کنید.
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 (نام مستعار: 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 (نام مستعار: tui --local)terminal (نام مستعار: tui --local)Pluginها میتوانند فرمانهای سطحبالای دیگری نیز اضافه کنند، مانند
openclaw workboard یا openclaw voicecall.
فرمانهای اسلش در چت
پیامهای چت از فرمانهای /... پشتیبانی میکنند. به فرمانهای اسلش مراجعه کنید.
نکات برجسته:
/status- عیبیابی سریع./trace- خطوط ردیابی/اشکالزدایی Plugin در محدودهٔ نشست./config- تغییرات پایدار پیکربندی./debug- بازنویسیهای پیکربندی فقط برای زمان اجرا (در حافظه، نه روی دیسک؛ نیازمندcommands.debug: true).
ردیابی مصرف
openclaw status --usage و رابط کاربری Control، در صورت در دسترس بودن
اعتبارنامههای OAuth/API، میزان مصرف/سهمیهٔ ارائهدهنده را نمایش میدهند. دادهها مستقیماً از نقاط پایانی مصرف
ارائهدهنده دریافت و به X% left نرمالسازی میشوند. ارائهدهندگان دارای
بازههای مصرف فعلی: Anthropic، Gemini CLI، GitHub Copilot، MiniMax، OpenAI Codex،
Xiaomi و z.ai.
برای جزئیات، به ردیابی مصرف مراجعه کنید.