Skip to content

commands-reference.md

Latest commit

 

History

History
189 lines (135 loc) · 7.3 KB

commands-reference.md

File metadata and controls

189 lines (135 loc) · 7.3 KB

Tham khảo lệnh ZeroClaw

Dựa trên CLI hiện tại (zeroclaw --help).

Xác minh lần cuối: 2026-03-04.

Lệnh cấp cao nhất

Lệnh Mục đích
onboard Khởi tạo workspace/config nhanh hoặc tương tác
agent Chạy chat tương tác hoặc chế độ gửi tin nhắn đơn
gateway Khởi động gateway webhook và HTTP WhatsApp
daemon Khởi động runtime có giám sát (gateway + channels + heartbeat/scheduler tùy chọn)
service Quản lý vòng đời dịch vụ cấp hệ điều hành
doctor Chạy chẩn đoán và kiểm tra trạng thái
status Hiển thị cấu hình và tóm tắt hệ thống
security Chạy tác vụ bảo trì bảo mật (cập nhật corpus semantic guard)
cron Quản lý tác vụ định kỳ
models Làm mới danh mục model của provider
providers Liệt kê ID provider, bí danh và provider đang dùng
channel Quản lý kênh và kiểm tra sức khỏe kênh
integrations Kiểm tra chi tiết tích hợp
skills Liệt kê/cài đặt/gỡ bỏ skills
migrate Nhập dữ liệu từ runtime khác (hiện hỗ trợ OpenClaw)
config Kiểm tra, truy vấn và sửa đổi cấu hình runtime
completions Tạo script tự hoàn thành cho shell ra stdout
hardware Phát hiện và kiểm tra phần cứng USB
peripheral Cấu hình và nạp firmware thiết bị ngoại vi

Nhóm lệnh

onboard

  • zeroclaw onboard
  • zeroclaw onboard --interactive
  • zeroclaw onboard --channels-only
  • zeroclaw onboard --api-key <KEY> --provider <ID> --memory <sqlite|lucid|markdown|none>
  • zeroclaw onboard --api-key <KEY> --provider <ID> --model <MODEL_ID> --memory <sqlite|lucid|markdown|none>
  • zeroclaw onboard --migrate-openclaw
  • zeroclaw onboard --migrate-openclaw --openclaw-source <PATH> --openclaw-config <PATH>

agent

  • zeroclaw agent
  • zeroclaw agent -m "Hello"
  • zeroclaw agent --provider <ID> --model <MODEL> --temperature <0.0-2.0>
  • zeroclaw agent --peripheral <board:path>

gateway / daemon

  • zeroclaw gateway [--host <HOST>] [--port <PORT>] [--new-pairing]
  • zeroclaw daemon [--host <HOST>] [--port <PORT>]

--new-pairing sẽ xóa toàn bộ token đã ghép đôi và tạo mã ghép đôi mới khi gateway khởi động.

service

  • zeroclaw service install
  • zeroclaw service start
  • zeroclaw service stop
  • zeroclaw service restart
  • zeroclaw service status
  • zeroclaw service uninstall

security

  • zeroclaw security update-guard-corpus
  • zeroclaw security update-guard-corpus --source builtin
  • zeroclaw security update-guard-corpus --source ./data/security/attack-corpus-v1.jsonl
  • zeroclaw security update-guard-corpus --source https://example.com/guard-corpus.jsonl --checksum <sha256>

Ghi chú:

  • update-guard-corpus sẽ upsert bản ghi corpus vào collection security.semantic_guard_collection.
  • --source chấp nhận builtin, đường dẫn file cục bộ, hoặc URL http(s).
  • --checksum dùng để xác thực SHA-256 trước khi import.

cron

  • zeroclaw cron list
  • zeroclaw cron add <expr> [--tz <IANA_TZ>] <command>
  • zeroclaw cron add-at <rfc3339_timestamp> <command>
  • zeroclaw cron add-every <every_ms> <command>
  • zeroclaw cron once <delay> <command>
  • zeroclaw cron remove <id>
  • zeroclaw cron pause <id>
  • zeroclaw cron resume <id>

