Chuyển đến nội dung chính

Documentation Index

Fetch the complete documentation index at: https://docs2.openclaw.ai/llms.txt

Use this file to discover all available pages before exploring further.

CLI onboarding là cách được khuyến nghị để thiết lập OpenClaw trên macOS, Linux, hoặc Windows (qua WSL2; rất khuyến nghị). Nó cấu hình Gateway cục bộ hoặc kết nối Gateway từ xa, cùng với các kênh, Skills, và mặc định workspace trong một quy trình có hướng dẫn. 
openclaw onboard
Cuộc trò chuyện đầu tiên nhanh nhất: mở Control UI (không cần thiết lập kênh). Chạy openclaw dashboard và trò chuyện trong trình duyệt. Tài liệu: Bảng điều khiển.
Để cấu hình lại sau: 
openclaw configure
openclaw agents add <name>
--json không ngụ ý chế độ không tương tác. Với script, hãy dùng --non-interactive.
CLI onboarding bao gồm một bước tìm kiếm web, nơi bạn có thể chọn nhà cung cấp như Brave, DuckDuckGo, Exa, Firecrawl, Gemini, Grok, Kimi, MiniMax Search, Ollama Web Search, Perplexity, SearXNG, hoặc Tavily. Một số nhà cung cấp yêu cầu API key, trong khi những nhà cung cấp khác không cần khóa. Bạn cũng có thể cấu hình phần này sau bằng openclaw configure --section web. Tài liệu: Công cụ web.

​
QuickStart so với Advanced

Onboarding bắt đầu với QuickStart (mặc định) so với Advanced (toàn quyền kiểm soát).
  • Gateway cục bộ (loopback)
  • Mặc định workspace (hoặc workspace hiện có)
  • Cổng Gateway 18789
  • Xác thực Gateway Token (tự động tạo, kể cả trên loopback)
  • Mặc định chính sách công cụ cho các thiết lập cục bộ mới: tools.profile: "coding" (profile rõ ràng hiện có được giữ nguyên)
  • Mặc định cách ly DM: onboarding cục bộ ghi session.dmScope: "per-channel-peer" khi chưa đặt. Chi tiết: Tham chiếu thiết lập CLI
  • Phơi bày qua Tailscale Tắt
  • DM Telegram + WhatsApp mặc định là allowlist (bạn sẽ được nhắc nhập số điện thoại của mình)

​
Onboarding cấu hình những gì

Chế độ cục bộ (mặc định) hướng dẫn bạn qua các bước sau:
  1. Mô hình/Xác thực — chọn bất kỳ nhà cung cấp/quy trình xác thực được hỗ trợ nào (API key, OAuth, hoặc xác thực thủ công theo nhà cung cấp), bao gồm Custom Provider (tương thích OpenAI, tương thích Anthropic, hoặc tự động phát hiện Unknown). Chọn một mô hình mặc định. Ghi chú bảo mật: nếu agent này sẽ chạy công cụ hoặc xử lý nội dung webhook/hooks, hãy ưu tiên mô hình thế hệ mới nhất mạnh nhất có sẵn và giữ chính sách công cụ nghiêm ngặt. Các bậc yếu hơn/cũ hơn dễ bị prompt-inject hơn. Với các lần chạy không tương tác, --secret-input-mode ref lưu các tham chiếu dựa trên env trong auth profiles thay vì giá trị API key dạng văn bản thuần. Trong chế độ không tương tác ref, biến env của nhà cung cấp phải được đặt; truyền cờ khóa inline mà không có biến env đó sẽ thất bại ngay. Trong các lần chạy tương tác, chọn chế độ tham chiếu bí mật cho phép bạn trỏ đến biến môi trường hoặc provider ref đã cấu hình (file hoặc exec), với kiểm tra preflight nhanh trước khi lưu. Với Anthropic, onboarding/configure tương tác cung cấp Anthropic Claude CLI làm đường dẫn cục bộ ưu tiên và Anthropic API key làm đường dẫn production được khuyến nghị. Anthropic setup-token cũng vẫn có sẵn như một đường dẫn xác thực token được hỗ trợ.
  2. Workspace — Vị trí cho các tệp agent (mặc định ~/.openclaw/workspace). Khởi tạo các tệp bootstrap.
  3. Gateway — Cổng, địa chỉ bind, chế độ xác thực, phơi bày Tailscale. Trong chế độ token tương tác, chọn lưu trữ token văn bản thuần mặc định hoặc chọn dùng SecretRef. Đường dẫn SecretRef token không tương tác: --gateway-token-ref-env <ENV_VAR>.
  4. Kênh — các kênh trò chuyện tích hợp và đi kèm như iMessage, Discord, Feishu, Google Chat, Mattermost, Microsoft Teams, QQ Bot, Signal, Slack, Telegram, WhatsApp, và nhiều kênh khác.
  5. Daemon — Cài đặt LaunchAgent (macOS), systemd user unit (Linux/WSL2), hoặc Windows Scheduled Task gốc với phương án dự phòng thư mục Startup theo người dùng. Nếu xác thực token yêu cầu token và gateway.auth.token được quản lý bằng SecretRef, cài đặt daemon sẽ xác thực nó nhưng không lưu token đã phân giải vào metadata môi trường dịch vụ giám sát. Nếu xác thực token yêu cầu token và SecretRef token đã cấu hình không phân giải được, cài đặt daemon sẽ bị chặn kèm hướng dẫn có thể thực hiện. Nếu cả gateway.auth.token và gateway.auth.password đều được cấu hình và gateway.auth.mode chưa được đặt, cài đặt daemon sẽ bị chặn cho đến khi chế độ được đặt rõ ràng.
  6. Kiểm tra tình trạng — Khởi động Gateway và xác minh nó đang chạy.
  7. Skills — Cài đặt Skills được khuyến nghị và các phụ thuộc tùy chọn.
Chạy lại onboarding không xóa bất kỳ thứ gì trừ khi bạn chọn rõ ràng Reset (hoặc truyền --reset). CLI --reset mặc định áp dụng cho cấu hình, thông tin xác thực, và phiên; dùng --reset-scope full để bao gồm workspace. Nếu cấu hình không hợp lệ hoặc chứa khóa legacy, onboarding sẽ yêu cầu bạn chạy openclaw doctor trước.
Chế độ từ xa chỉ cấu hình client cục bộ để kết nối tới một Gateway ở nơi khác. Nó không cài đặt hoặc thay đổi bất kỳ thứ gì trên host từ xa.

​
Thêm agent khác

Dùng openclaw agents add <name> để tạo một agent riêng với workspace, phiên, và auth profiles riêng. Chạy mà không có --workspace sẽ khởi chạy onboarding. Nó đặt:
  • agents.list[].name
  • agents.list[].workspace
  • agents.list[].agentDir
Ghi chú:
  • Workspace mặc định theo ~/.openclaw/workspace-<agentId>.
  • Thêm bindings để định tuyến tin nhắn đến (onboarding có thể làm việc này).
  • Cờ không tương tác: --model, --agent-dir, --bind, --non-interactive.

​
Tham chiếu đầy đủ

Để xem phân tích từng bước chi tiết và đầu ra cấu hình, hãy xem Tham chiếu thiết lập CLI. Để xem ví dụ không tương tác, hãy xem Tự động hóa CLI. Để xem tham chiếu kỹ thuật sâu hơn, bao gồm chi tiết RPC, hãy xem Tham chiếu onboarding.

​
Tài liệu liên quan