Getting Started
Install OpenClaw, run onboarding, and chat with your AI assistant — all in about 5 minutes. By the end you will have a running Gateway, configured auth, and a working chat session.What you need
- Node.js — Node 24 recommended (Node 22.14+ also supported)
- An API key from a model provider (Anthropic, OpenAI, Google, etc.) — onboarding will prompt you
Quick setup
Install OpenClaw
- macOS / Linux
- Windows (PowerShell)
Other install methods (Docker, Nix, npm): Install.
Run onboarding
Advanced: mount a custom Control UI build
Advanced: mount a custom Control UI build
If you maintain a localized or customized dashboard build, point
Then set:Restart the gateway and reopen the dashboard:
gateway.controlUi.root to a directory that contains your built static
assets and index.html.What to do next
Connect a channel
Discord, Feishu, iMessage, Matrix, Microsoft Teams, Signal, Slack, Telegram, WhatsApp, Zalo, and more.
Pairing and safety
Control who can message your agent.
Configure the Gateway
Models, tools, sandbox, and advanced settings.
Browse tools
Browser, exec, web search, skills, and plugins.
Advanced: environment variables
Advanced: environment variables
If you run OpenClaw as a service account or want custom paths:
OPENCLAW_HOME— home directory for internal path resolutionOPENCLAW_STATE_DIR— override the state directoryOPENCLAW_CONFIG_PATH— override the config file path