Getting Started
Getting Started
Section titled “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
Section titled “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
Section titled “Quick setup”Install OpenClaw
Terminal window curl -fsSL https://openclaw.ai/install.sh | bashTerminal window iwr -useb https://openclaw.ai/install.ps1 | iexRun onboarding
Terminal window openclaw onboard --install-daemonThe wizard walks you through choosing a model provider, setting an API key, and configuring the Gateway. It takes about 2 minutes.
See Onboarding (CLI) for the full reference.
Verify the Gateway is running
Terminal window openclaw gateway statusYou should see the Gateway listening on port 18789.
Open the dashboard
Terminal window openclaw dashboardThis opens the Control UI in your browser. If it loads, everything is working.
Send your first message
Advanced: mount a custom Control UI build
If you maintain a localized or customized dashboard build, point
gateway.controlUi.root to a directory that contains your built static
assets and index.html.
mkdir -p "$HOME/.openclaw/control-ui-custom"# Copy your built static files into that directory.Then set:
{ "gateway": { "controlUi": { "enabled": true, "root": "$HOME/.openclaw/control-ui-custom" } }}Restart the gateway and reopen the dashboard:
openclaw gateway restartopenclaw dashboardWhat to do next
Section titled “What to do next”Discord, Feishu, iMessage, Matrix, Microsoft Teams, Signal, Slack, Telegram, WhatsApp, Zalo, and more.
Control who can message your agent.
Models, tools, sandbox, and advanced settings.
Browser, exec, web search, skills, and plugins.
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
Full reference: Environment variables.