--- read_when: - Bạn cần thông tin chi tiết về hành vi của openclaw onboard - Bạn đang gỡ lỗi kết quả hướng dẫn thiết lập ban đầu hoặc tích hợp các ứng dụng khách hướng dẫn thiết lập ban đầu sidebarTitle: CLI reference summary: Tài liệu tham khảo đầy đủ về luồng thiết lập CLI, thiết lập xác thực/mô hình, đầu ra và cơ chế nội bộ title: Tài liệu tham khảo thiết lập CLI x-i18n: generated_at: "2026-05-10T19:51:57Z" model: gpt-5.5 provider: openai source_hash: 9166e8763c1ee1884817a9625a035b7efa1a97a1d4d4e4dffc1926675b1d3214 source_path: start/wizard-cli-reference.md workflow: 16 --- Trang này là tài liệu tham khảo đầy đủ cho `openclaw onboard`. Để xem hướng dẫn ngắn, xem [Onboarding (CLI)](/vi/start/wizard). ## Trình hướng dẫn làm gì 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 (OAuth thuê bao OpenAI Code, Anthropic Claude CLI hoặc khóa API, cùng các tùy chọn MiniMax, GLM, Ollama, Moonshot, StepFun và AI Gateway) - Vị trí workspace và các tệp bootstrap - Thiết lập Gateway (cổng, bind, xác thực, Tailscale) - Kênh và nhà cung cấp (Telegram, WhatsApp, Discord, Google Chat, Mattermost, Signal, iMessage và các Plugin kênh đi kèm khác) - Cài đặt daemon (LaunchAgent, systemd user unit hoặc Windows Scheduled Task gốc với phương án dự phòng thư mục Startup) - Kiểm tra sức khỏe - Thiết lập Skills Chế độ từ xa cấu hình máy này để kết nối tới một gateway ở nơi khác. Nó không cài đặt hoặc sửa đổi bất cứ thứ gì trên máy chủ từ xa. ## Chi tiết luồng cục bộ - Nếu `~/.openclaw/openclaw.json` tồn tại, chọn Giữ, Sửa đổi hoặc Đặt lại. - Chạy lại trình hướng dẫn sẽ không xóa bất cứ thứ gì trừ khi bạn chọn rõ ràng Đặt lại (hoặc truyền `--reset`). - CLI `--reset` mặc định là `config+creds+sessions`; dùng `--reset-scope full` để cũng xóa workspace. - Nếu cấu hình không hợp lệ hoặc chứa khóa cũ, trình hướng dẫn sẽ dừng và yêu cầu bạn chạy `openclaw doctor` trước khi tiếp tục. - Đặt lại dùng `trash` và 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 toàn bộ (cũng xóa workspace) - Ma trận tùy chọn đầy đủ nằm trong [Tùy chọn xác thực và mô hình](#auth-and-model-options). - Mặc định `~/.openclaw/workspace` (có thể cấu hình). - Gieo các tệp workspace cần thiết cho nghi thức bootstrap lần chạy đầu. - Bố cục workspace: [Workspace của tác tử](/vi/concepts/agent-workspace). - Nhắc nhập cổng, bind, chế độ xác thực và phơi bày qua Tailscale. - Khuyến nghị: giữ xác thực bằng token được bật ngay cả với loopback để các client WS cục bộ phải xác thực. - Ở chế độ token, thiết lập tương tác cung cấp: - **Tạo/lưu token dạng văn bản thuần** (mặc định) - **Dùng SecretRef** (chọn tham gia) - Ở 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 thuần hoặc SecretRef. - Đường dẫn SecretRef token không tương tác: `--gateway-token-ref-env `. - Yêu cầu một biến môi trường không rỗng trong môi trường tiến trình onboarding. - Không thể kết hợp với `--gateway-token`. - Chỉ tắt xác thực nếu bạn hoàn toàn tin cậy mọi tiến trình cục bộ. - Các bind không phải loopback vẫn yêu cầu xác thực. - [WhatsApp](/vi/channels/whatsapp): đăng nhập QR tùy chọn - [Telegram](/vi/channels/telegram): bot token - [Discord](/vi/channels/discord): bot token - [Google Chat](/vi/channels/googlechat): JSON tài khoản dịch vụ + đối tượng Webhook - [Mattermost](/vi/channels/mattermost): bot token + URL cơ sở - [Signal](/vi/channels/signal): cài đặt `signal-cli` tùy chọn + cấu hình tài khoản - [iMessage](/vi/channels/imessage): đường dẫn CLI `imsg` + quyền truy cập Messages DB; dùng SSH wrapper khi Gateway chạy ngoài máy Mac - Bảo mật DM: mặc định là ghép đôi. DM đầu tiên gửi một mã; phê duyệt qua `openclaw pairing approve ` hoặc dùng danh sách cho phép. - macOS: LaunchAgent - Yêu cầu phiên người dùng đã đăng nhập; với chế độ không đầu, dùng LaunchDaemon tùy chỉnh (không được cung cấp). - Linux và Windows qua WSL2: systemd user unit - Trình hướng dẫn thử `loginctl enable-linger ` để gateway tiếp tục chạy sau khi đăng xuất. - Có thể nhắc sudo (ghi vào `/var/lib/systemd/linger`); nó thử không dùng sudo trước. - Windows gốc: ưu tiên Scheduled Task - Nếu việc tạo tác vụ bị từ chối, OpenClaw chuyển sang mục đăng nhập trong thư mục Startup theo người dùng và khởi động gateway ngay lập tức. - Scheduled Tasks vẫn được ưu tiên vì cung cấp trạng thái giám sát tốt hơn. - Lựa chọn runtime: Node (khuyến nghị; bắt buộc cho WhatsApp và Telegram). Bun không được khuyến nghị. - Khởi động gateway (nếu cần) và chạy `openclaw health`. - `openclaw status --deep` thêm phép thăm dò sức khỏe gateway trực tiếp vào đầu ra trạng thái, bao gồm thăm dò kênh khi được hỗ trợ. - Đọc các Skills khả dụng và kiểm tra yêu cầu. - Cho phép bạn chọn trình quản lý node: npm, pnpm hoặc bun. - Cài đặt các phụ thuộc tùy chọn (một số dùng Homebrew trên macOS). - Tóm tắt và các bước tiếp theo, bao gồm tùy chọn ứng dụng iOS, Android và macOS. Nếu không phát hiện GUI, trình hướng dẫn 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 nguyên Control UI, trình hướng dẫn sẽ thử build chúng; phương án dự phòng là `pnpm ui:build` (tự động cài đặt 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 tới một gateway ở nơi khác. Chế độ từ xa không cài đặt hoặc sửa đổi bất cứ thứ gì trên máy chủ từ xa. Những gì bạn thiết lập: - URL gateway từ xa (`ws://...`) - Token nếu gateway từ xa yêu cầu xác thực (khuyến nghị) - Nếu gateway chỉ dùng loopback, hãy dùng đường hầm SSH hoặc tailnet. - Gợi ý khám phá: - macOS: Bonjour (`dns-sd`) - Linux: Avahi (`avahi-browse`) ## Tùy chọn xác thực và mô hình Dùng `ANTHROPIC_API_KEY` nếu có hoặc nhắc nhập khóa, rồi lưu để daemon sử dụng. Luồng trình duyệt; dán `code#state`. Đặt `agents.defaults.model` thành `openai/gpt-5.5` thông qua runtime Codex khi mô hình chưa được đặt hoặc đã thuộc họ OpenAI. Luồng ghép đôi trình duyệt với mã thiết bị tồn tại ngắn hạn. Đặt `agents.defaults.model` thành `openai/gpt-5.5` thông qua runtime Codex khi mô hình chưa được đặt hoặc đã thuộc họ OpenAI. Dùng `OPENAI_API_KEY` nếu có hoặc nhắc nhập khóa, rồi lưu thông tin xác thực trong hồ sơ xác thực. Đặt `agents.defaults.model` thành `openai/gpt-5.5` khi mô hình chưa được đặt, là `openai/*` hoặc `openai-codex/*`. Nhắc nhập `XAI_API_KEY` và cấu hình xAI làm nhà cung cấp mô hình. Nhắc nhập `OPENCODE_API_KEY` (hoặc `OPENCODE_ZEN_API_KEY`) và cho phép bạn chọn danh mục Zen hoặc Go. URL thiết lập: [opencode.ai/auth](https://opencode.ai/auth). Lưu khóa cho bạn. Nhắc nhập `AI_GATEWAY_API_KEY`. Chi tiết thêm: [Vercel AI Gateway](/vi/providers/vercel-ai-gateway). Nhắc nhập ID tài khoản, ID gateway và `CLOUDFLARE_AI_GATEWAY_API_KEY`. Chi tiết thêm: [Cloudflare AI Gateway](/vi/providers/cloudflare-ai-gateway). Cấu hình được tự động ghi. Mặc định được lưu trữ là `MiniMax-M2.7`; thiết lập khóa API dùng `minimax/...`, và thiết lập OAuth dùng `minimax-portal/...`. Chi tiết thêm: [MiniMax](/vi/providers/minimax). Cấu hình được tự động ghi cho StepFun tiêu chuẩn hoặc Step Plan trên endpoint Trung Quốc hoặc toàn cầu. Tiêu chuẩn hiện bao gồm `step-3.5-flash`, và Step Plan cũng bao gồm `step-3.5-flash-2603`. Chi tiết thêm: [StepFun](/vi/providers/stepfun). Nhắc nhập `SYNTHETIC_API_KEY`. Chi tiết thêm: [Synthetic](/vi/providers/synthetic). Trước tiên nhắc chọn `Cloud + Local`, `Cloud only` hoặc `Local only`. `Cloud only` dùng `OLLAMA_API_KEY` với `https://ollama.com`. Các chế độ dựa trên host nhắc nhập URL cơ sở (mặc định `http://127.0.0.1:11434`), khám phá các mô hình khả dụng và đề xuất mặc định. `Cloud + Local` cũng kiểm tra liệu host Ollama đó đã đăng nhập để truy cập đám mây hay chưa. Chi tiết thêm: [Ollama](/vi/providers/ollama). Cấu hình Moonshot (Kimi K2) và Kimi Coding được tự động ghi. Chi tiết thêm: [Moonshot AI (Kimi + Kimi Coding)](/vi/providers/moonshot). Hoạt động với các endpoint tương thích OpenAI và tương thích Anthropic. Onboarding tương tác hỗ trợ cùng các lựa chọn lưu trữ khóa API như các luồng khóa API nhà cung cấp khác: - **Dán khóa API ngay** (văn bản thuần) - **Dùng tham chiếu bí mật** (tham chiếu env hoặc tham chiếu nhà cung cấp đã cấu hình, có kiểm tra preflight) Cờ không tương tác: - `--auth-choice custom-api-key` - `--custom-base-url` - `--custom-model-id` - `--custom-api-key` (tùy chọn; dự phòng về `CUSTOM_API_KEY`) - `--custom-provider-id` (tùy chọn) - `--custom-compatibility ` (tùy chọn; mặc định `openai`) - `--custom-image-input` / `--custom-text-input` (tùy chọn; ghi đè khả năng đầu vào mô hình được suy luận) Để xác thực chưa được cấu hình. Hành vi mô 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. - Onboarding nhà cung cấp tùy chỉnh suy luận hỗ trợ hình ảnh cho các ID mô hình phổ biến và chỉ hỏi khi tên mô hình không xác định. - Khi onboarding bắt đầu từ một lựa chọn xác thực nhà cung cấp, bộ chọn mô hình tự động ưu tiên nhà cung cấp đó. Với Volcengine và BytePlus, cùng tùy chọn ưu tiên đó cũng khớp các biến thể coding-plan của họ (`volcengine-plan/*`, `byteplus-plan/*`). - Nếu bộ lọc nhà cung cấp ưu tiên đó sẽ rỗng, bộ chọn sẽ dự phòng về toàn bộ danh mục thay vì không hiển thị mô hình nào. - Trình hướng dẫn chạy kiểm tra mô hình và cảnh báo nếu mô hình đã cấu hình không xác định hoặc thiếu xác thực. Đường dẫn thông tin xác thực và hồ sơ: - Hồ sơ xác thực (khóa API + OAuth): `~/.openclaw/agents//agent/auth-profiles.json` - Nhập OAuth cũ: `~/.openclaw/credentials/oauth.json` Chế độ lưu trữ thông tin xác thực: - Hành vi onboarding mặc định lưu khóa API dưới dạng giá trị văn bản thuần trong hồ sơ xác thực. - `--secret-input-mode ref` bật chế độ tham chiếu thay vì lưu trữ khóa dạng văn bản thuần. Trong thiết lập tương tác, bạn có thể chọn một trong hai: - 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 (`file` hoặc `exec`) với bí danh nhà cung cấp + id - Chế độ tham chiếu tương tác chạy xác thực preflight nhanh trước khi lưu. - Tham chiếu env: 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à phân giải id được yêu cầu. - Nếu preflight thất bại, onboarding hiển thị lỗi và cho phép bạn thử lại. - Ở chế độ không tương tác, `--secret-input-mode ref` chỉ dựa trên env. - Đặt biến môi trường của nhà cung cấp trong môi trường tiến trình onboarding. - Các 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 thất bại nhanh. - Với nhà cung cấp tùy chỉnh, chế độ `ref` không tương tác lưu `models.providers..apiKey` dướ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-key` yêu cầu `CUSTOM_API_KEY` được đặt; nếu không, onboarding thất bại nhanh. - Thông tin xác thực Gateway hỗ trợ lựa chọn văn bản thuần và SecretRef trong thiết lập tương tác: - Chế độ token: **Tạo/lưu token dạng văn bản thuần** (mặc định) hoặc **Dùng SecretRef**. - Chế độ mật khẩu: văn bản thuần hoặc SecretRef. - Đường dẫn SecretRef token không tương tác: `--gateway-token-ref-env `. - Các thiết lập văn bản thuần hiện có tiếp tục hoạt động không thay đổi. Mẹo cho môi trường headless và máy chủ: hoàn tất OAuth trên một máy có trình duyệt, sau đó sao chép `auth-profiles.json` của agent đó (ví dụ `~/.openclaw/agents//agent/auth-profiles.json`, hoặc đường dẫn `$OPENCLAW_STATE_DIR/...` tương ứng) sang máy chủ Gateway. `credentials/oauth.json` chỉ là nguồn nhập cũ. ## Đầu ra và nội bộ Các trường thường gặp trong `~/.openclaw/openclaw.json`: - `agents.defaults.workspace` - `agents.defaults.skipBootstrap` khi truyền `--skip-bootstrap` - `agents.defaults.model` / `models.providers` (nếu chọn Minimax) - `tools.profile` (onboarding cục bộ mặc định là `"coding"` khi chưa đặt; các giá trị tường minh hiện có được giữ nguyên) - `gateway.*` (mode, bind, auth, tailscale) - `session.dmScope` (onboarding cục bộ mặc định đặt giá trị này thành `per-channel-peer` khi chưa đặt; các giá trị tường minh hiện có được giữ nguyên) - `channels.telegram.botToken`, `channels.discord.token`, `channels.matrix.*`, `channels.signal.*`, `channels.imessage.*` - Danh sách cho phép của kênh (Slack, Discord, Matrix, Microsoft Teams) khi bạn chọn tham gia trong các lời nhắc (tên sẽ được phân giải thành ID khi có thể) - `skills.install.nodeManager` - Cờ `setup --node-manager` chấp nhận `npm`, `pnpm`, hoặc `bun`. - Cấu hình thủ công vẫn có thể đặt `skills.install.nodeManager: "yarn"` sau đó. - `wizard.lastRunAt` - `wizard.lastRunVersion` - `wizard.lastRunCommit` - `wizard.lastRunCommand` - `wizard.lastRunMode` `openclaw agents add` ghi `agents.list[]` và `bindings` tùy chọn. Thông tin đăng nhập WhatsApp nằm trong `~/.openclaw/credentials/whatsapp//`. Các phiên được lưu trong `~/.openclaw/agents//sessions/`. Một số kênh được phân phối dưới dạng Plugin. Khi được chọn trong quá trình thiết lập, wizard sẽ nhắc cài đặt Plugin (npm hoặc đường dẫn cục bộ) trước khi cấu hình kênh. RPC wizard của Gateway: - `wizard.start` - `wizard.next` - `wizard.cancel` - `wizard.status` Client (ứng dụng macOS và Control UI) có thể kết xuất các bước mà không cần triển khai lại logic onboarding. Hành vi thiết lập Signal: - Tải xuống release asset phù hợp - Lưu nó trong `~/.openclaw/tools/signal-cli//` - Ghi `channels.signal.cliPath` vào cấu hình - Các bản dựng JVM yêu cầu Java 21 - Các bản dựng native được dùng khi có sẵn - Windows dùng WSL2 và tuân theo luồng signal-cli của Linux bên trong WSL ## Tài liệu liên quan - Trung tâm onboarding: [Onboarding (CLI)](/vi/start/wizard) - Tự động hóa và script: [Tự động hóa CLI](/vi/start/wizard-cli-automation) - Tham chiếu lệnh: [`openclaw onboard`](/vi/cli/onboard)