Naar hoofdinhoud gaan

Documentation Index

Fetch the complete documentation index at: https://docs.openclaw.ai/llms.txt

Use this file to discover all available pages before exploring further.

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

1

Bestaande configuratie detecteren

  • Als ~/.openclaw/openclaw.json bestaat, kies je Behouden, Wijzigen of Resetten.
  • De wizard opnieuw uitvoeren wist niets tenzij je expliciet Resetten kiest (of --reset meegeeft).
  • CLI --reset gebruikt standaard config+creds+sessions; gebruik --reset-scope full om ook de werkruimte te verwijderen.
  • Als de configuratie ongeldig is of legacy-sleutels bevat, stopt de wizard en vraagt deze je om openclaw doctor uit te voeren voordat je doorgaat.
  • Resetten gebruikt trash en biedt scopes:
    • Alleen configuratie
    • Configuratie + referenties + sessies
    • Volledige reset (verwijdert ook de werkruimte)
2

Model en auth

3

Werkruimte

  • Standaard ~/.openclaw/workspace (configureerbaar).
  • Plaatst de werkruimtebestanden die nodig zijn voor het bootstrap-ritueel bij de eerste uitvoering.
  • Werkruimte-indeling: Agentwerkruimte.
4

Gateway

  • Vraagt om poort, bind, auth-modus en tailscale-blootstelling.
  • Aanbevolen: laat token-auth ingeschakeld, zelfs voor loopback, zodat lokale WS-clients zich moeten authenticeren.
  • In tokenmodus biedt interactieve configuratie:
    • Platteteksttoken genereren/opslaan (standaard)
    • SecretRef gebruiken (opt-in)
  • In wachtwoordmodus ondersteunt interactieve configuratie ook opslag als plattetekst of SecretRef.
  • Niet-interactief token-SecretRef-pad: --gateway-token-ref-env <ENV_VAR>.
    • Vereist een niet-lege env-var in de onboardingprocesomgeving.
    • Kan niet worden gecombineerd met --gateway-token.
  • Schakel auth alleen uit als je elk lokaal proces volledig vertrouwt.
  • Niet-loopback-binds vereisen nog steeds auth.
5

Kanalen

  • WhatsApp: optionele QR-login
  • Telegram: bottoken
  • Discord: bottoken
  • Google Chat: serviceaccount-JSON + webhookdoelgroep
  • Mattermost: bottoken + basis-URL
  • Signal: optionele signal-cli-installatie + accountconfiguratie
  • iMessage: imsg CLI-pad + toegang tot Messages-DB; gebruik een SSH-wrapper wanneer de Gateway niet op een Mac draait
  • DM-beveiliging: standaard is koppelen. De eerste DM stuurt een code; keur goed via openclaw pairing approve <channel> <code> of gebruik allowlists.
6

Daemon-installatie

  • macOS: LaunchAgent
    • Vereist een ingelogde gebruikerssessie; gebruik voor headless een aangepaste LaunchDaemon (niet meegeleverd).
  • Linux en Windows via WSL2: systemd-gebruikerseenheid
    • De wizard probeert loginctl enable-linger <user> zodat de Gateway actief blijft na uitloggen.
    • Kan om sudo vragen (schrijft /var/lib/systemd/linger); probeert het eerst zonder sudo.
  • Native Windows: eerst Scheduled Task
    • Als taakaanmaak wordt geweigerd, valt OpenClaw terug op een login-item in de Startup-map per gebruiker en start de Gateway direct.
    • Scheduled Tasks blijven aanbevolen omdat ze een betere supervisorstatus bieden.
  • Runtime-selectie: Node (aanbevolen; vereist voor WhatsApp en Telegram). Bun wordt niet aanbevolen.
7

Gezondheidscontrole

  • Start de Gateway (indien nodig) en voert openclaw health uit.
  • openclaw status --deep voegt de live Gateway-gezondheidsprobe toe aan de statusuitvoer, inclusief kanaalprobes wanneer ondersteund.
8

Skills

  • Leest beschikbare Skills en controleert vereisten.
  • Laat je een node-manager kiezen: npm, pnpm of bun.
  • Installeert optionele afhankelijkheden (sommige gebruiken Homebrew op macOS).
9

Afronden

  • Samenvatting en volgende stappen, inclusief iOS-, Android- en macOS-appopties.
Als er geen GUI wordt gedetecteerd, drukt de wizard SSH-port-forward-instructies voor de Control UI af in plaats van een browser te openen. Als Control UI-assets ontbreken, probeert de wizard ze te bouwen; fallback is pnpm ui:build (installeert UI-afhankelijkheden automatisch).

​
Details van externe modus

