CLI-installatiereferentie

Deze pagina is de volledige referentie voor openclaw onboard. Zie voor de korte gids Onboarding (CLI).

Wat de wizard doet

Lokale modus (standaard) leidt je door:

• Model- en authenticatie-instelling (OAuth voor OpenAI Code-abonnement, Anthropic Claude CLI of API-sleutel, plus opties voor MiniMax, GLM, Ollama, Moonshot, StepFun en AI Gateway)
• Werkruimtelocatie en bootstrapbestanden
• Gateway-instellingen (poort, bind, authenticatie, tailscale)
• Kanalen en providers (Telegram, WhatsApp, Discord, Google Chat, Mattermost, Signal, iMessage en andere meegeleverde kanaalplugins)
• Daemoninstallatie (LaunchAgent, systemd-gebruikerseenheid of native Windows Scheduled Task met Startup-map als fallback)
• Gezondheidscontrole
• Skills-instelling

Externe modus configureert deze machine om verbinding te maken met een Gateway elders. Deze installeert of wijzigt niets op de externe host.

Details van lokale flow

Details van externe modus

Externe modus configureert deze machine om verbinding te maken met een Gateway elders.

Wat je instelt:

• Externe Gateway-URL (ws://...)
• Token als authenticatie voor de externe Gateway vereist is (aanbevolen)

Authenticatie- en modelopties

Modelgedrag:

• Kies het standaardmodel uit de gedetecteerde opties, of voer provider en model handmatig in.
• Onboarding voor aangepaste providers leidt beeldondersteuning af voor gangbare model-ID's en vraagt alleen wanneer de modelnaam onbekend is.
• Wanneer onboarding start vanuit een provider-authenticatiekeuze, geeft de modelkiezer automatisch de voorkeur aan die provider. Voor Volcengine en BytePlus komt dezelfde voorkeur ook overeen met hun coding-plan-varianten (volcengine-plan/*, byteplus-plan/*).
• Als dat voorkeursproviderfilter leeg zou zijn, valt de kiezer terug op de volledige catalogus in plaats van geen modellen te tonen.
• De wizard voert een modelcontrole uit en waarschuwt als het geconfigureerde model onbekend is of authenticatie mist.

Paden voor inloggegevens en profielen:

• Authenticatieprofielen (API-sleutels + OAuth): ~/.openclaw/agents/<agentId>/agent/auth-profiles.json
• Import van verouderde OAuth: ~/.openclaw/credentials/oauth.json

Opslagmodus voor inloggegevens:

• Standaard onboardinggedrag bewaart API-sleutels als plattetekstwaarden in auth-profielen.
• --secret-input-mode ref schakelt referentiemodus in in plaats van opslag van sleutels in platte tekst. In interactieve setup kun je kiezen uit:
  • omgevingsvariabele-ref (bijvoorbeeld keyRef: { source: "env", provider: "default", id: "OPENAI_API_KEY" })
  • geconfigureerde provider-ref (file of exec) met provideralias + id
• Interactieve referentiemodus voert een snelle preflightvalidatie uit voordat er wordt opgeslagen.
  • Env-refs: valideert variabelenaam + niet-lege waarde in de huidige onboardingomgeving.
  • Provider-refs: valideert providerconfiguratie en resolveert de gevraagde id.
  • Als preflight mislukt, toont onboarding de fout en kun je het opnieuw proberen.
• In niet-interactieve modus wordt --secret-input-mode ref alleen door env ondersteund.
  • Stel de provider-env-var in de procesomgeving voor onboarding in.
  • Inline sleutelvlaggen (bijvoorbeeld --openai-api-key) vereisen dat die env-var is ingesteld; anders faalt onboarding direct.
  • Voor aangepaste providers slaat niet-interactieve ref-modus models.providers.<id>.apiKey op als { source: "env", provider: "default", id: "CUSTOM_API_KEY" }.
  • In dat geval met een aangepaste provider vereist --custom-api-key dat CUSTOM_API_KEY is ingesteld; anders faalt onboarding direct.
• Gateway-authreferenties ondersteunen keuzes voor platte tekst en SecretRef in interactieve setup:
  • Tokenmodus: Platteteksttoken genereren/opslaan (standaard) of SecretRef gebruiken.
  • Wachtwoordmodus: platte tekst of SecretRef.
• Niet-interactief token-SecretRef-pad: --gateway-token-ref-env <ENV_VAR>.
• Bestaande setups met platte tekst blijven ongewijzigd werken.

Uitvoer en internals

Typische velden in ~/.openclaw/openclaw.json:

• agents.defaults.workspace
• agents.defaults.skipBootstrap wanneer --skip-bootstrap wordt meegegeven
• agents.defaults.model / models.providers (als Minimax is gekozen)
• tools.profile (lokale onboarding gebruikt standaard "coding" wanneer niet ingesteld; bestaande expliciete waarden blijven behouden)
• gateway.* (modus, bind, auth, tailscale)
• session.dmScope (lokale onboarding stelt dit standaard in op per-channel-peer wanneer niet ingesteld; bestaande expliciete waarden blijven behouden)
• channels.telegram.botToken, channels.discord.token, channels.matrix.*, channels.signal.*, channels.imessage.*
• Kanaal-allowlists (Slack, Discord, Matrix, Microsoft Teams) wanneer je hiervoor kiest tijdens prompts (namen worden waar mogelijk naar ID's omgezet)
• skills.install.nodeManager
  • De vlag setup --node-manager accepteert npm, pnpm of bun.
  • Handmatige configuratie kan later nog steeds skills.install.nodeManager: "yarn" instellen.
• wizard.lastRunAt
• wizard.lastRunVersion
• wizard.lastRunCommit
• wizard.lastRunCommand
• wizard.lastRunMode
• wizard.securityAcknowledgedAt

openclaw agents add schrijft agents.list[] en optionele bindings.

WhatsApp-referenties komen onder ~/.openclaw/credentials/whatsapp/<accountId>/. Sessies worden opgeslagen onder ~/.openclaw/agents/<agentId>/sessions/.

Gateway-wizard-RPC:

• wizard.start
• wizard.next
• wizard.cancel
• wizard.status

Clients (macOS-app en Control UI) kunnen stappen renderen zonder onboardinglogica opnieuw te implementeren.

Signal-setupgedrag:

• Downloadt de juiste release-asset
• Slaat deze op onder ~/.openclaw/tools/signal-cli/<version>/
• Schrijft channels.signal.cliPath in config
• JVM-builds vereisen Java 21
• Native builds worden gebruikt wanneer beschikbaar
• Windows gebruikt WSL2 en volgt de Linux signal-cli-flow binnen WSL

Gerelateerde docs

• Onboardinghub: Onboarding (CLI)
• Automatisering en scripts: CLI-automatisering
• Commandoreferentie: openclaw onboard