Naar hoofdinhoud gaan

Documentation Index

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

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

Als je voor het eerst instelt, begin dan met Aan de slag. Zie Onboarding (CLI) voor onboardingdetails.

​
TL;DR

Kies een instelworkflow op basis van hoe vaak je updates wilt en of je de Gateway zelf wilt uitvoeren:
  • Aanpassingen staan buiten de repo: bewaar je configuratie en werkruimte in ~/.openclaw/openclaw.json en ~/.openclaw/workspace/, zodat repo-updates ze niet raken.
  • Stabiele workflow (aanbevolen voor de meeste gebruikers): installeer de macOS-app en laat die de gebundelde Gateway uitvoeren.
  • Bleeding-edge workflow (dev): voer de Gateway zelf uit via pnpm gateway:watch en laat de macOS-app vervolgens verbinden in lokale modus.

​
Vereisten (vanuit broncode)

  • Node 24 aanbevolen (Node 22 LTS, momenteel 22.16+, wordt nog ondersteund)
  • pnpm is vereist voor source checkouts. OpenClaw laadt gebundelde plugins vanuit de extensions/* pnpm-werkruimtepakketten in dev-modus, dus root-npm install bereidt niet de volledige broncodeboom voor.
  • Docker (optioneel; alleen voor gecontaineriseerde setup/e2e - zie Docker)

​
Aanpassingsstrategie (zodat updates geen pijn doen)

Als je “100% op mij afgestemd” en eenvoudige updates wilt, bewaar je je aanpassingen in:
  • Configuratie: ~/.openclaw/openclaw.json (JSON/JSON5-achtig)
  • Werkruimte: ~/.openclaw/workspace (Skills, prompts, memories; maak er een privé-git-repo van)
Bootstrap eenmalig: 
openclaw setup
Gebruik vanuit deze repo de lokale CLI-entry: 
openclaw setup
Als je nog geen globale installatie hebt, voer je dit uit via pnpm openclaw setup.

​
De Gateway vanuit deze repo uitvoeren

Na pnpm build kun je de verpakte CLI direct uitvoeren: 
node openclaw.mjs gateway --port 18789 --verbose

​
Stabiele workflow (macOS-app eerst)

  1. Installeer en start OpenClaw.app (menubalk).
  2. Voltooi de onboarding-/machtigingenchecklist (TCC-prompts).
  3. Zorg dat Gateway Local is en draait (de app beheert dit).
  4. Koppel oppervlakken (voorbeeld: WhatsApp):
openclaw channels login
  1. Sanitycheck:
openclaw health
Als onboarding niet beschikbaar is in je build:
  • Voer openclaw setup uit, daarna openclaw channels login, en start vervolgens de Gateway handmatig (openclaw gateway).

​
Bleeding-edge workflow (Gateway in een terminal)

Doel: werken aan de TypeScript-Gateway, hot reload krijgen en de macOS-app-UI gekoppeld houden.

​
0) (Optioneel) Voer ook de macOS-app vanuit broncode uit

Als je ook de macOS-app op de bleeding edge wilt: 
./scripts/restart-mac.sh

​
1) Start de dev-Gateway

pnpm install
# First run only (or after resetting local OpenClaw config/workspace)
pnpm openclaw setup
pnpm gateway:watch
gateway:watch start of herstart het Gateway-watchproces in een benoemde tmux- sessie en koppelt automatisch vanuit interactieve terminals. Niet-interactieve shells blijven ontkoppeld en tonen tmux attach -t openclaw-gateway-watch-main; gebruik OPENCLAW_GATEWAY_WATCH_ATTACH=0 pnpm gateway:watch om een interactieve run ontkoppeld te houden, of pnpm gateway:watch:raw voor foreground-watchmodus. De watcher herlaadt bij relevante wijzigingen in broncode, configuratie en metadata van gebundelde plugins. Als de bewaakte Gateway tijdens het opstarten afsluit, voert gateway:watch eenmalig openclaw doctor --fix --non-interactive uit en probeert het opnieuw; stel OPENCLAW_GATEWAY_WATCH_AUTO_DOCTOR=0 in om die dev-only reparatiepass uit te schakelen. pnpm openclaw setup is de eenmalige lokale initialisatiestap voor configuratie/werkruimte bij een verse checkout. pnpm gateway:watch bouwt dist/control-ui niet opnieuw, dus voer pnpm ui:build opnieuw uit na wijzigingen in ui/ of gebruik pnpm ui:dev tijdens het ontwikkelen van de Control UI.

​
2) Wijs de macOS-app naar je draaiende Gateway

In OpenClaw.app:
  • Verbindingsmodus: Local De app koppelt aan de draaiende gateway op de geconfigureerde poort.

​
3) Verifieer

  • De Gateway-status in de app moet “Bestaande gateway gebruiken …” tonen
  • Of via CLI:
openclaw health

​
Veelvoorkomende valkuilen

  • Verkeerde poort: Gateway WS gebruikt standaard ws://127.0.0.1:18789; houd app en CLI op dezelfde poort.
  • Waar status wordt opgeslagen:
    • Kanaal-/providerstatus: ~/.openclaw/credentials/
    • Model-authprofielen: ~/.openclaw/agents/<agentId>/agent/auth-profiles.json
    • Sessies: ~/.openclaw/agents/<agentId>/sessions/
    • Logs: /tmp/openclaw/

​
Overzicht credentialopslag

Gebruik dit bij het debuggen van auth of bij het bepalen waarvan je een back-up moet maken:
  • WhatsApp: ~/.openclaw/credentials/whatsapp/<accountId>/creds.json
  • Telegram-bottoken: configuratie/env of channels.telegram.tokenFile (alleen regulier bestand; symlinks geweigerd)
  • Discord-bottoken: configuratie/env of SecretRef (env-/file-/exec-providers)
  • Slack-tokens: configuratie/env (channels.slack.*)
  • Allowlists voor koppelen:
    • ~/.openclaw/credentials/<channel>-allowFrom.json (standaardaccount)
    • ~/.openclaw/credentials/<channel>-<accountId>-allowFrom.json (niet-standaardaccounts)
  • Model-authprofielen: ~/.openclaw/agents/<agentId>/agent/auth-profiles.json
  • File-backed secrets-payload (optioneel): ~/.openclaw/secrets.json
  • Legacy OAuth-import: ~/.openclaw/credentials/oauth.json Meer details: Beveiliging.

​
Updaten (zonder je setup te slopen)

  • Beschouw ~/.openclaw/workspace en ~/.openclaw/ als “jouw spullen”; zet geen persoonlijke prompts/configuratie in de openclaw-repo.
  • Broncode updaten: git pull + pnpm install + blijf pnpm gateway:watch gebruiken.

​
Linux (systemd-gebruikersservice)

Linux-installaties gebruiken een systemd-gebruikersservice. Standaard stopt systemd gebruikers- services bij afmelden/inactiviteit, waardoor de Gateway wordt beëindigd. Onboarding probeert lingering voor je in te schakelen (kan om sudo vragen). Als het nog steeds uit staat, voer je uit: 
sudo loginctl enable-linger $USER
Voor always-on of multi-user servers kun je een systeemservice overwegen in plaats van een gebruikersservice (geen lingering nodig). Zie Gateway-runbook voor de systemd-notities.

​
Gerelateerde docs