Externe modus configureert deze machine om verbinding te maken met een Gateway elders.
Externe modus installeert of wijzigt niets op de externe host.
Wat je instelt:
  • Externe Gateway-URL (ws://...)
  • Token als externe Gateway-auth vereist is (aanbevolen)
  • Als de Gateway alleen loopback is, gebruik dan SSH-tunneling of een tailnet.
  • Discovery-hints:
    • macOS: Bonjour (dns-sd)
    • Linux: Avahi (avahi-browse)

​
Auth- en modelopties

Gebruikt ANTHROPIC_API_KEY als die aanwezig is of vraagt om een sleutel en slaat deze daarna op voor daemongebruik.
Browserflow; plak code#state.Stelt agents.defaults.model in op openai/gpt-5.5 via de Codex-runtime wanneer het model niet is ingesteld of al tot de OpenAI-familie behoort.
Browserkoppelingsflow met een kortlevende apparaatcode.Stelt agents.defaults.model in op openai/gpt-5.5 via de Codex-runtime wanneer het model niet is ingesteld of al tot de OpenAI-familie behoort.
Gebruikt OPENAI_API_KEY als die aanwezig is of vraagt om een sleutel en slaat de referentie daarna op in auth-profielen.Stelt agents.defaults.model in op openai/gpt-5.5 wanneer het model niet is ingesteld, openai/* is of openai-codex/* is.
Vraagt om XAI_API_KEY en configureert xAI als modelprovider.
Vraagt om OPENCODE_API_KEY (of OPENCODE_ZEN_API_KEY) en laat je de Zen- of Go-catalogus kiezen. Configuratie-URL: opencode.ai/auth.
Slaat de sleutel voor je op.
Vraagt om AI_GATEWAY_API_KEY. Meer detail: Vercel AI Gateway.
Vraagt om account-ID, Gateway-ID en CLOUDFLARE_AI_GATEWAY_API_KEY. Meer detail: Cloudflare AI Gateway.
Configuratie wordt automatisch geschreven. De gehoste standaard is MiniMax-M2.7; configuratie met API-sleutel gebruikt minimax/..., en OAuth-configuratie gebruikt minimax-portal/.... Meer detail: MiniMax.
Configuratie wordt automatisch geschreven voor StepFun Standard of Step Plan op Chinese of wereldwijde endpoints. Standard bevat momenteel step-3.5-flash, en Step Plan bevat ook step-3.5-flash-2603. Meer detail: StepFun.
Vraagt om SYNTHETIC_API_KEY. Meer detail: Synthetic.
Vraagt eerst om Cloud + Local, Cloud only of Local only. Cloud only gebruikt OLLAMA_API_KEY met https://ollama.com. De host-backed modi vragen om een basis-URL (standaard http://127.0.0.1:11434), ontdekken beschikbare modellen en stellen standaarden voor. Cloud + Local controleert ook of die Ollama-host is aangemeld voor cloudtoegang. Meer detail: Ollama.
Configuraties voor Moonshot (Kimi K2) en Kimi Coding worden automatisch geschreven. Meer detail: Moonshot AI (Kimi + Kimi Coding).
Werkt met OpenAI-compatibele en Anthropic-compatibele endpoints.Interactieve onboarding ondersteunt dezelfde opslagkeuzes voor API-sleutels als andere provider-API-sleutelflows:
  • API-sleutel nu plakken (plattetekst)
  • Geheime verwijzing gebruiken (env-ref of geconfigureerde provider-ref, met preflightvalidatie)
Niet-interactieve flags:
  • --auth-choice custom-api-key
  • --custom-base-url
  • --custom-model-id
  • --custom-api-key (optioneel; valt terug op CUSTOM_API_KEY)
  • --custom-provider-id (optioneel)
  • --custom-compatibility <openai|anthropic> (optioneel; standaard openai)
  • --custom-image-input / --custom-text-input (optioneel; overschrijft afgeleide modelinvoercapaciteit)
Laat auth ongeconfigureerd.
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.
Tip voor omgevingen zonder grafische interface en servers: voltooi OAuth op een machine met een browser en kopieer vervolgens het auth-profiles.json van die agent (bijvoorbeeld ~/.openclaw/agents/<agentId>/agent/auth-profiles.json, of het bijbehorende $OPENCLAW_STATE_DIR/...-pad) naar de Gateway-host. credentials/oauth.json is alleen een verouderde importbron.

​
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/.
Sommige kanalen worden geleverd als plugins. Wanneer ze tijdens de configuratie worden geselecteerd, vraagt de wizard om de plugin te installeren (npm of lokaal pad) vóór de kanaalconfiguratie.
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