Referentie voor CLI-configuratie

Deze pagina behandelt stapsgewijs het onboardinggedrag, de uitvoer en de interne werking. Zie Onboarding (CLI) voor een rondleiding. Zie voor de volledige referentie van CLI-vlaggen (elke --flag, niet-interactieve voorbeelden, providerspecifieke opdrachten) openclaw onboard.

Wat de wizard doet

De lokale modus (standaard) begeleidt je bij:

• Model- en authenticatieconfiguratie (Anthropic, OAuth voor een OpenAI Code-abonnement, xAI, OpenCode, aangepaste eindpunten en meer authenticatieflows die eigendom zijn van providers)
• Werkruimtelocatie en bootstrapbestanden
• Gateway-instellingen (poort, binding, authenticatie, Tailscale)
• Kanalen en providers (Discord, Feishu, Google Chat, iMessage, Mattermost, Microsoft Teams, QQ Bot, Signal, Slack, Telegram, WhatsApp en andere gebundelde kanalen of Plugin-kanalen)
• Provider voor zoeken op het web (optioneel)
• Daemoninstallatie (LaunchAgent, systemd-gebruikerseenheid of systeemeigen Windows Scheduled Task met terugval op de map Startup)
• Statuscontrole
• Configuratie van Skills

De externe modus configureert deze machine om verbinding te maken met een Gateway elders. Er wordt niets op de externe host geïnstalleerd of gewijzigd.

Details van de lokale flow

Details van de externe modus

De externe modus configureert deze machine om verbinding te maken met een Gateway elders. Er wordt niets op de externe host geïnstalleerd of gewijzigd.

Wat je instelt:

• URL van externe Gateway (ws://... of wss://...)
• Token, wachtwoord of geen authenticatie, overeenkomstig de configuratie van de externe Gateway

Authenticatie- en modelopties

Als een providerconfiguratiestap tijdens interactieve onboarding mislukt (bijvoorbeeld een optie voor hergebruik van de CLI zonder lokale aanmelding), toont de wizard de fout en keert terug naar de providerkiezer in plaats van af te sluiten. Expliciete uitvoeringen van --auth-choice blijven snel mislukken voor automatisering.

Modelgedrag:

• Kies het standaardmodel uit de gedetecteerde opties of voer de provider en het model handmatig in.
• Wanneer onboarding begint vanuit een keuze voor providerauthenticatie, geeft de modelkiezer automatisch de voorkeur aan die provider. Voor Volcengine en BytePlus komt die voorkeur ook overeen met hun varianten voor programmeerplannen (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 aanmeldgegevens en profielen:

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

Opslagmodus voor aanmeldgegevens:

• Bij standaardonboarding worden API-sleutels als plattetekstwaarden in authenticatieprofielen opgeslagen.
• --secret-input-mode ref schakelt de verwijzingsmodus in in plaats van opslag van sleutels als platte tekst. Bij interactieve installatie kun je kiezen uit:
  • verwijzing naar een omgevingsvariabele (bijvoorbeeld keyRef: { source: "env", provider: "default", id: "OPENAI_API_KEY" })
  • geconfigureerde providerverwijzing (file of exec) met provideralias + ID
• De interactieve verwijzingsmodus voert vóór het opslaan een snelle voorafgaande validatie uit.
  • Omgevingsverwijzingen: valideert de variabelenaam + een niet-lege waarde in de huidige onboardingomgeving.
  • Providerverwijzingen: valideert de providerconfiguratie en herleidt de gevraagde ID.
  • Als de voorafgaande validatie mislukt, toont onboarding de fout en kun je het opnieuw proberen.
• In de niet-interactieve modus wordt --secret-input-mode ref alleen door de omgeving ondersteund.
  • Stel de omgevingsvariabele van de provider in de procesomgeving voor onboarding in.
  • Inline sleutelvlaggen (bijvoorbeeld --openai-api-key) vereisen dat die omgevingsvariabele is ingesteld; anders mislukt onboarding onmiddellijk.
  • Voor aangepaste providers slaat de niet-interactieve modus ref models.providers.<id>.apiKey op als { source: "env", provider: "default", id: "CUSTOM_API_KEY" }.
  • In dat geval met een aangepaste provider vereist --custom-api-key dat CUSTOM_API_KEY is ingesteld; anders mislukt onboarding onmiddellijk.
• Gateway-authenticatiegegevens ondersteunen bij interactieve installatie zowel platte tekst als SecretRef:
  • Tokenmodus: Platteteksttoken genereren/opslaan (standaard) of SecretRef gebruiken.
  • Wachtwoordmodus: platte tekst of SecretRef.
• Niet-interactief pad voor token-SecretRef: --gateway-token-ref-env <ENV_VAR>.
• Bestaande installaties met platte tekst blijven ongewijzigd werken.

Uitvoer en interne werking

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 dit niet is ingesteld; bestaande expliciete waarden blijven behouden)
• gateway.* (modus, binding, authenticatie, Tailscale)
• session.dmScope (onboarding behoudt expliciete waarden en laat dit anders oningesteld, zodat de standaardwaarde main alle privéberichten van verschillende kanalen in de doorlopende hoofdsessie van de agent bewaart—de standaard voor een persoonlijke agent. Gebruik voor gedeelde inboxen of inboxen met meerdere gebruikers per-channel-peer; openclaw security audit beveelt isolatie aan wanneer verkeer van privéberichten met meerdere gebruikers wordt gedetecteerd)
• channels.telegram.botToken, channels.discord.token, channels.matrix.*, channels.signal.*, channels.imessage.*
• Toestemmingslijsten voor kanalen (Discord, iMessage, Signal, Slack, Telegram, WhatsApp) wanneer je hier tijdens de prompts voor kiest; Discord en Slack zetten ingevoerde namen ook om naar ID's
• skills.install.nodeManager
  • De vlag setup --node-manager accepteert npm, pnpm of bun.
  • Bij handmatige configuratie kan skills.install.nodeManager: "yarn" later nog worden ingesteld.
• wizard.lastRunAt
• wizard.lastRunVersion
• wizard.lastRunCommit
• wizard.lastRunCommand
• wizard.lastRunMode
• wizard.securityAcknowledgedAt

openclaw agents add schrijft agents.entries.* en optioneel bindings.

WhatsApp-aanmeldgegevens komen onder ~/.openclaw/credentials/whatsapp/<accountId>/. Actieve sessies en transcripties worden opgeslagen in ~/.openclaw/agents/<agentId>/agent/openclaw-agent.sqlite. De map ~/.openclaw/agents/<agentId>/sessions/ wordt gebruikt voor invoer voor verouderde migraties en archief-/ondersteuningsartefacten.

Aanbevelingen voor geïnstalleerde apps

Nadat de controle voor modeltoegang is geslaagd, scant de klassieke interactieve onboarding op macOS namen en bundle-ID's van applicaties zonder om privacytoestemming van macOS te vragen. De officiële plugincatalogi en ClawHub worden doorzocht, waarna het geconfigureerde model wordt gevraagd onjuiste naamovereenkomsten af te wijzen en relevante plugins of skills aan te bevelen. Aanbevolen overeenkomsten zijn standaard geselecteerd; optionele overeenkomsten vereisen een expliciete selectie.

Het resultatenscherm vermeldt de gedetecteerde applicaties en toont: "App-namen zijn gekoppeld met behulp van je geconfigureerde model en de zoekfunctie van ClawHub." Stel wizard.appRecommendations in op false om zowel deze onboardingstap als Gateway-toegang tot app-inventarissen van nodes uit te schakelen. De scan wordt niet gebruikt bij quickstart- of niet-macOS-onboarding.

Niet-interactieve installatie

--non-interactive vereist --accept-risk (bevestigt dat agents krachtig zijn en volledige systeemtoegang riskant is):

openclaw onboard --non-interactive --accept-risk \  --auth-choice apiKey \  --anthropic-api-key "$ANTHROPIC_API_KEY"

Volledige naslag voor vlaggen en providerspecifieke voorbeelden: openclaw onboard, CLI-automatisering.

RPC van de Gateway-wizard

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

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

Gedrag bij installatie van Signal

• Downloadt het juiste release-artefact uit de officiële GitHub-releases van signal-cli (native build, alleen Linux x86-64)
• Installeert op andere platforms (macOS, niet-x64 Linux) in plaats daarvan via Homebrew
• Slaat de installatie van het release-artefact op onder ~/.openclaw/tools/signal-cli/<version>/
• Schrijft channels.signal.transport.cliPath met kind: "managed-native" in de configuratie
• Native Windows wordt nog niet ondersteund; voer onboarding uit binnen WSL2 om het Linux-installatiepad te verkrijgen

Gerelateerde documentatie

• Onboardingcentrum: Onboarding (CLI)
• Automatisering en scripts: CLI-automatisering
• Opdrachtnaslag: openclaw onboard