Questa pagina è il riferimento completo perDocumentation Index
Fetch the complete documentation index at: https://docs.openclaw.ai/llms.txt
Use this file to discover all available pages before exploring further.
openclaw onboard.
Per la guida breve, vedi Onboarding (CLI).
Cosa fa la procedura guidata
La modalità locale (predefinita) ti guida attraverso:- Configurazione di modello e autenticazione (OAuth per abbonamento OpenAI Code, CLI o chiave API Anthropic Claude, più opzioni MiniMax, GLM, Ollama, Moonshot, StepFun e AI Gateway)
- Posizione del workspace 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 daemon (LaunchAgent, unità utente systemd o Scheduled Task nativo di Windows con fallback alla cartella Startup)
- 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 elimina nulla a meno che tu non scelga esplicitamente Reimposta (o passi
--reset). - CLI
--resetusa come predefinitoconfig+creds+sessions; usa--reset-scope fullper rimuovere anche il workspace. - 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 questi ambiti:- Solo configurazione
- Configurazione + credenziali + sessioni
- Reimpostazione completa (rimuove anche il workspace)
Modello e autenticazione
- La matrice completa delle opzioni è in Opzioni di autenticazione e modello.
Workspace
- Predefinito
~/.openclaw/workspace(configurabile). - Inizializza i file del workspace necessari per il rituale di bootstrap al primo avvio.
- Layout del workspace: Workspace dell’agente.
Gateway
- Chiede porta, bind, modalità di autenticazione ed esposizione Tailscale.
- Consigliato: mantieni l’autenticazione con token abilitata anche per il loopback, così i client WS locali devono autenticarsi.
- In modalità token, la configurazione interattiva offre:
- Genera/memorizza token in testo semplice (predefinito)
- Usa SecretRef (opt-in)
- In modalità password, la configurazione interattiva supporta anche l’archiviazione in testo semplice o SecretRef.
- Percorso SecretRef token non interattivo:
--gateway-token-ref-env <ENV_VAR>.- Richiede una variabile env 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 l’autenticazione.
Canali
- WhatsApp: accesso QR opzionale
- 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 opzionale di
signal-cli+ configurazione dell’account - iMessage: percorso CLI
imsg+ accesso al DB di Messages; usa un wrapper SSH quando il Gateway viene eseguito fuori dal Mac - Sicurezza DM: l’impostazione predefinita è l’abbinamento. Il primo DM invia un codice; approva tramite
openclaw pairing approve <channel> <code>oppure usa allowlist.
Installazione del daemon
- macOS: LaunchAgent
- Richiede una sessione utente con accesso effettuato; per headless, usa un LaunchDaemon personalizzato (non distribuito).
- Linux e Windows tramite WSL2: unità utente systemd
- La procedura guidata tenta
loginctl enable-linger <user>in modo che il Gateway resti attivo dopo il logout. - Potrebbe chiedere sudo (scrive in
/var/lib/systemd/linger); prova prima senza sudo.
- La procedura guidata tenta
- Windows nativo: prima Scheduled Task
- Se la creazione del task viene negata, OpenClaw ripiega su un elemento di accesso nella cartella Startup per utente e avvia subito il Gateway.
- Scheduled Tasks restano preferiti 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 la sonda di integrità live del Gateway all’output di stato, incluse le sonde dei canali quando supportate.
Skills
- Legge le Skills disponibili e controlla i requisiti.
- Ti consente di scegliere il gestore Node: npm, pnpm o bun.
- Installa dipendenze opzionali (alcune usano Homebrew su macOS).
Se non viene rilevata alcuna GUI, la procedura guidata stampa 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 generarli; il fallback è
pnpm ui:build (installa automaticamente le dipendenze 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 di discovery:
- 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, quindi la salva per l’uso del daemon.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 (abbinamento dispositivo)
Abbonamento OpenAI Code (abbinamento dispositivo)
Flusso di abbinamento browser con un codice dispositivo di 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, quindi memorizza la credenziale nei profili di autenticazione.Imposta agents.defaults.model su openai/gpt-5.5 quando il modello non è impostato, è openai/* o openai-codex/*.Chiave API xAI (Grok)
Chiave API xAI (Grok)
Chiede
XAI_API_KEY e configura xAI come provider di modelli.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)
Memorizza 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 default hosted è
MiniMax-M2.7; 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 open locali)
Ollama (Cloud e modelli open 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 controlla 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 opzioni di archiviazione della chiave API degli altri flussi con chiave API del provider:
- Incolla ora la chiave API (testo semplice)
- Usa riferimento a secret (riferimento env o riferimento provider configurato, con convalida preflight)
--auth-choice custom-api-key--custom-base-url--custom-model-id--custom-api-key(opzionale; fallback aCUSTOM_API_KEY)--custom-provider-id(opzionale)--custom-compatibility <openai|anthropic>(opzionale; predefinitoopenai)--custom-image-input/--custom-text-input(opzionale; sovrascrive la capacità di input del modello dedotta)
Salta
Salta
Lascia l’autenticazione non configurata.
- Scegli il modello predefinito dalle opzioni rilevate oppure inserisci provider e modello manualmente.
- L’onboarding del provider personalizzato deduce il supporto 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 rispettive varianti coding-plan (
volcengine-plan/*,byteplus-plan/*). - Se quel filtro del provider preferito risultasse 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 predefinito dell’onboarding persiste le chiavi API come valori in testo semplice nei profili di autenticazione.
--secret-input-mode refabilita la modalità riferimento invece dell’archiviazione della chiave in testo semplice. Nella configurazione interattiva, puoi scegliere:- riferimento a variabile d’ambiente (per esempio
keyRef: { source: "env", provider: "default", id: "OPENAI_API_KEY" }) - riferimento a provider configurato (
fileoexec) con alias provider + id
- riferimento a variabile d’ambiente (per esempio
- La modalità riferimento interattiva esegue una rapida convalida preflight prima del salvataggio.
- Riferimenti env: convalida il nome della variabile + valore non vuoto nell’ambiente di onboarding corrente.
- Riferimenti provider: convalida la configurazione del provider e risolve l’id richiesto.
- Se il preflight fallisce, l’onboarding mostra l’errore e ti consente di riprovare.
- In modalità non interattiva,
--secret-input-mode refè supportata solo da env.- Imposta la variabile env del provider nell’ambiente del processo di onboarding.
- I flag di chiave inline (per esempio
--openai-api-key) richiedono che quella variabile env sia impostata; altrimenti l’onboarding fallisce rapidamente. - Per provider personalizzati, la modalità non interattiva
refmemorizzamodels.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 semplice e SecretRef nella configurazione interattiva:
- Modalità token: Genera/memorizza token in testo semplice (predefinito) o Usa SecretRef.
- Modalità password: testo semplice o SecretRef.
- Percorso SecretRef token non interattivo:
--gateway-token-ref-env <ENV_VAR>. - Le configurazioni esistenti in testo semplice continuano a funzionare senza modifiche.
Suggerimento per ambienti headless e server: completa OAuth su una macchina con un browser, quindi 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 Gateway. credentials/oauth.json
è solo una sorgente di importazione legacy.Output e componenti 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 conservati)gateway.*(modalità, bind, autenticazione, Tailscale)session.dmScope(l’onboarding locale lo imposta per impostazione predefinita super-channel-peerquando non è impostato; i valori espliciti esistenti vengono conservati)channels.telegram.botToken,channels.discord.token,channels.matrix.*,channels.signal.*,channels.imessage.*- Allowlist dei canali (Slack, Discord, Matrix, Microsoft Teams) quando aderisci 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.lastRunMode
openclaw agents add scrive agents.list[] e bindings opzionali.
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 vengono 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 rilascio 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 Linux di signal-cli all’interno di WSL
Documentazione correlata
- Hub di onboarding: Onboarding (CLI)
- Automazione e script: Automazione CLI
- Riferimento dei comandi:
openclaw onboard