Naslaginformatie voor CLI-configuratie

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 auth-configuratie (OpenAI Code-abonnement OAuth, Anthropic Claude CLI of API-sleutel, plus opties voor MiniMax, GLM, Ollama, Moonshot, StepFun en AI Gateway)
• Werkruimtelocatie en bootstrap-bestanden
• Gateway-instellingen (poort, bind, auth, tailscale)
• Kanalen en providers (Telegram, WhatsApp, Discord, Google Chat, Mattermost, Signal, iMessage en andere meegeleverde kanaalplugins)
• Daemon-installatie (LaunchAgent, systemd-gebruikerseenheid of native Windows Scheduled Task met Startup-mapfallback)
• Gezondheidscontrole
• Skills-configuratie

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 externe Gateway-auth vereist is (aanbevolen)

Auth- en modelopties

Modelgedrag:

• Kies het 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 provider-auth-keuze, geeft de modelkiezer automatisch 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 auth mist.

Paden voor referenties en profielen:

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

Opslagmodus voor referenties:

• Standaard onboardinggedrag bewaart API-sleutels als plattetekstwaarden in auth-profielen.
• --secret-input-mode ref schakelt referentiemodus in in plaats van opslag van plattetekstsleutels. In interactieve configuratie 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 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-backed.
  • Stel de provider-env-var in de onboardingprocesomgeving in.
  • Inline-sleutelflags (bijvoorbeeld --openai-api-key) vereisen dat die env-var is ingesteld; anders mislukt 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 aangepaste-providergeval vereist --custom-api-key dat CUSTOM_API_KEY is ingesteld; anders mislukt onboarding snel.
• Gateway-auth-referenties ondersteunen keuzes voor plattetekst en SecretRef in interactieve configuratie:
  • Tokenmodus: Platteteksttoken genereren/opslaan (standaard) of SecretRef gebruiken.
  • Wachtwoordmodus: plattetekst of SecretRef.
• Niet-interactief token-SecretRef-pad: --gateway-token-ref-env <ENV_VAR>.
• Bestaande plattetekstconfiguraties blijven ongewijzigd werken.

Uitvoer en interne details

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 introductie gebruikt standaard "coding" wanneer dit niet is ingesteld; bestaande expliciete waarden blijven behouden)
• gateway.* (modus, bind, auth, tailscale)
• session.dmScope (lokale introductie gebruikt hiervoor standaard per-channel-peer wanneer dit niet is 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 hiervoor aanmeldt tijdens prompts (namen worden waar mogelijk omgezet naar ID's)
• 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-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 de introductielogica opnieuw te implementeren.

Signal-configuratiegedrag:

• 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

• Introductiehub: Introductie (CLI)
• Automatisering en scripts: CLI-automatisering
• Opdrachtenreferentie: openclaw onboard