Referensi penyiapan CLI

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.

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 autentikasi (OAuth langganan OpenAI Code, Anthropic Claude CLI atau kunci API, serta opsi MiniMax, GLM, Ollama, Moonshot, StepFun, dan AI Gateway)
• Lokasi workspace dan file bootstrap
• Pengaturan Gateway (port, bind, autentikasi, tailscale)
• Kanal dan penyedia (Telegram, WhatsApp, Discord, Google Chat, Mattermost, Signal, iMessage, dan Plugin kanal 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 penyedia dan model secara manual.
• Onboarding penyedia kustom menyimpulkan dukungan gambar untuk ID model umum dan hanya bertanya saat nama model tidak dikenal.
• Saat onboarding dimulai dari pilihan autentikasi penyedia, pemilih model lebih mengutamakan penyedia tersebut secara otomatis. 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 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 lama: ~/.openclaw/credentials/oauth.json

Mode penyimpanan kredensial:

• Perilaku onboarding default mempertahankan kunci API sebagai nilai teks biasa di profil autentikasi.
• --secret-input-mode ref mengaktifkan mode referensi alih-alih penyimpanan kunci teks biasa. Dalam penyiapan interaktif, Anda dapat memilih salah satu:
  • ref variabel lingkungan (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.
  • Ref env: memvalidasi nama variabel + nilai tidak kosong di lingkungan onboarding saat ini.
  • Ref penyedia: memvalidasi konfigurasi penyedia dan me-resolve id yang diminta.
  • Jika preflight gagal, onboarding menampilkan kesalahan dan memungkinkan Anda mencoba lagi.
• Dalam mode non-interaktif, --secret-input-mode ref hanya berbasis env.
  • Tetapkan variabel env penyedia di lingkungan proses onboarding.
  • Flag kunci inline (misalnya --openai-api-key) mengharuskan variabel env 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 autentikasi Gateway mendukung pilihan teks biasa dan SecretRef dalam penyiapan interaktif:
  • Mode token: Buat/simpan token teks biasa (default) atau Gunakan SecretRef.
  • Mode kata sandi: teks biasa atau SecretRef.
• Jalur SecretRef token non-interaktif: --gateway-token-ref-env <ENV_VAR>.
• Penyiapan teks biasa yang ada tetap berfungsi tanpa perubahan.

​

Output dan internal

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

• agents.defaults.workspace
• agents.defaults.skipBootstrap ketika --skip-bootstrap diteruskan
• agents.defaults.model / models.providers (jika Minimax dipilih)
• tools.profile (onboarding lokal default ke "coding" ketika belum diatur; nilai eksplisit yang sudah ada dipertahankan)
• gateway.* (mode, bind, auth, tailscale)
• session.dmScope (onboarding lokal default ke per-channel-peer ketika belum diatur; nilai eksplisit yang sudah ada dipertahankan)
• channels.telegram.botToken, channels.discord.token, channels.matrix.*, channels.signal.*, channels.imessage.*
• Allowlist saluran (Slack, Discord, Matrix, Microsoft Teams) ketika Anda ikut serta selama prompt (nama diresolusikan ke ID jika memungkinkan)
• skills.install.nodeManager
  • Flag setup --node-manager menerima npm, pnpm, atau bun.
  • Konfigurasi manual masih 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 Control UI) dapat merender langkah tanpa mengimplementasikan ulang logika onboarding. 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 ketika tersedia
• Windows menggunakan WSL2 dan mengikuti alur signal-cli Linux di dalam WSL

​

Dokumen Terkait

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