Onboarding (CLI)
Onboarding CLI adalah cara yang direkomendasikan untuk menyiapkan OpenClaw di macOS, Linux, atau Windows (melalui WSL2; sangat direkomendasikan). Ini mengonfigurasi Gateway lokal atau koneksi Gateway jarak jauh, beserta channel, Skills, dan default workspace dalam satu alur terpandu.Chat pertama tercepat: buka UI Kontrol (tidak perlu penyiapan channel). Jalankan
openclaw dashboard dan chat di browser. Dokumentasi: Dashboard.--json tidak menyiratkan mode non-interaktif. Untuk skrip, gunakan --non-interactive.QuickStart vs Advanced
Onboarding dimulai dengan QuickStart (default) vs Advanced (kontrol penuh).- QuickStart (default)
- Advanced (kontrol penuh)
- Gateway lokal (loopback)
- Default workspace (atau workspace yang ada)
- Port Gateway 18789
- Autentikasi Gateway Token (dibuat otomatis, bahkan pada loopback)
- Default kebijakan tool untuk penyiapan lokal baru:
tools.profile: "coding"(profil eksplisit yang sudah ada dipertahankan) - Default isolasi DM: onboarding lokal menulis
session.dmScope: "per-channel-peer"saat belum disetel. Detail: Referensi Penyiapan CLI - Eksposur Tailscale Nonaktif
- DM Telegram + WhatsApp default ke allowlist (Anda akan diminta nomor telepon Anda)
Apa yang dikonfigurasi onboarding
Mode lokal (default) memandu Anda melalui langkah-langkah berikut:- Model/Auth — pilih penyedia/alur autentikasi yang didukung (kunci API, OAuth, atau autentikasi manual khusus penyedia), termasuk Penyedia Kustom
(kompatibel dengan OpenAI, kompatibel dengan Anthropic, atau deteksi otomatis Unknown). Pilih model default.
Catatan keamanan: jika agen ini akan menjalankan tool atau memproses konten webhook/hooks, pilih model generasi terbaru terkuat yang tersedia dan pertahankan kebijakan tool tetap ketat. Tingkat yang lebih lemah/lebih lama lebih mudah terkena prompt injection.
Untuk proses non-interaktif,
--secret-input-mode refmenyimpan referensi berbasis env di profil autentikasi alih-alih nilai kunci API plaintext. Dalam moderefnon-interaktif, env var penyedia harus disetel; meneruskan flag kunci inline tanpa env var tersebut akan langsung gagal. Dalam proses interaktif, memilih mode referensi rahasia memungkinkan Anda menunjuk ke env var atau ref penyedia yang dikonfigurasi (fileatauexec), dengan validasi preflight cepat sebelum menyimpan. Untuk Anthropic, onboarding/configure interaktif menawarkan Anthropic Claude CLI sebagai fallback lokal dan Anthropic API key sebagai jalur produksi yang direkomendasikan. Token penyiapan Anthropic juga kembali tersedia sebagai jalur OpenClaw legacy/manual, dengan ekspektasi penagihan Extra Usage khusus OpenClaw dari Anthropic. - Workspace — Lokasi untuk file agen (default
~/.openclaw/workspace). Mengisi file bootstrap. - Gateway — Port, alamat bind, mode autentikasi, eksposur Tailscale.
Dalam mode token interaktif, pilih penyimpanan token plaintext default atau gunakan SecretRef.
Jalur SecretRef token non-interaktif:
--gateway-token-ref-env <ENV_VAR>. - Channels — built-in dan bundled chat channels seperti BlueBubbles, Discord, Feishu, Google Chat, Mattermost, Microsoft Teams, QQ Bot, Signal, Slack, Telegram, WhatsApp, dan lainnya.
- Daemon — Menginstal LaunchAgent (macOS), unit pengguna systemd (Linux/WSL2), atau Scheduled Task Windows native dengan fallback folder Startup per pengguna.
Jika autentikasi token memerlukan token dan
gateway.auth.tokendikelola SecretRef, instalasi daemon memvalidasinya tetapi tidak menyimpan token hasil resolusi ke metadata environment layanan supervisor. Jika autentikasi token memerlukan token dan SecretRef token yang dikonfigurasi tidak dapat diresolusikan, instalasi daemon diblokir dengan panduan yang dapat ditindaklanjuti. Jikagateway.auth.tokendangateway.auth.passwordsama-sama dikonfigurasi dangateway.auth.modebelum disetel, instalasi daemon diblokir sampai mode disetel secara eksplisit. - Pemeriksaan kesehatan — Memulai Gateway dan memverifikasi bahwa layanan berjalan.
- Skills — Menginstal Skills yang direkomendasikan dan dependensi opsional.
Menjalankan ulang onboarding tidak menghapus apa pun kecuali Anda secara eksplisit memilih Reset (atau meneruskan
--reset).
CLI --reset default ke config, kredensial, dan sesi; gunakan --reset-scope full untuk menyertakan workspace.
Jika config tidak valid atau berisi kunci legacy, onboarding akan meminta Anda menjalankan openclaw doctor terlebih dahulu.Tambahkan agen lain
Gunakanopenclaw agents add <name> untuk membuat agen terpisah dengan workspace,
sesi, dan profil autentikasinya sendiri. Menjalankan tanpa --workspace akan meluncurkan onboarding.
Yang disetel:
agents.list[].nameagents.list[].workspaceagents.list[].agentDir
- Workspace default mengikuti
~/.openclaw/workspace-<agentId>. - Tambahkan
bindingsuntuk merutekan pesan masuk (onboarding dapat melakukannya). - Flag non-interaktif:
--model,--agent-dir,--bind,--non-interactive.
Referensi lengkap
Untuk rincian langkah demi langkah dan output config yang detail, lihat Referensi Penyiapan CLI. Untuk contoh non-interaktif, lihat Otomasi CLI. Untuk referensi teknis yang lebih mendalam, termasuk detail RPC, lihat Referensi Onboarding.Dokumentasi terkait
- Referensi perintah CLI:
openclaw onboard - Gambaran umum onboarding: Ikhtisar Onboarding
- Onboarding aplikasi macOS: Onboarding
- Ritual pertama kali dijalankan agen: Bootstrap Agen