CLI commands
Tài liệu tham khảo CLI
openclaw là điểm vào CLI chính. Mỗi lệnh cốt lõi có một trang tham chiếu riêng
hoặc được ghi lại cùng với lệnh mà nó làm bí danh; mục lục này liệt kê
các lệnh, cờ toàn cục và quy tắc định kiểu đầu ra áp dụng trên toàn CLI.
Các lệnh thiết lập theo mục đích:
openclaw setupvàopenclaw onboardtrước tiên xác minh khả năng suy luận, sau đó khởi động Crestodian để thiết lập Gateway, không gian làm việc, kênh, Skills và tình trạng hoạt động.openclaw setup --baselinetạo cấu hình cơ sở và không gian làm việc mà không đi qua quy trình hướng dẫn bắt đầu sử dụng.openclaw configurethay đổi các phần cụ thể của một thiết lập hiện có: xác thực mô hình, Gateway, kênh, Plugin hoặc Skills.openclaw channels addcấu hình tài khoản kênh sau khi đã có cấu hình cơ sở; chạy không có cờ để thiết lập theo hướng dẫn hoặc dùng các cờ dành riêng cho từng kênh trong tập lệnh.
Các trang lệnh
| Khu vực | Lệnh |
|---|---|
| Thiết lập và bắt đầu sử dụng | crestodian · setup · onboard · configure · config · completion · doctor · dashboard |
| Đặt lại, sao lưu và di chuyển | backup · migrate · reset · uninstall · update |
| Nhắn tin và tác tử | message · agent · agents · attach · acp · mcp |
| Tình trạng hoạt động và phiên | status · health · sessions · audit |
| Gateway và nhật ký | gateway · logs · system |
| Mô hình và suy luận | models · promos · infer · capability (bí danh của infer) · memory · commitments · wiki |
| Mạng và Node | directory · nodes · devices · node |
| Môi trường chạy và hộp cát | approvals · exec-policy (xem approvals) · sandbox · tui · chat/terminal (bí danh của tui --local) · browser |
| Tự động hóa | cron · tasks · hooks · webhooks · transcripts |
| Khám phá và tài liệu | dns · docs |
| Ghép nối và kênh | pairing · qr · channels |
| Bảo mật và Plugin | security · secrets · skills · plugins · proxy |
| Bí danh cũ | daemon (dịch vụ Gateway) · clawbot (không gian tên) |
| Plugin (tùy chọn) | path · policy · voicecall · workboard (nếu đã cài đặt) |
Cờ toàn cục
| Cờ | Mục đích |
|---|---|
--dev |
Cô lập trạng thái trong ~/.openclaw-dev, đặt cổng Gateway mặc định là 19001 và dịch chuyển các cổng dẫn xuất |
--profile <name> |
Cô lập trạng thái trong ~/.openclaw-<name> (OPENCLAW_STATE_DIR/OPENCLAW_CONFIG_PATH) |
--container <name> |
Chạy CLI bên trong vùng chứa Podman/Docker đang hoạt động có tên <name> (mặc định: biến môi trường OPENCLAW_CONTAINER) |
--log-level <level> |
Ghi đè mức nhật ký toàn cục cho đầu ra tệp và bảng điều khiển |
--no-color |
Tắt màu ANSI (NO_COLOR=1 cũng được tuân thủ) |
--update |
Dạng viết tắt của openclaw update; hoạt động cho cả bản mã nguồn đã kiểm xuất và bản cài đặt gói |
-V, --version, -v |
In phiên bản rồi thoát |
Chế độ đầu ra
- Màu ANSI và chỉ báo tiến trình chỉ hiển thị trong các phiên TTY.
- Siêu liên kết OSC-8 hiển thị dưới dạng liên kết có thể nhấp ở nơi được hỗ trợ; nếu không, CLI sẽ dùng URL dạng văn bản thuần.
--json(và--plainở nơi được hỗ trợ) tắt định kiểu để tạo đầu ra sạch.- Các lệnh chạy lâu hiển thị chỉ báo tiến trình (OSC 9;4 khi được hỗ trợ).
Bảng màu
OpenClaw sử dụng bảng màu tôm hùm cho đầu ra CLI:
| Mã màu | Hex | Dùng cho |
|---|---|---|
accent |
#FF5A2D |
Tiêu đề, nhãn, phần tô sáng chính |
accentBright |
#FF7A3D |
Tên lệnh, phần nhấn mạnh |
accentDim |
#D14A22 |
Văn bản tô sáng phụ |
info |
#FF8A5B |
Giá trị thông tin |
success |
#2FBF71 |
Trạng thái thành công |
warn |
#FFB020 |
Cảnh báo, cờ tùy chọn, phương án dự phòng |
error |
#E23D2D |
Lỗi, thất bại |
muted |
#8B7F77 |
Giảm nhấn mạnh, siêu dữ liệu |
Nguồn chuẩn của bảng màu: packages/terminal-core/src/palette.ts.
Cây lệnh
Cây lệnh đầy đủ
Sơ đồ này bao quát các lệnh cốt lõi và những lệnh con chính của chúng. Các lệnh con
do Plugin thêm vào (ví dụ bên dưới skills, plugins và wiki) phát triển
độc lập; chạy <command> --help để xem danh sách hiện hành có tính thẩm quyền.
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)Các Plugin có thể bổ sung thêm các lệnh cấp cao nhất, chẳng hạn như
openclaw workboard hoặc openclaw voicecall.
Lệnh gạch chéo trong cuộc trò chuyện
Tin nhắn trò chuyện hỗ trợ các lệnh /.... Xem lệnh gạch chéo.
Các điểm nổi bật:
/status- chẩn đoán nhanh./trace- các dòng theo dõi/gỡ lỗi Plugin trong phạm vi phiên./config- các thay đổi cấu hình được lưu giữ lâu dài./debug- ghi đè cấu hình chỉ trong thời gian chạy (trong bộ nhớ, không ghi ra đĩa; yêu cầucommands.debug: true).
Theo dõi mức sử dụng
openclaw status --usage và giao diện điều khiển hiển thị mức sử dụng/hạn mức của nhà cung cấp khi
có thông tin xác thực OAuth/API. Dữ liệu được lấy trực tiếp từ các điểm cuối theo dõi mức sử dụng
của nhà cung cấp và được chuẩn hóa thành X% left. Các nhà cung cấp hiện có
khung thời gian theo dõi mức sử dụng: Anthropic, Gemini CLI, GitHub Copilot, MiniMax, OpenAI Codex,
Xiaomi và z.ai.
Xem Theo dõi mức sử dụng để biết chi tiết.