Referensi penyiapan CLI

Halaman ini adalah referensi lengkap untuk openclaw onboard. Untuk panduan singkat, lihat Onboarding (CLI).

# Yang dilakukan wizard

Mode lokal (default) memandu Anda melalui:

• Penyiapan model dan auth (OAuth langganan OpenAI Code, Anthropic Claude CLI atau API key, plus opsi MiniMax, GLM, Ollama, Moonshot, StepFun, dan AI Gateway)
• Lokasi workspace dan file bootstrap
• Pengaturan Gateway (port, bind, auth, tailscale)
• Channel dan penyedia (Telegram, WhatsApp, Discord, Google Chat, Mattermost, Signal, BlueBubbles, dan Plugin channel bawaan lainnya)
• Instalasi daemon (LaunchAgent, unit pengguna systemd, atau Windows Scheduled Task native dengan fallback folder Startup)
• Health check
• Penyiapan Skills

Mode remote mengonfigurasi mesin ini untuk terhubung ke Gateway di tempat lain. Mode ini tidak menginstal atau mengubah apa pun di host remote.

# Detail alur lokal

# Detail mode remote

Mode remote mengonfigurasi mesin ini untuk terhubung ke Gateway di tempat lain.

Yang Anda atur:

• URL Gateway remote (ws://...)
• Token jika auth Gateway remote diperlukan (direkomendasikan)

# Opsi auth dan model

Perilaku model:

• Pilih model default dari opsi yang terdeteksi, atau masukkan penyedia dan model secara manual.
• Onboarding penyedia kustom menyimpulkan dukungan gambar untuk ID model umum dan hanya bertanya saat nama model tidak diketahui.
• Saat onboarding dimulai dari pilihan auth penyedia, pemilih model otomatis memprioritaskan penyedia tersebut. Untuk Volcengine dan BytePlus, preferensi yang sama juga cocok dengan varian coding-plan mereka (volcengine-plan/*, byteplus-plan/*).
• Jika filter penyedia pilihan tersebut akan kosong, pemilih kembali ke katalog lengkap alih-alih tidak menampilkan model apa pun.
• Wizard menjalankan pemeriksaan model dan memperingatkan jika model yang dikonfigurasi tidak diketahui atau auth hilang.

Jalur kredensial dan profil:

• Profil auth (API key + OAuth): ~/.openclaw/agents/<agentId>/agent/auth-profiles.json
• Impor OAuth legacy: ~/.openclaw/credentials/oauth.json

Mode penyimpanan kredensial:

• Perilaku onboarding default menyimpan API key sebagai nilai plaintext di profil auth.
• --secret-input-mode ref mengaktifkan mode referensi alih-alih penyimpanan kunci plaintext. Dalam penyiapan interaktif, Anda dapat memilih salah satu:
  • ref environment variable (misalnya keyRef: { source: "env", provider: "default", id: "OPENAI_API_KEY" })
  • ref penyedia yang dikonfigurasi (file atau exec) dengan alias penyedia + id
• Mode referensi interaktif menjalankan validasi preflight cepat sebelum menyimpan.
  • Env refs: memvalidasi nama variabel + nilai tidak kosong di lingkungan onboarding saat ini.
  • Provider refs: memvalidasi konfigurasi penyedia dan menyelesaikan id yang diminta.
  • Jika preflight gagal, onboarding menampilkan error dan memungkinkan Anda mencoba lagi.
• Dalam mode non-interaktif, --secret-input-mode ref hanya berbasis env.
  • Atur env var penyedia di lingkungan proses onboarding.
  • Flag kunci inline (misalnya --openai-api-key) mengharuskan env var tersebut diatur; jika tidak, onboarding gagal cepat.
  • Untuk penyedia kustom, mode ref non-interaktif menyimpan models.providers.<id>.apiKey sebagai { source: "env", provider: "default", id: "CUSTOM_API_KEY" }.
  • Dalam kasus penyedia kustom tersebut, --custom-api-key mengharuskan CUSTOM_API_KEY diatur; jika tidak, onboarding gagal cepat.
• Kredensial auth Gateway mendukung pilihan plaintext dan SecretRef dalam penyiapan interaktif:
  • Mode token: Buat/simpan token plaintext (default) atau Gunakan SecretRef.
  • Mode kata sandi: plaintext atau SecretRef.
• Jalur SecretRef token non-interaktif: --gateway-token-ref-env <ENV_VAR>.
• Penyiapan plaintext yang sudah ada tetap berfungsi tanpa perubahan.

# Keluaran dan internal

Bidang umum di ~/.openclaw/openclaw.json:

• agents.defaults.workspace
• agents.defaults.skipBootstrap saat --skip-bootstrap diteruskan
• agents.defaults.model / models.providers (jika Minimax dipilih)
• tools.profile (penyiapan awal lokal menggunakan default "coding" saat belum diatur; nilai eksplisit yang sudah ada dipertahankan)
• gateway.* (mode, bind, auth, tailscale)
• session.dmScope (penyiapan awal lokal menggunakan default per-channel-peer saat belum diatur; nilai eksplisit yang sudah ada dipertahankan)
• channels.telegram.botToken, channels.discord.token, channels.matrix.*, channels.signal.*, channels.imessage.*
• Daftar izin channel (Slack, Discord, Matrix, Microsoft Teams) saat Anda ikut serta selama prompt (nama diselesaikan menjadi ID jika memungkinkan)
• skills.install.nodeManager
  • Flag setup --node-manager menerima npm, pnpm, atau bun.
  • Konfigurasi manual tetap dapat mengatur skills.install.nodeManager: "yarn" nanti.
• wizard.lastRunAt
• wizard.lastRunVersion
• wizard.lastRunCommit
• wizard.lastRunCommand
• wizard.lastRunMode

openclaw agents add menulis agents.list[] dan bindings opsional.

Kredensial WhatsApp ditempatkan di bawah ~/.openclaw/credentials/whatsapp/<accountId>/. Sesi disimpan di bawah ~/.openclaw/agents/<agentId>/sessions/.

RPC wizard Gateway:

• wizard.start
• wizard.next
• wizard.cancel
• wizard.status

Klien (aplikasi macOS dan UI Kontrol) dapat merender langkah-langkah tanpa mengimplementasikan ulang logika penyiapan awal.

Perilaku penyiapan Signal:

• Mengunduh aset rilis yang sesuai
• Menyimpannya di bawah ~/.openclaw/tools/signal-cli/<version>/
• Menulis channels.signal.cliPath dalam konfigurasi
• Build JVM memerlukan Java 21
• Build native digunakan saat tersedia
• Windows menggunakan WSL2 dan mengikuti alur signal-cli Linux di dalam WSL

# Dokumentasi terkait

• Pusat penyiapan awal: Penyiapan Awal (CLI)
• Otomatisasi dan skrip: Otomatisasi CLI
• Referensi perintah: openclaw onboard