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.

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

​
Flowdetails (lokale modus)

1

Bestaande configuratie detecteren

  • Als ~/.openclaw/openclaw.json bestaat, kies dan 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 je om openclaw doctor uit te voeren voordat je verdergaat.
  • Resetten gebruikt trash (nooit rm) en biedt scopes:
    • Alleen configuratie
    • Configuratie + referenties + sessies
    • Volledige reset (verwijdert ook de werkruimte)
2

Model/Auth

  • Anthropic API-sleutel: gebruikt ANTHROPIC_API_KEY als die aanwezig is of vraagt om een sleutel, en slaat die daarna op voor daemon-gebruik.
  • Anthropic API-sleutel: voorkeurskeuze voor de Anthropic-assistent in onboarding/configuratie.
  • Anthropic setup-token: nog steeds beschikbaar in onboarding/configuratie, 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 het 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 het model niet is ingesteld of al tot de OpenAI-familie behoort.
  • OpenAI API-sleutel: 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 het model niet is ingesteld, openai/* is, of openai-codex/* is.
  • xAI (Grok) API-sleutel: vraagt om XAI_API_KEY en configureert xAI als modelprovider.
  • OpenCode: vraagt om OPENCODE_API_KEY (of OPENCODE_ZEN_API_KEY, verkrijgbaar 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 dat nodig is; Cloud + Local controleert ook of die Ollama-host is aangemeld voor cloudtoegang.
  • Meer details: Ollama
  • API-sleutel: slaat de sleutel voor je op.
  • Vercel AI Gateway (proxy voor meerdere modellen): 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 Chinese of wereldwijde endpoints.
  • 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 auth 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 nieuwste-generatiemodel dat beschikbaar is in je providerstack.
  • Onboarding voert een modelcontrole uit en waarschuwt als het geconfigureerde model onbekend is of auth ontbreekt.
  • De opslagmodus voor API-sleutels gebruikt standaard platte auth-profielwaarden. 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 een verouderde importbron.
  • Meer details: /concepts/oauth
Tip voor headless/server: voltooi OAuth op een machine met een browser en kopieer daarna de auth-profiles.json van die agent (bijvoorbeeld ~/.openclaw/agents/<agentId>/agent/auth-profiles.json, of het overeenkomende $OPENCLAW_STATE_DIR/...-pad) naar de Gateway-host. credentials/oauth.json is alleen een verouderde importbron.
3

Werkruimte

  • Standaard ~/.openclaw/workspace (configureerbaar).
  • Vult de werkruimte met de bestanden die nodig zijn voor het bootstrapritueel van de agent.
  • Volledige werkruimte-indeling + back-upgids: Agentwerkruimte
4

Gateway

  • Poort, binding, auth-modus, blootstelling via Tailscale.
  • Auth-aanbeveling: behoud Token, zelfs voor loopback, zodat lokale WS-clients zich moeten authenticeren.
  • In tokenmodus biedt interactieve configuratie:
    • 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 vroeg met een duidelijke herstelmelding in plaats van runtime-auth stilzwijgend te verzwakken.
  • In wachtwoordmodus ondersteunt interactieve configuratie ook opslag in platte tekst of SecretRef-opslag.
  • Niet-interactief token-SecretRef-pad: --gateway-token-ref-env <ENV_VAR>.
    • Vereist een niet-lege env-var in de procesomgeving van onboarding.
    • Kan niet worden gecombineerd met --gateway-token.
  • Schakel auth alleen uit als je elk lokaal proces volledig vertrouwt.
  • Niet-loopback-bindings vereisen nog steeds auth.
5

Kanalen

  • WhatsApp: optionele QR-login.
  • Telegram: bot-token.
  • Discord: bot-token.
  • Google Chat: serviceaccount-JSON + webhookdoelgroep.
  • Mattermost (plugin): bot-token + basis-URL.
  • Signal: optionele signal-cli-installatie + accountconfiguratie.
  • BlueBubbles: aanbevolen voor iMessage; server-URL + wachtwoord + Webhook.
  • iMessage: verouderd 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.
6

Zoeken op het web

  • 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 configuratie; providers zonder sleutel gebruiken in plaats daarvan hun provider-specifieke vereisten.
  • Sla over met --skip-search.
  • Later configureren: openclaw configure --section web.
7

Daemon-installatie

  • 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 /var/lib/systemd/linger); het probeert eerst zonder sudo.
  • Runtimekeuze: Node (aanbevolen; vereist voor WhatsApp/Telegram). Bun wordt niet aanbevolen.
  • Als token-auth een token vereist en gateway.auth.token door SecretRef wordt beheerd, valideert de daemon-installatie dit maar bewaart geen opgeloste plattetekst-tokenwaarden in metadata van de supervisorserviceomgeving.
  • Als token-auth een token vereist en de geconfigureerde token-SecretRef niet kan worden opgelost, wordt daemon-installatie geblokkeerd met uitvoerbare begeleiding.
  • Als zowel gateway.auth.token als gateway.auth.password zijn geconfigureerd en gateway.auth.mode niet is ingesteld, wordt daemon-installatie geblokkeerd totdat de modus expliciet is ingesteld.
8

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).
9

Skills (aanbevolen)

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

Voltooien

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

​
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.
--json impliceert geen niet-interactieve modus. Gebruik --non-interactive (en --workspace) voor scripts.
Provider-specifieke opdrachtvoorbeelden staan in CLI-automatisering. Gebruik deze naslagpagina 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-configuratie (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; signal-cli-installatie 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 dit niet is ingesteld; bestaande expliciete waarden blijven behouden)
  • gateway.* (mode, bind, auth, tailscale)
  • session.dmScope (gedragsdetails: CLI-installatiereferentie)
  • channels.telegram.botToken, channels.discord.token, channels.matrix.*, channels.signal.*, channels.imessage.*
  • Kanaal-allowlists (Slack/Discord/Matrix/Microsoft Teams) wanneer je dit tijdens de vragen inschakelt (namen worden waar mogelijk omgezet naar ID’s).
  • skills.install.nodeManager
    • setup --node-manager accepteert npm, pnpm of bun.
    • Handmatige configuratie kan nog steeds yarn gebruiken door skills.install.nodeManager rechtstreeks in te stellen.
  • 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 je er tijdens de setup een kiest, vraagt onboarding om deze te installeren (npm of een lokaal pad) voordat deze kan worden geconfigureerd.

​
Gerelateerde documentatie