Getting started
This page takes you from zero to a running WednesdayAI gateway with the control panel accessible. Channel setup — connecting WhatsApp, Telegram, iMessage, and others — comes after the gateway is stable.Fastest path to a first chat: once the gateway is running, open
http://127.0.0.1:18789/ in a browser on the same machine. The built-in control panel lets you chat with your AI without connecting any external channel first.Requirements
- Node.js 24 or newer — the installer script installs it automatically if missing
- macOS, Linux, or Windows (via WSL2) — native Windows is supported but WSL2 is recommended
- About 500 MB free disk space (including node modules)
v24.x.x or higher you are ready. Otherwise let the installer handle it, or install via nvm / fnm first.
WhatsApp and Telegram require the gateway to run on Node, not Bun. Version-managed Node paths (nvm, fnm, volta) can break a background service after upgrades —
openclaw doctor warns and offers to migrate to a system Node install.Step 1 — Install
The installer script is the recommended path. It detects your Node version, installs or upgrades it if needed, installs theopenclaw CLI globally, and launches the onboarding wizard.
- macOS / Linux / WSL2
- Windows (PowerShell)
- npm (manual)
pnpm global install
pnpm global install
pnpm needs an extra step to approve packages with native build scripts:
Step 2 — Run the onboarding wizard
If the installer completed successfully it already ran the wizard. After a manual npm install, run:- Model and auth — choose an AI provider and authenticate. It supports Anthropic (API key or
claude setup-token) and OpenAI Codex (OAuth) among others. You can add more later viaopenclaw onboardoropenclaw models auth .... - Gateway port — defaults to
18789. Change it here if that port is in use. - System service —
--install-daemoninstalls the gateway as a background service so it starts at login. Recommended for persistent deployments.
Rerun the wizard at any time with
openclaw onboard. Provider auth can also be added directly: openclaw models auth paste-token --provider anthropic or openclaw models auth login --provider <provider>.Step 3 — Verify the gateway
- Linux (systemd)
- Foreground (any platform)
Step 4 — Open the control panel
http://127.0.0.1:18789/. If the gateway runs on a remote server, see Remote access.
If the control panel loads and you can send a test message, your gateway is ready.
Step 5 — Run a health check
openclaw doctor validates your config, checks configured channels and providers, and reports missing credentials or unknown config keys. Fix any warnings before moving on.
What you have now
| Component | Status |
|---|---|
openclaw CLI | Installed globally |
| Gateway | Running as a background service |
| Auth | At least one AI provider connected |
| Control panel | Accessible at http://localhost:18789/ |
Next steps
Gateway configuration
Tune port, bind, auth, model routing, and all other gateway settings.
Connect channels
Add WhatsApp, Telegram, iMessage, Signal, Slack, Discord, and more.
AI providers
API keys, OAuth, and model selection.
Remote access
Reach the gateway securely from outside localhost.
Troubleshooting
`openclaw` command not found after install
`openclaw` command not found after install
The npm global bin directory is not in your PATH:
Gateway fails to start — port already in use
Gateway fails to start — port already in use
Change the port in Then restart:
~/.openclaw/openclaw.json:systemctl --user restart openclaw-gateway (Linux) or openclaw gateway start (macOS/manual).Onboarding wizard exits without completing
Onboarding wizard exits without completing
The wizard requires an active TTY. Over SSH without a PTY, add Or complete the wizard locally and copy
-t:~/.openclaw/openclaw.json to the server.`openclaw doctor` reports unknown config keys
`openclaw doctor` reports unknown config keys
Unknown top-level keys stop the gateway from starting. Remove them, or run
openclaw doctor --fix (check the diff before restarting).