openclaw onboard.
Per la guida breve, consulta Onboarding (CLI).
Cosa fa la procedura guidata
La modalità locale (predefinita) ti guida attraverso:- Configurazione del modello e dell’autenticazione (OAuth dell’abbonamento OpenAI Code, Anthropic Claude CLI o chiave API, più opzioni MiniMax, GLM, Ollama, Moonshot, StepFun e AI Gateway)
- Posizione dell’area di lavoro e file di bootstrap
- Impostazioni del Gateway (porta, bind, autenticazione, Tailscale)
- Canali e provider (Telegram, WhatsApp, Discord, Google Chat, Mattermost, Signal, iMessage e altri plugin di canale inclusi)
- Installazione del demone (LaunchAgent, unità utente systemd o attività pianificata nativa di Windows con fallback alla cartella Esecuzione automatica)
- Controllo di integrità
- Configurazione di Skills
Dettagli del flusso locale
Rilevamento della configurazione esistente
- Se
~/.openclaw/openclaw.jsonesiste, scegli Mantieni, Modifica o Reimposta. - Rieseguire la procedura guidata non cancella nulla a meno che tu non scelga esplicitamente Reimposta (o passi
--reset). - CLI
--resetusa come valore predefinitoconfig+creds+sessions; usa--reset-scope fullper rimuovere anche l’area di lavoro. - Se la configurazione non è valida o contiene chiavi legacy, la procedura guidata si interrompe e ti chiede di eseguire
openclaw doctorprima di continuare. - La reimpostazione usa
trashe offre ambiti:- Solo configurazione
- Configurazione + credenziali + sessioni
- Reimpostazione completa (rimuove anche l’area di lavoro)
Modello e autenticazione
- La matrice completa delle opzioni è in Opzioni di autenticazione e modello.
Area di lavoro
- Predefinita
~/.openclaw/workspace(configurabile). - Inizializza i file dell’area di lavoro necessari per il rituale di bootstrap al primo avvio.
- Layout dell’area di lavoro: Area di lavoro dell’agente.
Gateway
- Chiede porta, bind, modalità di autenticazione ed esposizione Tailscale.
- Consigliato: mantieni abilitata l’autenticazione con token anche per loopback, così i client WS locali devono autenticarsi.
- In modalità token, la configurazione interattiva offre:
- Genera/archivia token in testo in chiaro (predefinito)
- Usa SecretRef (opt-in)
- In modalità password, la configurazione interattiva supporta anche archiviazione in testo in chiaro o SecretRef.
- Percorso SecretRef token non interattivo:
--gateway-token-ref-env <ENV_VAR>.- Richiede una variabile d’ambiente non vuota nell’ambiente del processo di onboarding.
- Non può essere combinato con
--gateway-token.
- Disabilita l’autenticazione solo se ti fidi completamente di ogni processo locale.
- I bind non loopback richiedono comunque autenticazione.
Canali
- WhatsApp: accesso QR facoltativo
- Telegram: token del bot
- Discord: token del bot
- Google Chat: JSON dell’account di servizio + audience del webhook
- Mattermost: token del bot + URL di base
- Signal: installazione facoltativa di
signal-cli+ configurazione dell’account - iMessage: percorso CLI
imsg+ accesso al DB Messaggi; usa un wrapper SSH quando il Gateway viene eseguito fuori dal Mac - Sicurezza DM: il valore predefinito è l’associazione. Il primo DM invia un codice; approva tramite
openclaw pairing approve <channel> <code>oppure usa allowlist.
Installazione del demone
- macOS: LaunchAgent
- Richiede una sessione utente attiva; per headless, usa un LaunchDaemon personalizzato (non distribuito).
- Linux e Windows tramite WSL2: unità utente systemd
- La procedura guidata tenta
loginctl enable-linger <user>così il gateway resta attivo dopo il logout. - Potrebbe chiedere sudo (scrive in
/var/lib/systemd/linger); prova prima senza sudo.
- La procedura guidata tenta
- Windows nativo: prima Attività pianificata
- Se la creazione dell’attività viene negata, OpenClaw ripiega su un elemento di accesso per utente nella cartella Esecuzione automatica e avvia subito il gateway.
- Le Attività pianificate restano preferite perché forniscono uno stato del supervisore migliore.
- Selezione runtime: Node (consigliato; richiesto per WhatsApp e Telegram). Bun non è consigliato.
Controllo di integrità
- Avvia il gateway (se necessario) ed esegue
openclaw health. openclaw status --deepaggiunge il probe di integrità del gateway live all’output di stato, inclusi i probe dei canali quando supportati.
Skills
- Legge le skill disponibili e verifica i requisiti.
- Ti consente di scegliere il gestore Node: npm, pnpm o bun.
- Installa le dipendenze facoltative per le skill incluse attendibili quando il programma di installazione richiesto è disponibile.
- Salta i programmi di installazione Homebrew, uv e Go non disponibili, poi raggruppa le skill interessate
con indicazioni per la configurazione manuale. Esegui
openclaw doctordopo aver installato i prerequisiti mancanti.
Se non viene rilevata alcuna GUI, la procedura guidata stampa le istruzioni di port forwarding SSH per la Control UI invece di aprire un browser.
Se gli asset della Control UI mancano, la procedura guidata tenta di compilarli; il fallback è
pnpm ui:build (installa automaticamente le dipendenze della UI).Dettagli della modalità remota
La modalità remota configura questa macchina per connettersi a un gateway altrove.La modalità remota non installa né modifica nulla sull’host remoto.
- URL del gateway remoto (
ws://...) - Token se l’autenticazione del gateway remoto è richiesta (consigliato)
- Se il gateway è solo loopback, usa tunneling SSH o una tailnet.
- Suggerimenti per il rilevamento:
- macOS: Bonjour (
dns-sd) - Linux: Avahi (
avahi-browse)
- macOS: Bonjour (
Opzioni di autenticazione e modello
Chiave API Anthropic
Chiave API Anthropic
Usa
ANTHROPIC_API_KEY se presente o chiede una chiave, poi la salva per l’uso del demone.Abbonamento OpenAI Code (OAuth)
Abbonamento OpenAI Code (OAuth)
Flusso browser; incolla
code#state.Imposta agents.defaults.model su openai/gpt-5.5 tramite il runtime Codex quando il modello non è impostato o appartiene già alla famiglia OpenAI.Abbonamento OpenAI Code (associazione dispositivo)
Abbonamento OpenAI Code (associazione dispositivo)
Flusso di associazione browser con un codice dispositivo a breve durata.Imposta
agents.defaults.model su openai/gpt-5.5 tramite il runtime Codex quando il modello non è impostato o appartiene già alla famiglia OpenAI.Chiave API OpenAI
Chiave API OpenAI
Usa
OPENAI_API_KEY se presente o chiede una chiave, poi archivia la credenziale nei profili di autenticazione.Imposta agents.defaults.model su openai/gpt-5.5 quando il modello non è impostato, è openai/* o sono riferimenti a modelli Codex legacy.xAI (Grok) OAuth
xAI (Grok) OAuth
Accesso tramite browser per account SuperGrok o X Premium idonei. Questo è il
percorso xAI consigliato per la maggior parte degli utenti. OpenClaw archivia il profilo
di autenticazione risultante per i modelli Grok, Grok
web_search, x_search e code_execution.xAI (Grok) codice dispositivo
xAI (Grok) codice dispositivo
Accesso tramite browser adatto al remoto con un codice breve invece di una callback
localhost. Usalo da host SSH, Docker o VPS.
xAI (Grok) chiave API
xAI (Grok) chiave API
Chiede
XAI_API_KEY e configura xAI come provider di modelli. Usalo
quando vuoi una chiave API della Console xAI invece dell’OAuth dell’abbonamento.OpenCode
OpenCode
Chiede
OPENCODE_API_KEY (o OPENCODE_ZEN_API_KEY) e ti consente di scegliere il catalogo Zen o Go.
URL di configurazione: opencode.ai/auth.Chiave API (generica)
Chiave API (generica)
Archivia la chiave per te.
Vercel AI Gateway
Vercel AI Gateway
Chiede
AI_GATEWAY_API_KEY.
Maggiori dettagli: Vercel AI Gateway.Cloudflare AI Gateway
Cloudflare AI Gateway
Chiede ID account, ID gateway e
CLOUDFLARE_AI_GATEWAY_API_KEY.
Maggiori dettagli: Cloudflare AI Gateway.MiniMax
MiniMax
La configurazione viene scritta automaticamente. Il valore predefinito hosted è
MiniMax-M3; la configurazione con chiave API usa
minimax/..., mentre la configurazione OAuth usa minimax-portal/....
Maggiori dettagli: MiniMax.StepFun
StepFun
La configurazione viene scritta automaticamente per StepFun standard o Step Plan su endpoint Cina o globali.
Standard attualmente include
step-3.5-flash, e Step Plan include anche step-3.5-flash-2603.
Maggiori dettagli: StepFun.Synthetic (compatibile con Anthropic)
Synthetic (compatibile con Anthropic)
Chiede
SYNTHETIC_API_KEY.
Maggiori dettagli: Synthetic.Ollama (cloud e modelli aperti locali)
Ollama (cloud e modelli aperti locali)
Chiede prima
Cloud + Local, Cloud only o Local only.
Cloud only usa OLLAMA_API_KEY con https://ollama.com.
Le modalità supportate da host chiedono l’URL di base (predefinito http://127.0.0.1:11434), rilevano i modelli disponibili e suggeriscono valori predefiniti.
Cloud + Local verifica anche se quell’host Ollama ha effettuato l’accesso per l’accesso cloud.
Maggiori dettagli: Ollama.Moonshot e Kimi Coding
Moonshot e Kimi Coding
Le configurazioni Moonshot (Kimi K2) e Kimi Coding vengono scritte automaticamente.
Maggiori dettagli: Moonshot AI (Kimi + Kimi Coding).
Provider personalizzato
Provider personalizzato
Funziona con endpoint compatibili con OpenAI e compatibili con Anthropic.L’onboarding interattivo supporta le stesse scelte di archiviazione delle chiavi API degli altri flussi di chiave API dei provider:
- Incolla ora la chiave API (testo in chiaro)
- Usa riferimento segreto (riferimento env o riferimento provider configurato, con validazione preflight)
--auth-choice custom-api-key--custom-base-url--custom-model-id--custom-api-key(facoltativo; ripiega suCUSTOM_API_KEY)--custom-provider-id(facoltativo)--custom-compatibility <openai|openai-responses|anthropic>(facoltativo; predefinitoopenai)--custom-image-input/--custom-text-input(facoltativo; sovrascrive la capacità di input del modello dedotta)
Salta
Salta
Lascia l’autenticazione non configurata.
- Scegli il modello predefinito dalle opzioni rilevate oppure inserisci manualmente provider e modello.
- L’onboarding del provider personalizzato deduce il supporto per immagini per gli ID modello comuni e chiede solo quando il nome del modello è sconosciuto.
- Quando l’onboarding parte da una scelta di autenticazione del provider, il selettore di modello preferisce
automaticamente quel provider. Per Volcengine e BytePlus, la stessa preferenza
corrisponde anche alle loro varianti di piano coding (
volcengine-plan/*,byteplus-plan/*). - Se quel filtro per provider preferito fosse vuoto, il selettore ripiega sul catalogo completo invece di non mostrare alcun modello.
- La procedura guidata esegue un controllo del modello e avvisa se il modello configurato è sconosciuto o manca l’autenticazione.
- Profili di autenticazione (chiavi API + OAuth):
~/.openclaw/agents/<agentId>/agent/auth-profiles.json - Importazione OAuth legacy:
~/.openclaw/credentials/oauth.json
- Il comportamento di onboarding predefinito persiste le chiavi API come valori in testo normale nei profili di autenticazione.
--secret-input-mode refabilita la modalità di riferimento invece dell’archiviazione della chiave in testo normale. Nella configurazione interattiva, puoi scegliere:- riferimento a variabile d’ambiente (ad esempio
keyRef: { source: "env", provider: "default", id: "OPENAI_API_KEY" }) - riferimento a provider configurato (
fileoexec) con alias del provider + id
- riferimento a variabile d’ambiente (ad esempio
- La modalità di riferimento interattiva esegue una rapida validazione preliminare prima del salvataggio.
- Riferimenti env: valida il nome della variabile + valore non vuoto nell’ambiente di onboarding corrente.
- Riferimenti provider: valida la configurazione del provider e risolve l’id richiesto.
- Se la validazione preliminare non riesce, l’onboarding mostra l’errore e ti consente di riprovare.
- In modalità non interattiva,
--secret-input-mode refè supportato solo da env.- Imposta la variabile d’ambiente del provider nell’ambiente del processo di onboarding.
- I flag di chiave inline (ad esempio
--openai-api-key) richiedono che quella variabile d’ambiente sia impostata; altrimenti l’onboarding fallisce rapidamente. - Per provider personalizzati, la modalità non interattiva
refarchiviamodels.providers.<id>.apiKeycome{ source: "env", provider: "default", id: "CUSTOM_API_KEY" }. - In quel caso di provider personalizzato,
--custom-api-keyrichiede cheCUSTOM_API_KEYsia impostata; altrimenti l’onboarding fallisce rapidamente.
- Le credenziali di autenticazione del Gateway supportano scelte in testo normale e SecretRef nella configurazione interattiva:
- Modalità token: Genera/archivia token in testo normale (predefinita) o Usa SecretRef.
- Modalità password: testo normale o SecretRef.
- Percorso SecretRef token non interattivo:
--gateway-token-ref-env <ENV_VAR>. - Le configurazioni esistenti in testo normale continuano a funzionare senza modifiche.
Suggerimento per headless e server: completa OAuth su una macchina con un browser, poi copia
l’
auth-profiles.json di quell’agente (ad esempio
~/.openclaw/agents/<agentId>/agent/auth-profiles.json, o il percorso corrispondente
$OPENCLAW_STATE_DIR/...) sull’host del gateway. credentials/oauth.json
è solo una sorgente di importazione legacy.Output e dettagli interni
Campi tipici in~/.openclaw/openclaw.json:
agents.defaults.workspaceagents.defaults.skipBootstrapquando viene passato--skip-bootstrapagents.defaults.model/models.providers(se viene scelto Minimax)tools.profile(l’onboarding locale usa per impostazione predefinita"coding"quando non è impostato; i valori espliciti esistenti vengono preservati)gateway.*(modalità, bind, autenticazione, tailscale)session.dmScope(l’onboarding locale imposta questo valore predefinito super-channel-peerquando non è impostato; i valori espliciti esistenti vengono preservati)channels.telegram.botToken,channels.discord.token,channels.matrix.*,channels.signal.*,channels.imessage.*- Allowlist dei canali (Slack, Discord, Matrix, Microsoft Teams) quando accetti durante i prompt (i nomi vengono risolti in ID quando possibile)
skills.install.nodeManager- Il flag
setup --node-manageraccettanpm,pnpmobun. - La configurazione manuale può comunque impostare
skills.install.nodeManager: "yarn"in seguito.
- Il flag
wizard.lastRunAtwizard.lastRunVersionwizard.lastRunCommitwizard.lastRunCommandwizard.lastRunModewizard.securityAcknowledgedAt
openclaw agents add scrive agents.list[] e bindings facoltativi.
Le credenziali WhatsApp vanno in ~/.openclaw/credentials/whatsapp/<accountId>/.
Le sessioni sono archiviate in ~/.openclaw/agents/<agentId>/sessions/.
Alcuni canali vengono distribuiti come Plugin. Quando selezionati durante la configurazione, la procedura guidata
chiede di installare il Plugin (npm o percorso locale) prima della configurazione del canale.
wizard.startwizard.nextwizard.cancelwizard.status
- Scarica l’asset di release appropriato
- Lo archivia in
~/.openclaw/tools/signal-cli/<version>/ - Scrive
channels.signal.cliPathnella configurazione - Le build JVM richiedono Java 21
- Le build native vengono usate quando disponibili
- Windows usa WSL2 e segue il flusso signal-cli Linux dentro WSL
Documentazione correlata
- Hub di onboarding: Onboarding (CLI)
- Automazione e script: Automazione CLI
- Riferimento dei comandi:
openclaw onboard