models

  • zeroclaw models refresh
  • zeroclaw models refresh --provider <ID>
  • zeroclaw models refresh --force

models refresh hiện hỗ trợ làm mới danh mục trực tiếp cho các provider: openrouter, openai, anthropic, groq, mistral, deepseek, xai, together-ai, gemini, ollama, llamacpp, sglang, vllm, astrai, venice, fireworks, cohere, moonshot, stepfun, glm, zai, qwen, volcengine (alias doubao/ark), siliconflow và nvidia.

channel

  • zeroclaw channel list
  • zeroclaw channel start
  • zeroclaw channel doctor
  • zeroclaw channel bind-telegram <IDENTITY>
  • zeroclaw channel add <type> <json>
  • zeroclaw channel remove <name>

Lệnh trong chat khi runtime đang chạy (Telegram/Discord):

  • /models
  • /models <provider>
  • /model
  • /model <model-id>

Channel runtime cũng theo dõi config.toml và tự động áp dụng thay đổi cho:

  • default_provider
  • default_model
  • default_temperature
  • api_key / api_url (cho provider mặc định)
  • reliability.* cài đặt retry của provider

add/remove hiện chuyển hướng về thiết lập có hướng dẫn / cấu hình thủ công (chưa hỗ trợ đầy đủ mutator khai báo).

integrations

  • zeroclaw integrations info <name>

skills

  • zeroclaw skills list
  • zeroclaw skills install <source>
  • zeroclaw skills remove <name>

<source> chấp nhận git remote (https://..., http://..., ssh://... và git@host:owner/repo.git) hoặc đường dẫn cục bộ.

Skill manifest (SKILL.toml) hỗ trợ prompts và [[tools]]; cả hai được đưa vào system prompt của agent khi chạy, giúp model có thể tuân theo hướng dẫn skill mà không cần đọc thủ công.

migrate

  • zeroclaw migrate openclaw [--source <path>] [--source-config <path>] [--dry-run]

Gợi ý: trong hội thoại agent, bề mặt tool openclaw_migration cho phép preview hoặc áp dụng migration bằng tool-call có kiểm soát quyền.

config

  • zeroclaw config show
  • zeroclaw config get <key>
  • zeroclaw config set <key> <value>
  • zeroclaw config schema

config show xuất toàn bộ cấu hình hiệu lực dưới dạng JSON với các trường nhạy cảm được ẩn thành ***REDACTED***. Các ghi đè từ biến môi trường đã được áp dụng.

config get <key> truy vấn một giá trị theo đường dẫn phân tách bằng dấu chấm (ví dụ: gateway.port, security.estop.enabled). Giá trị đơn in trực tiếp; đối tượng và mảng in dạng JSON.

config set <key> <value> cập nhật giá trị cấu hình và lưu nguyên tử vào config.toml. Kiểu dữ liệu được suy luận tự động (true/false → bool, số nguyên, số thực, cú pháp JSON → đối tượng/mảng, còn lại → chuỗi). Sai kiểu sẽ bị từ chối trước khi ghi.

config schema xuất JSON Schema (draft 2020-12) cho toàn bộ hợp đồng config.toml ra stdout.

completions

  • zeroclaw completions bash
  • zeroclaw completions fish
  • zeroclaw completions zsh
  • zeroclaw completions powershell
  • zeroclaw completions elvish

completions chỉ xuất ra stdout để script có thể được source trực tiếp mà không bị lẫn log/cảnh báo.

hardware

  • zeroclaw hardware discover
  • zeroclaw hardware introspect <path>
  • zeroclaw hardware info [--chip <chip_name>]

peripheral

  • zeroclaw peripheral list
  • zeroclaw peripheral add <board> <path>
  • zeroclaw peripheral flash [--port <serial_port>]
  • zeroclaw peripheral setup-uno-q [--host <ip_or_host>]
  • zeroclaw peripheral flash-nucleo

Kiểm tra nhanh

Để xác minh nhanh tài liệu với binary hiện tại:

zeroclaw --help
zeroclaw <command> --help