English简体中文繁體中文日本語EspañolPortuguês (BR)한국어DeutschFrançaisالعربيةItalianoTiếng ViệtNederlandsTürkçeУкраїнськаBahasa IndonesiaPolskiفارسیไทย

Technical reference

Onboardingreferentie

Dit is de volledige referentie voor openclaw onboard. Zie Onboarding (CLI) voor een overzicht op hoofdlijnen.

Flowdetails (lokale modus)

  • Bestaande configuratie detecteren

    • Als ~/.openclaw/openclaw.json bestaat, kies je Behouden / Wijzigen / Resetten.
    • Onboarding 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 verouderde sleutels bevat, stopt de wizard en vraagt deze je om openclaw doctor uit te voeren voordat je doorgaat.
    • Reset gebruikt trash (nooit rm) en biedt bereiken:
      • Alleen configuratie
      • Configuratie + referenties + sessies
      • Volledige reset (verwijdert ook de werkruimte)

  • Model/authenticatie

    • Anthropic API key: gebruikt ANTHROPIC_API_KEY als die aanwezig is, of vraagt om een sleutel, en slaat die daarna op voor daemongebruik.
    • Anthropic API key: voorkeurskeuze voor de Anthropic-assistent in onboarding/configureren.
    • Anthropic setup-token: nog steeds beschikbaar in onboarding/configureren, hoewel OpenClaw nu de voorkeur geeft aan hergebruik van Claude CLI wanneer beschikbaar.
    • OpenAI Code (Codex)-abonnement (OAuth): browserflow; plak de code#state.
      • Stelt agents.defaults.model in op openai-codex/gpt-5.5 wanneer model niet is ingesteld of al tot de OpenAI-familie behoort.
    • OpenAI Code (Codex)-abonnement (apparaatkoppeling): browserkoppelingsflow met een kortlevende apparaatcode.
      • Stelt agents.defaults.model in op openai-codex/gpt-5.5 wanneer model niet is ingesteld of al tot de OpenAI-familie behoort.
    • OpenAI API key: gebruikt OPENAI_API_KEY als die aanwezig is, of vraagt om een sleutel, en slaat die daarna op in auth-profielen.
      • Stelt agents.defaults.model in op openai/gpt-5.5 wanneer model niet is ingesteld, openai/* is, of openai-codex/* is.
    • xAI (Grok) API key: vraagt om XAI_API_KEY en configureert xAI als modelprovider.
    • OpenCode: vraagt om OPENCODE_API_KEY (of OPENCODE_ZEN_API_KEY, haal die op via https://opencode.ai/auth) en laat je de Zen- of Go-catalogus kiezen.
    • Ollama: biedt eerst Cloud + lokaal, Alleen cloud of Alleen lokaal. Cloud only vraagt om OLLAMA_API_KEY en gebruikt https://ollama.com; de host-ondersteunde modi vragen om de Ollama-basis-URL, ontdekken beschikbare modellen en halen het geselecteerde lokale model automatisch op wanneer nodig; Cloud + Local controleert ook of die Ollama-host is aangemeld voor cloudtoegang.
    • Meer details: Ollama
    • API key: slaat de sleutel voor je op.
    • Vercel AI Gateway (multi-modelproxy): vraagt om AI_GATEWAY_API_KEY.
    • Meer details: Vercel AI Gateway
    • Cloudflare AI Gateway: vraagt om Account ID, Gateway ID en CLOUDFLARE_AI_GATEWAY_API_KEY.
    • Meer details: Cloudflare AI Gateway
    • MiniMax: configuratie wordt automatisch geschreven; de gehoste standaard is MiniMax-M2.7. API-sleutelconfiguratie gebruikt minimax/..., en OAuth-configuratie gebruikt minimax-portal/....
    • Meer details: MiniMax
    • StepFun: configuratie wordt automatisch geschreven voor StepFun standard of Step Plan op China- of globale eindpunten.
    • Standard bevat momenteel step-3.5-flash, en Step Plan bevat ook step-3.5-flash-2603.
    • Meer details: StepFun
    • Synthetic (Anthropic-compatibel): vraagt om SYNTHETIC_API_KEY.
    • Meer details: Synthetic
    • Moonshot (Kimi K2): configuratie wordt automatisch geschreven.
    • Kimi Coding: configuratie wordt automatisch geschreven.
    • Meer details: Moonshot AI (Kimi + Kimi Coding)
    • Overslaan: nog geen authenticatie geconfigureerd.
    • Kies een standaardmodel uit de gedetecteerde opties (of voer provider/model handmatig in). Kies voor de beste kwaliteit en een lager risico op promptinjectie het sterkste model van de nieuwste generatie dat beschikbaar is in je providerstack.
    • Onboarding voert een modelcontrole uit en waarschuwt als het geconfigureerde model onbekend is of authenticatie ontbreekt.
    • De opslagmodus voor API-sleutels gebruikt standaard platte-tekstwaarden in auth-profielen. Gebruik --secret-input-mode ref om in plaats daarvan door env ondersteunde refs op te slaan (bijvoorbeeld keyRef: { source: "env", provider: "default", id: "OPENAI_API_KEY" }).
    • Auth-profielen staan in ~/.openclaw/agents/<agentId>/agent/auth-profiles.json (API-sleutels + OAuth). ~/.openclaw/credentials/oauth.json is alleen voor legacy-import.
    • Meer details: /concepts/oauth

  • Werkruimte

    • Standaard ~/.openclaw/workspace (configureerbaar).
    • Maakt de werkruimtebestanden aan die nodig zijn voor het agent-bootstrapritueel.
    • Volledige werkruimte-indeling + back-upgids: Agentwerkruimte

  • Gateway

    • Poort, bind, authenticatiemodus, blootstelling via Tailscale.
    • Authenticatieadvies: behoud Token, zelfs voor loopback, zodat lokale WS-clients zich moeten authenticeren.
    • In tokenmodus biedt interactieve setup:
      • Token in platte tekst genereren/opslaan (standaard)
      • SecretRef gebruiken (opt-in)
      • Quickstart hergebruikt bestaande gateway.auth.token SecretRefs via env-, file- en exec-providers voor onboarding-probe/dashboard-bootstrap.
      • Als die SecretRef is geconfigureerd maar niet kan worden opgelost, faalt onboarding vroegtijdig met een duidelijke herstelmelding in plaats van runtime-authenticatie stilzwijgend te verzwakken.
    • In wachtwoordmodus ondersteunt interactieve setup ook opslag als platte tekst of SecretRef.
    • Niet-interactief token-SecretRef-pad: --gateway-token-ref-env &lt;ENV_VAR&gt;.
      • Vereist een niet-lege env-var in de procesomgeving van onboarding.
      • Kan niet worden gecombineerd met --gateway-token.
    • Schakel authenticatie alleen uit als je elk lokaal proces volledig vertrouwt.
    • Niet-loopback-binds vereisen nog steeds authenticatie.

  • Kanalen

    • WhatsApp: optionele QR-login.
    • Telegram: bottoken.
    • Discord: bottoken.
    • Google Chat: serviceaccount-JSON + Webhook-doelgroep.
    • Mattermost (Plugin): bottoken + basis-URL.
    • Signal: optionele signal-cli-installatie + accountconfiguratie.
    • BlueBubbles: aanbevolen voor iMessage; server-URL + wachtwoord + Webhook.
    • iMessage: legacy imsg CLI-pad + DB-toegang.
    • DM-beveiliging: standaard is koppeling. De eerste DM stuurt een code; keur goed via openclaw pairing approve <channel> <code> of gebruik allowlists.

  • Webzoekfunctie

    • Kies een ondersteunde provider zoals Brave, DuckDuckGo, Exa, Firecrawl, Gemini, Grok, Kimi, MiniMax Search, Ollama Web Search, Perplexity, SearXNG of Tavily (of sla over).
    • API-ondersteunde providers kunnen env-vars of bestaande configuratie gebruiken voor snelle setup; providers zonder sleutel gebruiken in plaats daarvan hun providerspecifieke vereisten.
    • Sla over met --skip-search.
    • Later configureren: openclaw configure --section web.

  • Daemoninstallatie

    • macOS: LaunchAgent
      • Vereist een aangemelde gebruikerssessie; gebruik voor headless een aangepaste LaunchDaemon (niet meegeleverd).
    • Linux (en Windows via WSL2): systemd-gebruikerseenheid
      • Onboarding probeert lingering in te schakelen via loginctl enable-linger <user> zodat de Gateway actief blijft na uitloggen.
      • Kan om sudo vragen (schrijft naar /var/lib/systemd/linger); probeert het eerst zonder sudo.
    • Runtimeselectie: Node (aanbevolen; vereist voor WhatsApp/Telegram). Bun wordt niet aanbevolen.
    • Als tokenauthenticatie een token vereist en gateway.auth.token door SecretRef wordt beheerd, valideert daemoninstallatie dit maar bewaart geen opgeloste platte-teksttokenwaarden in metadata van de supervisorserviceomgeving.
    • Als tokenauthenticatie een token vereist en de geconfigureerde token-SecretRef niet kan worden opgelost, wordt daemoninstallatie geblokkeerd met bruikbare begeleiding.
    • Als zowel gateway.auth.token als gateway.auth.password zijn geconfigureerd en gateway.auth.mode niet is ingesteld, wordt daemoninstallatie geblokkeerd totdat de modus expliciet is ingesteld.

  • Gezondheidscontrole

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

  • Skills (aanbevolen)

    • Leest de beschikbare Skills en controleert vereisten.
    • Laat je een nodebeheerder kiezen: npm / pnpm (bun niet aanbevolen).
    • Installeert optionele afhankelijkheden (sommige gebruiken Homebrew op macOS).

  • Afronden

    • Samenvatting + vervolgstappen, inclusief iOS/Android/macOS-apps voor extra functies.

    • Niet-interactieve modus

    Gebruik --non-interactive om onboarding te automatiseren of te scripten:

    openclaw onboard --non-interactive \
  --mode local \
  --auth-choice apiKey \
  --anthropic-api-key "$ANTHROPIC_API_KEY" \
  --gateway-port 18789 \
  --gateway-bind loopback \
  --install-daemon \
  --daemon-runtime node \
  --skip-skills

    Voeg --json toe voor een machineleesbare samenvatting.

    Gateway-token-SecretRef in niet-interactieve modus:

    export OPENCLAW_GATEWAY_TOKEN="your-token"
openclaw onboard --non-interactive \
  --mode local \
  --auth-choice skip \
  --gateway-auth token \
  --gateway-token-ref-env OPENCLAW_GATEWAY_TOKEN

    --gateway-token en --gateway-token-ref-env sluiten elkaar wederzijds uit.

    Providerspecifieke opdrachtvoorbeelden staan in CLI-automatisering. Gebruik deze referentiepagina voor vlagsemantiek en stapvolgorde.

    Agent toevoegen (niet-interactief)

    openclaw agents add work \
  --workspace ~/.openclaw/workspace-work \
  --model openai/gpt-5.5 \
  --bind whatsapp:biz \
  --non-interactive \
  --json

    Gateway wizard-RPC

    De Gateway stelt de onboardingflow beschikbaar via RPC (wizard.start, wizard.next, wizard.cancel, wizard.status). Clients (macOS-app, Control UI) kunnen stappen renderen zonder onboardinglogica opnieuw te implementeren.

    Signal instellen (signal-cli)

    Onboarding kan signal-cli installeren vanuit GitHub-releases:

    • Downloadt de juiste release-asset.
    • Slaat die op onder ~/.openclaw/tools/signal-cli/<version>/.
    • Schrijft channels.signal.cliPath naar je configuratie.

    Opmerkingen:

    • JVM-builds vereisen Java 21.
    • Native builds worden gebruikt wanneer beschikbaar.
    • Windows gebruikt WSL2; installatie van signal-cli volgt de Linux-flow binnen WSL.

    Wat de wizard schrijft

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

    • agents.defaults.workspace
    • 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 (gedragsdetails: CLI-installatiereferentie)
    • channels.telegram.botToken, channels.discord.token, channels.matrix.*, channels.signal.*, channels.imessage.*
    • Toelatingslijsten voor kanalen (Slack/Discord/Matrix/Microsoft Teams) wanneer je hiervoor kiest tijdens de vragen (namen worden waar mogelijk naar ID's herleid).
    • skills.install.nodeManager
      • setup --node-manager accepteert npm, pnpm of bun.
      • Handmatige configuratie kan nog steeds yarn gebruiken door skills.install.nodeManager direct in te stellen.
    • 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/.

    Sommige kanalen worden als Plugins geleverd. Wanneer je er een kiest tijdens de installatie, vraagt onboarding om deze te installeren (npm of een lokaal pad) voordat deze kan worden geconfigureerd.

    Gerelateerde documentatie