Tham khảo Thiết lập CLI
Trang này cung cấp tham khảo đầy đủ choopenclaw onboard.
Để xem hướng dẫn ngắn, hãy xem Onboarding (CLI).
Những gì wizard thực hiện
Chế độ cục bộ (mặc định) hướng dẫn bạn qua:- Thiết lập mô hình và xác thực (OpenAI Code subscription OAuth, khóa API Anthropic hoặc token thiết lập, cùng với các tùy chọn MiniMax, GLM, Ollama, Moonshot và AI Gateway)
- Vị trí Workspace và các file khởi động
- Cài đặt Gateway (cổng, bind, xác thực, tailscale)
- Kênh và nhà cung cấp (Telegram, WhatsApp, Discord, Google Chat, plugin Mattermost, Signal)
- Cài đặt Daemon (LaunchAgent hoặc systemd user unit)
- Kiểm tra sức khỏe
- Thiết lập kỹ năng
Chi tiết quy trình cục bộ
Phát hiện cấu hình hiện có
- Nếu
~/.openclaw/openclaw.jsontồn tại, chọn Giữ, Sửa đổi hoặc Đặt lại. - Chạy lại wizard không xóa bất kỳ thứ gì trừ khi bạn chọn Đặt lại (hoặc sử dụng
--reset). - CLI
--resetmặc định làconfig+creds+sessions; sử dụng--reset-scope fullđể xóa cả workspace. - Nếu cấu hình không hợp lệ hoặc chứa khóa cũ, wizard dừng lại và yêu cầu bạn chạy
openclaw doctortrước khi tiếp tục. - Đặt lại sử dụng
trashvà cung cấp các phạm vi:- Chỉ cấu hình
- Cấu hình + thông tin xác thực + phiên
- Đặt lại hoàn toàn (cũng xóa workspace)
Mô hình và xác thực
- Ma trận tùy chọn đầy đủ có trong Tùy chọn xác thực và mô hình.
Workspace
- Mặc định
~/.openclaw/workspace(có thể cấu hình). - Khởi tạo các file workspace cần thiết cho lần chạy đầu tiên.
- Bố cục Workspace: Agent workspace.
Gateway
- Nhắc nhở về cổng, bind, chế độ xác thực và phơi bày tailscale.
- Khuyến nghị: giữ xác thực token được bật ngay cả cho loopback để các client WS cục bộ phải xác thực.
- Trong chế độ token, thiết lập tương tác cung cấp:
- Tạo/lưu trữ token dạng văn bản (mặc định)
- Sử dụng SecretRef (tùy chọn)
- Trong chế độ mật khẩu, thiết lập tương tác cũng hỗ trợ lưu trữ dạng văn bản hoặc SecretRef.
- Đường dẫn SecretRef token không tương tác:
--gateway-token-ref-env <ENV_VAR>.- Yêu cầu một biến môi trường không rỗng trong môi trường quy trình onboarding.
- Không thể kết hợp với
--gateway-token.
- Chỉ vô hiệu hóa xác thực nếu bạn hoàn toàn tin tưởng mọi quy trình cục bộ.
- Các bind không phải loopback vẫn yêu cầu xác thực.
Kênh
- WhatsApp: đăng nhập QR tùy chọn
- Telegram: token bot
- Discord: token bot
- Google Chat: tài khoản dịch vụ JSON + đối tượng webhook
- Plugin Mattermost: token bot + URL cơ sở
- Signal: cài đặt
signal-clitùy chọn + cấu hình tài khoản - BlueBubbles: khuyến nghị cho iMessage; URL máy chủ + mật khẩu + webhook
- iMessage: đường dẫn CLI
imsgcũ + truy cập DB - Bảo mật DM: mặc định là ghép đôi. DM đầu tiên gửi mã; phê duyệt qua
openclaw pairing approve <channel> <code>hoặc sử dụng danh sách cho phép.
Cài đặt Daemon
- macOS: LaunchAgent
- Yêu cầu phiên người dùng đã đăng nhập; cho headless, sử dụng LaunchDaemon tùy chỉnh (không được cung cấp).
- Linux và Windows qua WSL2: systemd user unit
- Wizard cố gắng
loginctl enable-linger <user>để gateway duy trì sau khi đăng xuất. - Có thể yêu cầu sudo (ghi vào
/var/lib/systemd/linger); nó thử mà không cần sudo trước.
- Wizard cố gắng
- Lựa chọn runtime: Node (khuyến nghị; yêu cầu cho WhatsApp và Telegram). Bun không được khuyến nghị.
Kiểm tra sức khỏe
- Khởi động gateway (nếu cần) và chạy
openclaw health. openclaw status --deepthêm các kiểm tra sức khỏe gateway vào đầu ra trạng thái.
Kỹ năng
- Đọc các kỹ năng có sẵn và kiểm tra yêu cầu.
- Cho phép bạn chọn trình quản lý node: npm hoặc pnpm (không khuyến nghị bun).
- Cài đặt các phụ thuộc tùy chọn (một số sử dụng Homebrew trên macOS).
Nếu không phát hiện GUI, wizard sẽ in hướng dẫn chuyển tiếp cổng SSH cho Control UI thay vì mở trình duyệt.
Nếu thiếu tài sản Control UI, wizard sẽ cố gắng xây dựng chúng; phương án dự phòng là
pnpm ui:build (tự động cài đặt các phụ thuộc UI).Chi tiết chế độ từ xa
Chế độ từ xa cấu hình máy này để kết nối với một gateway ở nơi khác.Chế độ từ xa không cài đặt hoặc thay đổi bất kỳ thứ gì trên máy chủ từ xa.
- URL gateway từ xa (
ws://...) - Token nếu yêu cầu xác thực gateway từ xa (khuyến nghị)
- Nếu gateway chỉ dành cho loopback, sử dụng SSH tunneling hoặc một tailnet.
- Gợi ý khám phá:
- macOS: Bonjour (
dns-sd) - Linux: Avahi (
avahi-browse)
- macOS: Bonjour (
Tùy chọn xác thực và mô hình
Khóa API Anthropic
Khóa API Anthropic
Sử dụng
ANTHROPIC_API_KEY nếu có hoặc yêu cầu nhập khóa, sau đó lưu để daemon sử dụng.Anthropic OAuth (Claude Code CLI)
Anthropic OAuth (Claude Code CLI)
- macOS: kiểm tra mục Keychain “Claude Code-credentials”
- Linux và Windows: tái sử dụng
~/.claude/.credentials.jsonnếu có
Token Anthropic (dán token thiết lập)
Token Anthropic (dán token thiết lập)
Chạy
claude setup-token trên bất kỳ máy nào, sau đó dán token.
Bạn có thể đặt tên cho nó; để trống sẽ sử dụng mặc định.OpenAI Code subscription (tái sử dụng Codex CLI)
OpenAI Code subscription (tái sử dụng Codex CLI)
Nếu
~/.codex/auth.json tồn tại, wizard có thể tái sử dụng nó.OpenAI Code subscription (OAuth)
OpenAI Code subscription (OAuth)
Quy trình trình duyệt; dán
code#state.Đặt agents.defaults.model thành openai-codex/gpt-5.4 khi mô hình chưa được đặt hoặc openai/*.Khóa API OpenAI
Khóa API OpenAI
Sử dụng
OPENAI_API_KEY nếu có hoặc yêu cầu nhập khóa, sau đó lưu thông tin xác thực vào hồ sơ xác thực.Đặt agents.defaults.model thành openai/gpt-5.4 khi mô hình chưa được đặt, openai/*, hoặc openai-codex/*.xAI (Grok) API key
xAI (Grok) API key
Yêu cầu nhập
XAI_API_KEY và cấu hình xAI làm nhà cung cấp mô hình.OpenCode
OpenCode
Yêu cầu nhập
OPENCODE_API_KEY (hoặc OPENCODE_ZEN_API_KEY) và cho phép bạn chọn catalog Zen hoặc Go.
URL thiết lập: opencode.ai/auth.Khóa API (chung)
Khóa API (chung)
Lưu trữ khóa cho bạn.
Vercel AI Gateway
Vercel AI Gateway
Yêu cầu nhập
AI_GATEWAY_API_KEY.
Chi tiết thêm: Vercel AI Gateway.Cloudflare AI Gateway
Cloudflare AI Gateway
Yêu cầu nhập ID tài khoản, ID gateway, và
CLOUDFLARE_AI_GATEWAY_API_KEY.
Chi tiết thêm: Cloudflare AI Gateway.MiniMax
MiniMax
Cấu hình được tự động ghi. Mặc định được lưu trữ là
MiniMax-M2.7; MiniMax-M2.5 vẫn có sẵn.
Chi tiết thêm: MiniMax.Synthetic (tương thích Anthropic)
Synthetic (tương thích Anthropic)
Yêu cầu nhập
SYNTHETIC_API_KEY.
Chi tiết thêm: Synthetic.Ollama (Cloud và mô hình mở cục bộ)
Ollama (Cloud và mô hình mở cục bộ)
Yêu cầu nhập URL cơ sở (mặc định
http://127.0.0.1:11434), sau đó cung cấp chế độ Cloud + Local hoặc Local.
Phát hiện các mô hình có sẵn và đề xuất mặc định.
Chi tiết thêm: Ollama.Moonshot và Kimi Coding
Moonshot và Kimi Coding
Cấu hình Moonshot (Kimi K2) và Kimi Coding được tự động ghi.
Chi tiết thêm: Moonshot AI (Kimi + Kimi Coding).
Nhà cung cấp tùy chỉnh
Nhà cung cấp tùy chỉnh
Hoạt động với các điểm cuối tương thích OpenAI và Anthropic.Onboarding tương tác hỗ trợ các lựa chọn lưu trữ khóa API giống như các luồng khóa API nhà cung cấp khác:
- Dán khóa API ngay bây giờ (dạng văn bản)
- Sử dụng tham chiếu bí mật (tham chiếu biến môi trường hoặc tham chiếu nhà cung cấp đã cấu hình, với xác thực trước chuyến bay)
--auth-choice custom-api-key--custom-base-url--custom-model-id--custom-api-key(tùy chọn; dự phòng choCUSTOM_API_KEY)--custom-provider-id(tùy chọn)--custom-compatibility <openai|anthropic>(tùy chọn; mặc địnhopenai)
Bỏ qua
Bỏ qua
Để xác thực chưa được cấu hình.
- Chọn mô hình mặc định từ các tùy chọn được phát hiện, hoặc nhập nhà cung cấp và mô hình thủ công.
- Wizard chạy kiểm tra mô hình và cảnh báo nếu mô hình được cấu hình không xác định hoặc thiếu xác thực.
- Thông tin xác thực OAuth:
~/.openclaw/credentials/oauth.json - Hồ sơ xác thực (khóa API + OAuth):
~/.openclaw/agents/<agentId>/agent/auth-profiles.json
- Hành vi onboarding mặc định lưu trữ khóa API dưới dạng giá trị văn bản trong hồ sơ xác thực.
--secret-input-mode refkích hoạt chế độ tham chiếu thay vì lưu trữ khóa dạng văn bản. Trong thiết lập tương tác, bạn có thể chọn:- tham chiếu biến môi trường (ví dụ
keyRef: { source: "env", provider: "default", id: "OPENAI_API_KEY" }) - tham chiếu nhà cung cấp đã cấu hình (
filehoặcexec) với bí danh nhà cung cấp + id
- tham chiếu biến môi trường (ví dụ
- Chế độ tham chiếu tương tác chạy xác thực trước chuyến bay nhanh trước khi lưu.
- Tham chiếu biến môi trường: xác thực tên biến + giá trị không rỗng trong môi trường onboarding hiện tại.
- Tham chiếu nhà cung cấp: xác thực cấu hình nhà cung cấp và giải quyết id yêu cầu.
- Nếu xác thực trước chuyến bay thất bại, onboarding hiển thị lỗi và cho phép bạn thử lại.
- Trong chế độ không tương tác,
--secret-input-mode refchỉ hỗ trợ biến môi trường.- Đặt biến môi trường nhà cung cấp trong môi trường quy trình onboarding.
- Cờ khóa nội tuyến (ví dụ
--openai-api-key) yêu cầu biến môi trường đó được đặt; nếu không onboarding sẽ thất bại nhanh chóng. - Đối với nhà cung cấp tùy chỉnh, chế độ
refkhông tương tác lưu trữmodels.providers.<id>.apiKeydưới dạng{ source: "env", provider: "default", id: "CUSTOM_API_KEY" }. - Trong trường hợp nhà cung cấp tùy chỉnh đó,
--custom-api-keyyêu cầuCUSTOM_API_KEYđược đặt; nếu không onboarding sẽ thất bại nhanh chóng.
- Thông tin xác thực xác thực Gateway hỗ trợ các lựa chọn văn bản và SecretRef trong thiết lập tương tác:
- Chế độ token: Tạo/lưu trữ token dạng văn bản (mặc định) hoặc Sử dụng SecretRef.
- Chế độ mật khẩu: văn bản hoặc SecretRef.
- Đường dẫn SecretRef token không tương tác:
--gateway-token-ref-env <ENV_VAR>. - Các thiết lập văn bản hiện có vẫn hoạt động không thay đổi.
Mẹo cho headless và server: hoàn thành OAuth trên máy có trình duyệt, sau đó sao chép
~/.openclaw/credentials/oauth.json (hoặc $OPENCLAW_STATE_DIR/credentials/oauth.json)
đến máy chủ gateway.Đầu ra và nội bộ
Các trường điển hình trong~/.openclaw/openclaw.json:
agents.defaults.workspaceagents.defaults.model/models.providers(nếu chọn Minimax)tools.profile(onboarding cục bộ mặc định là"coding"khi chưa được đặt; các giá trị rõ ràng hiện có được giữ nguyên)gateway.*(chế độ, bind, xác thực, tailscale)session.dmScope(onboarding cục bộ mặc định làper-channel-peerkhi chưa được đặt; các giá trị rõ ràng hiện có được giữ nguyên)channels.telegram.botToken,channels.discord.token,channels.signal.*,channels.imessage.*- Danh sách cho phép kênh (Slack, Discord, Matrix, Microsoft Teams) khi bạn chọn tham gia trong các lời nhắc (tên được giải quyết thành ID khi có thể)
skills.install.nodeManagerwizard.lastRunAtwizard.lastRunVersionwizard.lastRunCommitwizard.lastRunCommandwizard.lastRunMode
openclaw agents add ghi agents.list[] và các bindings tùy chọn.
Thông tin xác thực WhatsApp được lưu dưới ~/.openclaw/credentials/whatsapp/<accountId>/.
Các phiên được lưu dưới ~/.openclaw/agents/<agentId>/sessions/.
Một số kênh được cung cấp dưới dạng plugin. Khi được chọn trong quá trình thiết lập, wizard
sẽ nhắc nhở cài đặt plugin (npm hoặc đường dẫn cục bộ) trước khi cấu hình kênh.
wizard.startwizard.nextwizard.cancelwizard.status
- Tải xuống tài sản phát hành phù hợp
- Lưu trữ dưới
~/.openclaw/tools/signal-cli/<version>/ - Ghi
channels.signal.cliPathtrong cấu hình - Các bản dựng JVM yêu cầu Java 21
- Các bản dựng gốc được sử dụng khi có sẵn
- Windows sử dụng WSL2 và theo luồng signal-cli Linux bên trong WSL
Tài liệu liên quan
- Trung tâm Onboarding: Onboarding (CLI)
- Tự động hóa và script: Tự động hóa CLI
- Tham khảo lệnh:
openclaw onboard