Guides
Riferimento per la configurazione della CLI
Questa pagina è il riferimento completo per 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, CLI Anthropic Claude o chiave API, più opzioni MiniMax, GLM, Ollama, Moonshot, StepFun e AI Gateway)
- Posizione dello spazio di lavoro e file di bootstrap
- Impostazioni del Gateway (porta, bind, autenticazione, Tailscale)
- Canali e provider (Telegram, WhatsApp, Discord, Google Chat, Mattermost, Signal, BlueBubbles e altri plugin di canale inclusi)
- Installazione del daemon (LaunchAgent, unità utente systemd o attività pianificata nativa di Windows con fallback alla cartella di Avvio)
- Controllo di integrità
- Configurazione delle Skills
La modalità remota configura questa macchina per connettersi a un gateway altrove. Non installa né modifica nulla sull'host remoto.
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 per impostazione predefinitaconfig+creds+sessions; usa--reset-scope fullper rimuovere anche lo spazio di lavoro. - Se la configurazione non è valida o contiene chiavi legacy, la procedura guidata si ferma e ti chiede di eseguire
openclaw doctorprima di continuare. - La reimpostazione usa
trashe offre gli ambiti:- Solo configurazione
- Configurazione + credenziali + sessioni
- Reimpostazione completa (rimuove anche lo spazio di lavoro)
Modello e autenticazione
- La matrice completa delle opzioni è in Opzioni di autenticazione e modello.
Spazio di lavoro
- Predefinito
~/.openclaw/workspace(configurabile). - Inizializza i file dello spazio di lavoro necessari per il rituale di bootstrap al primo avvio.
- Layout dello spazio di lavoro: Spazio di lavoro dell'agente.
Gateway
- Richiede porta, bind, modalità di autenticazione ed esposizione Tailscale.
- Consigliato: mantieni l'autenticazione tramite token abilitata anche per loopback, così i client WS locali devono autenticarsi.
- In modalità token, la configurazione interattiva offre:
- Genera/archivia token in testo semplice (predefinito)
- Usa SecretRef (opt-in)
- In modalità password, la configurazione interattiva supporta anche archiviazione in testo semplice o SecretRef.
- Percorso SecretRef del 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 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 base
- Signal: installazione opzionale di
signal-cli+ configurazione dell'account - BlueBubbles: consigliato per iMessage; URL del server + password + webhook
- iMessage: percorso legacy della CLI
imsg+ accesso al DB - 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 login effettuato; per ambienti headless, usa un LaunchDaemon personalizzato (non fornito).
- 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 richiedere 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 nella cartella di Avvio per utente e avvia immediatamente il gateway.
- Le attività pianificate restano preferite perché forniscono uno stato di supervisione migliore.
- Selezione del 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 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).
Fine
- Riepilogo e passaggi successivi, incluse le opzioni per le app iOS, Android e macOS.
Dettagli della modalità remota
La modalità remota configura questa macchina per connettersi a un gateway altrove.
Cosa imposti:
- URL del gateway remoto (
ws://...) - Token se l'autenticazione del gateway remoto è richiesta (consigliato)
Opzioni di autenticazione e modello
Chiave API Anthropic
Usa ANTHROPIC_API_KEY se presente oppure richiede una chiave, poi la salva per l'uso da parte del daemon.
Abbonamento OpenAI Code (OAuth)
Flusso browser; incolla code#state.
Imposta agents.defaults.model su openai-codex/gpt-5.5 quando il modello non è impostato o appartiene già alla famiglia OpenAI.
Abbonamento OpenAI Code (abbinamento dispositivo)
Flusso di abbinamento browser con un codice dispositivo di breve durata.
Imposta agents.defaults.model su openai-codex/gpt-5.5 quando il modello non è impostato o appartiene già alla famiglia OpenAI.
Chiave API OpenAI
Usa OPENAI_API_KEY se presente oppure richiede 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 openai-codex/*.
Chiave API xAI (Grok)
Richiede XAI_API_KEY e configura xAI come provider di modelli.
OpenCode
Richiede 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)
Archivia la chiave per te.
Vercel AI Gateway
Richiede AI_GATEWAY_API_KEY.
Maggiori dettagli: Vercel AI Gateway.
Cloudflare AI Gateway
Richiede ID account, ID gateway e CLOUDFLARE_AI_GATEWAY_API_KEY.
Maggiori dettagli: Cloudflare AI Gateway.
MiniMax
La configurazione viene scritta automaticamente. Il valore predefinito hosted è MiniMax-M2.7; la configurazione con chiave API usa
minimax/..., mentre la configurazione OAuth usa minimax-portal/....
Maggiori dettagli: MiniMax.
StepFun
La configurazione viene scritta automaticamente per StepFun standard o Step Plan su endpoint cinesi 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)
Richiede SYNTHETIC_API_KEY.
Maggiori dettagli: Synthetic.
Ollama (Cloud e modelli aperti locali)
Richiede prima Cloud + Local, Cloud only o Local only.
Cloud only usa OLLAMA_API_KEY con https://ollama.com.
Le modalità supportate da host richiedono l'URL 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
Le configurazioni Moonshot (Kimi K2) e Kimi Coding vengono scritte automaticamente. Maggiori dettagli: Moonshot AI (Kimi + Kimi Coding).
Provider personalizzato
Funziona con endpoint compatibili con OpenAI e compatibili con Anthropic.
L'onboarding interattivo supporta le stesse scelte di archiviazione della chiave API degli altri flussi con chiave API del provider:
- Incolla ora la chiave API (testo semplice)
- Usa riferimento segreto (riferimento env o riferimento provider configurato, con validazione preflight)
Flag non interattivi:
--auth-choice custom-api-key--custom-base-url--custom-model-id--custom-api-key(opzionale; ripiega suCUSTOM_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
Lascia l'autenticazione non configurata.
Comportamento del modello:
- Scegli il modello predefinito dalle opzioni rilevate oppure inserisci manualmente provider e modello.
- L'onboarding del provider personalizzato deduce il supporto alle immagini per gli ID modello comuni e chiede solo quando il nome del modello è sconosciuto.
- Quando l'onboarding parte da una scelta di autenticazione provider, il selettore del modello preferisce
automaticamente quel provider. Per Volcengine e BytePlus, la stessa preferenza
corrisponde anche alle loro 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.
Percorsi di credenziali e profili:
- Profili di autenticazione (chiavi API + OAuth):
~/.openclaw/agents/<agentId>/agent/auth-profiles.json - Importazione OAuth legacy:
~/.openclaw/credentials/oauth.json
Modalità di archiviazione delle credenziali:
- 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 validazione preflight 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 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 d'ambiente del provider nell'ambiente del processo di onboarding.
- I flag di chiave inline (per esempio
--openai-api-key) richiedono che quella variabile d'ambiente sia impostata; altrimenti l'onboarding fallisce rapidamente. - Per i provider personalizzati, la modalità
refnon interattiva archiviamodels.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/archivia token in testo semplice (predefinito) o Usa SecretRef.
- Modalità password: testo semplice o SecretRef.
- Percorso SecretRef del token non interattivo:
--gateway-token-ref-env <ENV_VAR>. - Le configurazioni in testo semplice esistenti continuano a funzionare senza modifiche.
Output e dettagli interni
Campi tipici in ~/.openclaw/openclaw.json:
agents.defaults.workspaceagents.defaults.skipBootstrapquando viene passato--skip-bootstrapagents.defaults.model/models.providers(se è stato scelto Minimax)tools.profile(l'onboarding locale usa"coding"come predefinito quando non impostato; i valori espliciti esistenti vengono preservati)gateway.*(modalità, bind, autenticazione, tailscale)session.dmScope(l'onboarding locale imposta questo valore super-channel-peerquando non impostato; i valori espliciti esistenti vengono preservati)channels.telegram.botToken,channels.discord.token,channels.matrix.*,channels.signal.*,channels.imessage.*- Elenchi consentiti dei canali (Slack, Discord, Matrix, Microsoft Teams) quando scegli di abilitarli 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/.
RPC della procedura guidata del Gateway:
wizard.startwizard.nextwizard.cancelwizard.status
I client (app macOS e UI di controllo) possono visualizzare i passaggi senza reimplementare la logica di onboarding.
Comportamento della configurazione di Signal:
- Scarica l'asset della 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 di Linux all'interno di WSL
Documenti correlati
- Hub di onboarding: Onboarding (CLI)
- Automazione e script: Automazione CLI
- Riferimento dei comandi:
openclaw onboard