Referensi penyiapan CLI

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

Apa yang dilakukan wizard

Mode lokal (default) memandu Anda melalui:

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

Mode jarak jauh mengonfigurasi mesin ini untuk terhubung ke gateway di tempat lain. Mode ini tidak menginstal atau mengubah apa pun pada host jarak jauh.

Detail alur lokal

Detail mode jarak jauh

Mode jarak jauh mengonfigurasi mesin ini untuk terhubung ke gateway di tempat lain.

Yang Anda tetapkan:

• URL gateway jarak jauh (ws://...)
• Token jika autentikasi gateway jarak jauh diperlukan (direkomendasikan)

Opsi autentikasi dan model

Perilaku model:

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

Jalur kredensial dan profil:

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

Mode penyimpanan kredensial:

• Perilaku onboarding bawaan menyimpan kunci API sebagai nilai plaintext di profil auth.
• --secret-input-mode ref mengaktifkan mode referensi alih-alih penyimpanan kunci plaintext. Dalam setup interaktif, Anda dapat memilih salah satu:
  • ref variabel lingkungan (misalnya keyRef: { source: "env", provider: "default", id: "OPENAI_API_KEY" })
  • ref penyedia terkonfigurasi (file atau exec) dengan alias penyedia + id
• Mode referensi interaktif menjalankan validasi preflight cepat sebelum menyimpan.
  • Ref env: memvalidasi nama variabel + nilai tidak kosong di lingkungan onboarding saat ini.
  • Ref penyedia: memvalidasi konfigurasi penyedia dan menyelesaikan id yang diminta.
  • Jika preflight gagal, onboarding menampilkan kesalahan dan memungkinkan Anda mencoba lagi.
• Dalam mode non-interaktif, --secret-input-mode ref hanya didukung 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 non-interaktif ref 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 setup interaktif:
  • Mode token: Buat/simpan token plaintext (bawaan) atau Gunakan SecretRef.
  • Mode kata sandi: plaintext atau SecretRef.
• Jalur SecretRef token non-interaktif: --gateway-token-ref-env <ENV_VAR>.
• Setup plaintext yang sudah ada tetap berfungsi tanpa perubahan.

Output dan internal

Field 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 (onboarding lokal secara bawaan menggunakan "coding" saat belum diatur; nilai eksplisit yang sudah ada dipertahankan)
• gateway.* (mode, bind, auth, tailscale)
• session.dmScope (onboarding lokal secara bawaan mengatur ini ke per-channel-peer saat belum diatur; nilai eksplisit yang sudah ada dipertahankan)
• channels.telegram.botToken, channels.discord.token, channels.matrix.*, channels.signal.*, channels.imessage.*
• Allowlist 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
• wizard.securityAcknowledgedAt

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 Control UI) dapat merender langkah tanpa mengimplementasikan ulang logika onboarding.

Perilaku setup 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

Dokumen terkait

• Hub onboarding: Onboarding (CLI)
• Otomatisasi dan skrip: Otomatisasi CLI
• Referensi perintah: openclaw onboard