OpenClaw
GitHubGet Started
6 Steps to Deploy

OpenClaw Getting Started

Follow these steps to install and configure OpenClaw from scratch

Quickest Path

Just want to try it out? One command starts the Dashboard for instant chatting:

$ openclaw dashboard
http://127.0.0.1:18789/

OpenClaw Requirements

Before you begin, make sure your system meets these requirements

Node.js ≥ 22

Required to run OpenClaw

Operating System

macOS, Linux, or Windows (WSL2 recommended)

Brave Search API (Optional)

Enables web search functionality

Windows
Windows users are strongly recommended to use WSL2 for better compatibility and performance.
1

Install OpenClaw

Choose your preferred installation method. One-liner is recommended

$ curl -fsSL https://openclaw.ai/install.sh | bash
The one-liner automatically detects and installs Node.js and all dependencies. No manual setup required.
2

OpenClaw Configuration Wizard

The wizard will guide you through all necessary setup including gateway, authentication, and chat platform connections

$ openclaw onboard --install-daemon

The wizard will configure

  • Gateway Type - Choose local or remote gateway
  • AI Model Auth - OpenAI (OAuth/API Key) or Anthropic (API Key recommended, claude setup-token also supported)
  • Chat Platforms - WhatsApp QR code, Telegram/Discord Bot Token, etc.
  • Daemon Service - Background service installation (macOS: launchd, Linux/WSL2: systemd)
Config File Locations (Important)
  • Main config directory~/.openclaw/
  • OAuth credentials~/.openclaw/credentials/oauth.json
  • Auth profiles (OAuth + API Key)~/.openclaw/agents/<agentId>/agent/auth-profiles.json
If you have Claude Code installed, you can reuse existing credentials via claude setup-token without reconfiguring.
Headless server tip: Complete OAuth on a machine with a browser first, then copy the oauth.json file to the server's corresponding directory.
3

Start OpenClaw Gateway

The gateway is OpenClaw's core service that handles all messages

Check service status

$ openclaw gateway status

Start gateway manually (to specify port)

$ openclaw gateway --port 18789

Access Web Dashboard

http://127.0.0.1:18789/
Quick Verify (confirm service is running)
$ openclaw status
$ openclaw health
$ openclaw security audit --deep
4

Connect Chat Platforms

Pair and connect your first chat interface

WhatsApp (QR Code Login)

$ openclaw channels login

Run the command to display a QR code. Open WhatsApp → Settings → Linked Devices → Scan the QR code to connect.

A dedicated phone number is recommended. VoIP numbers are not recommended (easily blocked). Credentials are stored in ~/.openclaw/credentials/whatsapp/ directory.

Telegram / Discord / Others

The wizard can help configure tokens. If you prefer manual setup, see these docs:

Telegram tip: Your first DM will return a pairing code. You need to approve it (see next step), otherwise the bot won't respond.
5

OpenClaw Security Setup

Ensure only authorized users can use your AI assistant

Default behavior: Unknown DMs receive a short code, and messages won't be processed until approved. If your first DM doesn't get a reply, approve the pairing:

List pending pairing requests

$ openclaw pairing list whatsapp

Approve pairing (replace [code] with actual code)

$ openclaw pairing approve whatsapp <code>
This is an important security measure to prevent unauthorized access. You can also set up an allowlist in the config file to automatically allow specific numbers.
6

Verify OpenClaw

In a new terminal, send a test message

Send test message (replace with your target number)

$ openclaw message send --target +15555550123 --message "Hello from OpenClaw"
If openclaw health shows "auth not configured", go back to the wizard and set up OAuth/API key auth—without it, the agent won't respond.

Debug Tips

  • openclaw status --allBest copy-pasteable, read-only debug report
  • openclaw healthoropenclaw status --deepRequests health snapshot from running gateway

OpenClaw Setup Complete

Congratulations! You've successfully installed and configured OpenClaw. Start chatting with your AI assistant now.