CLI-installatiereferentie

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

# Wat de wizard doet

Lokale modus (standaard) leidt je door:

• Model- en authenticatie-instelling (OpenAI Code-abonnement OAuth, Anthropic Claude CLI of API-sleutel, plus opties voor MiniMax, GLM, Ollama, Moonshot, StepFun en AI Gateway)
• Werkruimtelocatie en bootstrapbestanden
• Gateway-instellingen (poort, binding, authenticatie, Tailscale)
• Kanalen en providers (Telegram, WhatsApp, Discord, Google Chat, Mattermost, Signal, BlueBubbles en andere meegeleverde kanaalplugins)
• Daemoninstallatie (LaunchAgent, systemd-gebruikerseenheid of native Windows Scheduled Task met fallback via de map Startup)
• 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 de 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 een standaardmodel uit 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 keuze voor providerauthenticatie, 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 ontbreekt.

Paden voor inloggegevens en profielen:

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

Opslagmodus voor inloggegevens:

• Standaard onboardinggedrag bewaart API-sleutels als platte-tekstwaarden in authenticatieprofielen.
• --secret-input-mode ref schakelt referentiemodus in in plaats van opslag van sleutels als platte tekst. In interactieve instelling kun je een van beide kiezen:
  • 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 wordt opgeslagen.
  • Env-refs: valideert variabelenaam + niet-lege waarde in de huidige onboardingomgeving.
  • Provider-refs: valideert providerconfiguratie en lost de gevraagde id op.
  • Als preflight mislukt, toont onboarding de fout en kun je het opnieuw proberen.
• In niet-interactieve modus is --secret-input-mode ref alleen env-ondersteund.
  • Stel de provideromgevingsvariabele in de omgeving van het onboardingproces in.
  • Inline sleutelflags (bijvoorbeeld --openai-api-key) vereisen dat die omgevingsvariabele is ingesteld; anders faalt onboarding snel.
  • 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 voor aangepaste providers vereist --custom-api-key dat CUSTOM_API_KEY is ingesteld; anders faalt onboarding snel.
• Gateway-authenticatiegegevens ondersteunen keuzes voor platte tekst en SecretRef in interactieve instelling:
  • Tokenmodus: Platte-teksttoken genereren/opslaan (standaard) of SecretRef gebruiken.
  • Wachtwoordmodus: platte tekst of SecretRef.
• Niet-interactief token-SecretRef-pad: --gateway-token-ref-env <ENV_VAR>.
• Bestaande platte-tekstinstellingen blijven ongewijzigd werken.

# Uitvoer en internals

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

• agents.defaults.workspace
• agents.defaults.skipBootstrap wanneer --skip-bootstrap wordt doorgegeven
• 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 je tijdens prompts aanmeldt (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

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

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

RPC van Gateway-wizard:

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

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

Gedrag van Signal-setup:

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

# Gerelateerde documentatie

• Onboarding-hub: Onboarding (CLI)
• Automatisering en scripts: CLI-automatisering
• Opdrachtenreferentie: openclaw onboard