Langsung ke konten utama

Documentation Index

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

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

Ini adalah referensi lengkap untuk openclaw onboard. Untuk gambaran umum tingkat tinggi, lihat Onboarding (CLI).

​
Detail alur (mode lokal)

1

Existing config detection

  • Jika ~/.openclaw/openclaw.json ada, pilih Pertahankan nilai saat ini, Tinjau dan perbarui, atau Reset sebelum penyiapan.
  • Menjalankan ulang onboarding tidak menghapus apa pun kecuali Anda secara eksplisit memilih Reset (atau meneruskan --reset).
  • CLI --reset default ke config+creds+sessions; gunakan --reset-scope full untuk juga menghapus workspace.
  • Jika konfigurasi tidak valid atau berisi key lama, wizard berhenti dan meminta Anda menjalankan openclaw doctor sebelum melanjutkan.
  • Reset menggunakan trash (tidak pernah rm) dan menawarkan cakupan:
    • Hanya konfigurasi
    • Konfigurasi + kredensial + sesi
    • Reset penuh (juga menghapus workspace)
2

Model/Auth

  • Key API Anthropic: menggunakan ANTHROPIC_API_KEY jika ada atau meminta key, lalu menyimpannya untuk penggunaan daemon.
  • Key API Anthropic: pilihan asisten Anthropic yang disarankan dalam onboarding/configure.
  • setup-token Anthropic: masih tersedia dalam onboarding/configure, meskipun OpenClaw kini lebih memilih penggunaan ulang Claude CLI jika tersedia.
  • Langganan OpenAI Code (Codex) (OAuth): alur browser; tempelkan code#state.
    • Mengatur agents.defaults.model ke openai/gpt-5.5 melalui runtime Codex ketika model belum diatur atau sudah termasuk keluarga OpenAI.
  • Langganan OpenAI Code (Codex) (pemasangan perangkat): alur pemasangan browser dengan kode perangkat yang berumur pendek.
    • Mengatur agents.defaults.model ke openai/gpt-5.5 melalui runtime Codex ketika model belum diatur atau sudah termasuk keluarga OpenAI.
  • Key API OpenAI: menggunakan OPENAI_API_KEY jika ada atau meminta key, lalu menyimpannya dalam profil auth.
    • Mengatur agents.defaults.model ke openai/gpt-5.5 ketika model belum diatur, openai/*, atau openai-codex/*.
  • Key API xAI (Grok): meminta XAI_API_KEY dan mengonfigurasi xAI sebagai penyedia model.
  • OpenCode: meminta OPENCODE_API_KEY (atau OPENCODE_ZEN_API_KEY, dapatkan di https://opencode.ai/auth) dan memungkinkan Anda memilih katalog Zen atau Go.
  • Ollama: menawarkan Cloud + Lokal, Hanya Cloud, atau Hanya lokal terlebih dahulu. Cloud only meminta OLLAMA_API_KEY dan menggunakan https://ollama.com; mode berbasis host meminta URL dasar Ollama, menemukan model yang tersedia, dan otomatis menarik model lokal yang dipilih bila diperlukan; Cloud + Local juga memeriksa apakah host Ollama tersebut sudah masuk untuk akses cloud.
  • Detail selengkapnya: Ollama
  • Key API: menyimpan key untuk Anda.
  • Vercel AI Gateway (proxy multi-model): meminta AI_GATEWAY_API_KEY.
  • Detail selengkapnya: Vercel AI Gateway
  • Cloudflare AI Gateway: meminta Account ID, Gateway ID, dan CLOUDFLARE_AI_GATEWAY_API_KEY.
  • Detail selengkapnya: Cloudflare AI Gateway
  • MiniMax: konfigurasi ditulis otomatis; default hosted adalah MiniMax-M2.7. Penyiapan key API menggunakan minimax/..., dan penyiapan OAuth menggunakan minimax-portal/....
  • Detail selengkapnya: MiniMax
  • StepFun: konfigurasi ditulis otomatis untuk StepFun standar atau Step Plan pada endpoint China atau global.
  • Standar saat ini mencakup step-3.5-flash, dan Step Plan juga mencakup step-3.5-flash-2603.
  • Detail selengkapnya: StepFun
  • Synthetic (kompatibel dengan Anthropic): meminta SYNTHETIC_API_KEY.
  • Detail selengkapnya: Synthetic
  • Moonshot (Kimi K2): konfigurasi ditulis otomatis.
  • Kimi Coding: konfigurasi ditulis otomatis.
  • Detail selengkapnya: Moonshot AI (Kimi + Kimi Coding)
  • Lewati: belum ada auth yang dikonfigurasi.
  • Pilih model default dari opsi yang terdeteksi (atau masukkan penyedia/model secara manual). Untuk kualitas terbaik dan risiko prompt-injection yang lebih rendah, pilih model generasi terbaru terkuat yang tersedia dalam stack penyedia Anda.
  • Onboarding menjalankan pemeriksaan model dan memperingatkan jika model yang dikonfigurasi tidak dikenal atau auth tidak ada.
  • Mode penyimpanan key API default ke nilai profil auth plaintext. Gunakan --secret-input-mode ref untuk menyimpan ref berbasis env sebagai gantinya (misalnya keyRef: { source: "env", provider: "default", id: "OPENAI_API_KEY" }).
  • Profil auth berada di ~/.openclaw/agents/<agentId>/agent/auth-profiles.json (key API + OAuth). ~/.openclaw/credentials/oauth.json hanya untuk impor lama.
  • Detail selengkapnya: /concepts/oauth
Kiat headless/server: selesaikan OAuth pada mesin dengan browser, lalu salin auth-profiles.json agen tersebut (misalnya ~/.openclaw/agents/<agentId>/agent/auth-profiles.json, atau path $OPENCLAW_STATE_DIR/... yang sesuai) ke host gateway. credentials/oauth.json hanya sumber impor lama.
3

Workspace

  • Default ~/.openclaw/workspace (dapat dikonfigurasi).
  • Menginisialisasi file workspace yang diperlukan untuk ritual bootstrap agen.
  • Tata letak workspace lengkap + panduan backup: Workspace agen
4

Gateway

  • Port, bind, mode auth, eksposur tailscale.
  • Rekomendasi auth: pertahankan Token bahkan untuk loopback agar klien WS lokal harus melakukan autentikasi.
  • Dalam mode token, penyiapan interaktif menawarkan:
    • Buat/simpan token plaintext (default)
    • Gunakan SecretRef (opt-in)
    • Quickstart menggunakan ulang SecretRef gateway.auth.token yang ada di penyedia env, file, dan exec untuk probe onboarding/bootstrap dashboard.
    • Jika SecretRef tersebut dikonfigurasi tetapi tidak dapat diselesaikan, onboarding gagal lebih awal dengan pesan perbaikan yang jelas alih-alih menurunkan auth runtime secara diam-diam.
  • Dalam mode password, penyiapan interaktif juga mendukung penyimpanan plaintext atau SecretRef.
  • Path SecretRef token non-interaktif: --gateway-token-ref-env <ENV_VAR>.
    • Memerlukan variabel env yang tidak kosong dalam lingkungan proses onboarding.
    • Tidak dapat digabungkan dengan --gateway-token.
  • Nonaktifkan auth hanya jika Anda sepenuhnya memercayai setiap proses lokal.
  • Bind non-loopback tetap memerlukan auth.
5

Channels

  • WhatsApp: login QR opsional.
  • Telegram: token bot.
  • Discord: token bot.
  • Google Chat: JSON akun layanan + audiens webhook.
  • Mattermost (plugin): token bot + URL dasar.
  • Signal: instalasi signal-cli opsional + konfigurasi akun.
  • iMessage: path CLI imsg + akses DB Messages; gunakan wrapper SSH ketika Gateway berjalan di luar Mac.
  • Keamanan DM: default-nya adalah pairing. DM pertama mengirim kode; setujui melalui openclaw pairing approve <channel> <code> atau gunakan allowlist.
6

Web search

  • Pilih penyedia yang didukung seperti Brave, DuckDuckGo, Exa, Firecrawl, Gemini, Grok, Kimi, MiniMax Search, Ollama Web Search, Perplexity, SearXNG, atau Tavily (atau lewati).
  • Penyedia berbasis API dapat menggunakan variabel env atau konfigurasi yang ada untuk penyiapan cepat; penyedia tanpa key menggunakan prasyarat khusus penyedia masing-masing.
  • Lewati dengan --skip-search.
  • Konfigurasikan nanti: openclaw configure --section web.
7

Daemon install

  • macOS: LaunchAgent
    • Memerlukan sesi pengguna yang sudah login; untuk headless, gunakan LaunchDaemon kustom (tidak disertakan).
  • Linux (dan Windows melalui WSL2): unit pengguna systemd
    • Onboarding mencoba mengaktifkan lingering melalui loginctl enable-linger <user> agar Gateway tetap aktif setelah logout.
    • Dapat meminta sudo (menulis ke /var/lib/systemd/linger); proses mencoba tanpa sudo terlebih dahulu.
  • Pemilihan runtime: Node (direkomendasikan; diperlukan untuk WhatsApp/Telegram). Bun tidak direkomendasikan.
  • Jika auth token memerlukan token dan gateway.auth.token dikelola SecretRef, instalasi daemon memvalidasinya tetapi tidak mempertahankan nilai token plaintext yang terselesaikan ke metadata lingkungan layanan supervisor.
  • Jika auth token memerlukan token dan SecretRef token yang dikonfigurasi tidak terselesaikan, instalasi daemon diblokir dengan panduan yang dapat ditindaklanjuti.
  • Jika gateway.auth.token dan gateway.auth.password sama-sama dikonfigurasi dan gateway.auth.mode belum diatur, instalasi daemon diblokir sampai mode diatur secara eksplisit.
8

Health check

  • Memulai Gateway (jika diperlukan) dan menjalankan openclaw health.
  • Kiat: openclaw status --deep menambahkan probe kesehatan gateway langsung ke output status, termasuk probe channel jika didukung (memerlukan gateway yang dapat dijangkau).
9

Skills (recommended)

  • Membaca skills yang tersedia dan memeriksa persyaratan.
  • Memungkinkan Anda memilih manajer node: npm / pnpm (bun tidak direkomendasikan).
  • Menginstal dependensi opsional (sebagian menggunakan Homebrew di macOS).
10

Finish

  • Ringkasan + langkah berikutnya, termasuk prompt Bagaimana Anda ingin menetaskan agen Anda? untuk Terminal, Browser, atau nanti.
Jika tidak ada GUI yang terdeteksi, onboarding mencetak instruksi port-forward SSH untuk Control UI alih-alih membuka browser. Jika aset Control UI hilang, onboarding mencoba membangunnya; fallback adalah pnpm ui:build (otomatis menginstal dependensi UI).

​
Mode non-interaktif

Gunakan --non-interactive untuk mengotomatiskan atau membuat skrip onboarding: 
openclaw onboard --non-interactive \
  --mode local \
  --auth-choice apiKey \
  --anthropic-api-key "$ANTHROPIC_API_KEY" \
  --gateway-port 18789 \
  --gateway-bind loopback \
  --install-daemon \
  --daemon-runtime node \
  --skip-skills
Tambahkan --json untuk ringkasan yang dapat dibaca mesin. SecretRef token Gateway dalam mode non-interaktif: 
export OPENCLAW_GATEWAY_TOKEN="your-token"
openclaw onboard --non-interactive \
  --mode local \
  --auth-choice skip \
  --gateway-auth token \
  --gateway-token-ref-env OPENCLAW_GATEWAY_TOKEN
--gateway-token dan --gateway-token-ref-env saling eksklusif.
--json tidak menyiratkan mode non-interaktif. Gunakan --non-interactive (dan --workspace) untuk skrip.
Contoh perintah khusus penyedia berada di Otomatisasi CLI. Gunakan halaman referensi ini untuk semantik flag dan urutan langkah.

​
Tambah agen (non-interaktif)

openclaw agents add work \
  --workspace ~/.openclaw/workspace-work \
  --model openai/gpt-5.5 \
  --bind whatsapp:biz \
  --non-interactive \
  --json

​
RPC wizard Gateway

Gateway mengekspos alur onboarding melalui RPC (wizard.start, wizard.next, wizard.cancel, wizard.status). Klien (aplikasi macOS, Control UI) dapat merender langkah tanpa mengimplementasikan ulang logika onboarding.

​
Penyiapan Signal (signal-cli)

Onboarding dapat menginstal signal-cli dari rilis GitHub:
  • Mengunduh aset rilis yang sesuai.
  • Menyimpannya di bawah ~/.openclaw/tools/signal-cli/<version>/.
  • Menulis channels.signal.cliPath ke konfigurasi Anda.
Catatan:
  • Build JVM memerlukan Java 21.
  • Build native digunakan ketika tersedia.
  • Windows menggunakan WSL2; instalasi signal-cli mengikuti alur Linux di dalam WSL.

​
Yang ditulis wizard

Field umum dalam ~/.openclaw/openclaw.json:
  • agents.defaults.workspace
  • agents.defaults.model / models.providers (jika Minimax dipilih)
  • tools.profile (orientasi awal lokal default ke "coding" saat belum diatur; nilai eksplisit yang sudah ada dipertahankan)
  • gateway.* (mode, bind, auth, tailscale)
  • session.dmScope (detail perilaku: Referensi Penyiapan CLI)
  • channels.telegram.botToken, channels.discord.token, channels.matrix.*, channels.signal.*, channels.imessage.*
  • Daftar izin saluran (Slack/Discord/Matrix/Microsoft Teams) saat Anda ikut serta selama prompt (nama diresolusikan ke ID jika memungkinkan).
  • skills.install.nodeManager
    • setup --node-manager menerima npm, pnpm, atau bun.
    • Konfigurasi manual tetap dapat menggunakan yarn dengan mengatur skills.install.nodeManager secara langsung.
  • wizard.lastRunAt
  • wizard.lastRunVersion
  • wizard.lastRunCommit
  • wizard.lastRunCommand
  • wizard.lastRunMode
openclaw agents add menulis agents.list[] dan bindings opsional. Kredensial WhatsApp berada di bawah ~/.openclaw/credentials/whatsapp/<accountId>/. Sesi disimpan di bawah ~/.openclaw/agents/<agentId>/sessions/. Beberapa saluran dikirimkan sebagai plugin. Saat Anda memilih salah satunya selama penyiapan, orientasi awal akan meminta untuk menginstalnya (npm atau path lokal) sebelum dapat dikonfigurasi.

​
Dokumentasi terkait