Referensi penyiapan CLI

Halaman ini membahas perilaku, keluaran, dan komponen internal orientasi secara langkah demi langkah. Untuk panduan, lihat Orientasi (CLI). Untuk referensi lengkap flag CLI (setiap --flag, contoh noninteraktif, perintah khusus penyedia), lihat openclaw onboard.

Yang dilakukan wizard

Mode lokal (default) memandu Anda melalui:

• Penyiapan model dan autentikasi (Anthropic, OAuth langganan OpenAI Code, xAI, OpenCode, endpoint kustom, dan alur autentikasi lain yang dimiliki penyedia)
• Lokasi ruang kerja dan file bootstrap
• Pengaturan Gateway (port, bind, autentikasi, Tailscale)
• Kanal dan penyedia (Discord, Feishu, Google Chat, iMessage, Mattermost, Microsoft Teams, QQ Bot, Signal, Slack, Telegram, WhatsApp, serta kanal bawaan atau Plugin lainnya)
• Penyedia pencarian web (opsional)
• 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 agar terhubung ke Gateway di lokasi 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 agar terhubung ke Gateway di lokasi lain. Mode ini tidak menginstal atau mengubah apa pun pada host jarak jauh.

Yang Anda tetapkan:

• URL gateway jarak jauh (ws://... atau wss://...)
• Token, kata sandi, atau tanpa autentikasi, sesuai dengan konfigurasi Gateway jarak jauh

Opsi autentikasi dan model

Jika langkah penyiapan penyedia gagal selama orientasi interaktif (misalnya opsi penggunaan ulang CLI tanpa login lokal), wizard menampilkan kesalahan dan kembali ke pemilih penyedia alih-alih keluar. Proses --auth-choice eksplisit tetap langsung gagal untuk otomatisasi.

Perilaku model:

• Pilih model default dari opsi yang terdeteksi, atau masukkan penyedia dan model secara manual.
• Saat orientasi dimulai dari pilihan autentikasi penyedia, pemilih model secara otomatis memprioritaskan penyedia tersebut. Untuk Volcengine dan BytePlus, preferensi yang sama juga mencocokkan varian paket coding mereka (volcengine-plan/*, byteplus-plan/*).
• Jika filter penyedia pilihan tersebut tidak menghasilkan apa pun, pemilih kembali menggunakan katalog lengkap agar tidak menampilkan daftar model kosong.
• Wizard menjalankan pemeriksaan model dan memperingatkan jika model yang dikonfigurasi tidak dikenal atau autentikasinya tidak tersedia.

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 orientasi default mempertahankan kunci API sebagai nilai teks biasa dalam profil autentikasi.
• --secret-input-mode ref mengaktifkan mode referensi sebagai pengganti penyimpanan kunci dalam teks biasa. Dalam penyiapan interaktif, Anda dapat memilih salah satu:
  • referensi variabel lingkungan (misalnya keyRef: { source: "env", provider: "default", id: "OPENAI_API_KEY" })
  • referensi penyedia yang dikonfigurasi (file atau exec) dengan alias penyedia + id
• Mode referensi interaktif menjalankan validasi pra-pemeriksaan cepat sebelum menyimpan.
  • Referensi env: memvalidasi nama variabel + nilai yang tidak kosong dalam lingkungan orientasi saat ini.
  • Referensi penyedia: memvalidasi konfigurasi penyedia dan me-resolve id yang diminta.
  • Jika pra-pemeriksaan gagal, orientasi menampilkan kesalahan dan memungkinkan Anda mencoba lagi.
• Dalam mode noninteraktif, --secret-input-mode ref hanya didukung oleh env.
  • Tetapkan variabel env penyedia dalam lingkungan proses orientasi.
  • Flag kunci sebaris (misalnya --openai-api-key) mengharuskan variabel env tersebut ditetapkan; jika tidak, orientasi segera gagal.
  • Untuk penyedia khusus, mode noninteraktif ref menyimpan models.providers.<id>.apiKey sebagai { source: "env", provider: "default", id: "CUSTOM_API_KEY" }.
  • Dalam kasus penyedia khusus tersebut, --custom-api-key mengharuskan CUSTOM_API_KEY ditetapkan; jika tidak, orientasi segera gagal.
• Kredensial autentikasi Gateway mendukung pilihan teks biasa dan SecretRef dalam penyiapan interaktif:
  • Mode token: Buat/simpan token dalam teks biasa (default) atau Gunakan SecretRef.
  • Mode kata sandi: teks biasa atau SecretRef.
• Jalur SecretRef token noninteraktif: --gateway-token-ref-env <ENV_VAR>.
• Penyiapan teks biasa yang sudah ada tetap berfungsi tanpa perubahan.

Output dan internal

Kolom umum dalam ~/.openclaw/openclaw.json:

• agents.defaults.workspace
• agents.defaults.skipBootstrap saat --skip-bootstrap diteruskan
• agents.defaults.model / models.providers (jika Minimax dipilih)
• tools.profile (orientasi lokal menggunakan default "coding" saat tidak ditetapkan; nilai eksplisit yang sudah ada dipertahankan)
• gateway.* (mode, pengikatan, autentikasi, tailscale)
• session.dmScope (orientasi mempertahankan nilai eksplisit dan jika tidak ada membiarkannya tidak ditetapkan, sehingga default main mempertahankan semua pesan langsung lintas saluran dalam sesi utama bergulir milik agen—default agen pribadi. Untuk kotak masuk bersama atau multipengguna, gunakan per-channel-peer; openclaw security audit merekomendasikan isolasi saat mendeteksi lalu lintas pesan langsung multipengguna)
• channels.telegram.botToken, channels.discord.token, channels.matrix.*, channels.signal.*, channels.imessage.*
• Daftar izin saluran (Discord, iMessage, Signal, Slack, Telegram, WhatsApp) saat Anda memilih ikut serta selama prompt; Discord dan Slack juga me-resolve nama yang dimasukkan menjadi ID
• skills.install.nodeManager
  • Flag setup --node-manager menerima npm, pnpm, atau bun.
  • Konfigurasi manual masih dapat menetapkan 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 aktif dan transkrip disimpan di ~/.openclaw/agents/<agentId>/agent/openclaw-agent.sqlite. Direktori ~/.openclaw/agents/<agentId>/sessions/ digunakan untuk input migrasi lama serta artefak arsip/dukungan.

Rekomendasi aplikasi yang terinstal

Setelah pemeriksaan akses model berhasil, orientasi interaktif klasik di macOS memindai nama aplikasi dan ID bundel tanpa meminta izin privasi macOS. Orientasi tersebut mencari katalog plugin resmi dan ClawHub, lalu meminta model yang dikonfigurasi untuk menolak kecocokan nama palsu dan merekomendasikan plugin atau skills yang relevan. Kecocokan yang direkomendasikan dipilih secara default; kecocokan opsional memerlukan pemilihan eksplisit.

Layar hasil mencantumkan aplikasi yang terdeteksi dan menampilkan: "Nama aplikasi dicocokkan menggunakan model yang Anda konfigurasi dan pencarian ClawHub." Tetapkan wizard.appRecommendations ke false untuk menonaktifkan langkah orientasi ini sekaligus akses Gateway ke inventaris aplikasi node. Pemindaian tidak digunakan dalam mulai cepat atau orientasi non-macOS.

Penyiapan noninteraktif

--non-interactive memerlukan --accept-risk (menyatakan pemahaman bahwa agen sangat canggih dan akses penuh ke sistem berisiko):

openclaw onboard --non-interactive --accept-risk \  --auth-choice apiKey \  --anthropic-api-key "$ANTHROPIC_API_KEY"

Referensi flag lengkap dan contoh khusus penyedia: openclaw onboard, Otomatisasi CLI.

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 orientasi.

Perilaku penyiapan Signal

• Mengunduh aset rilis yang sesuai dari rilis GitHub resmi signal-cli (build native, hanya Linux x86-64)
• Pada platform lain (macOS, Linux non-x64), memasang melalui Homebrew sebagai gantinya
• Menyimpan pemasangan aset rilis di bawah ~/.openclaw/tools/signal-cli/<version>/
• Menulis channels.signal.cliPath dalam konfigurasi
• Windows native belum didukung; jalankan orientasi di dalam WSL2 untuk mendapatkan jalur pemasangan Linux

Dokumentasi terkait

• Pusat orientasi: Orientasi (CLI)
• Otomatisasi dan skrip: Otomatisasi CLI
• Referensi perintah: openclaw onboard