Home

Switch language

Start Install GuideQuick StartDocs Overview
Docs ChannelsModels & APIGateway OpsTools & Skills
More ArticlesResourcesHelp Center
Get Started
Documentation navigation Getting Started
Getting Started 4 sections 3 key facts

Install Guide

Install Guide

Best for first deployments when you want to finish environment checks, installation choice, onboarding launch and first verification from a single page. The default recommendation is Node 22+ with the standard openclaw onboard path.

Check Before Installing

Verify the runtime first so the CLI, services and channels do not fail after install.

Runtime

Node 22 or later

OpenClaw runs on TypeScript and Node. Bun still has compatibility gaps for WhatsApp and Telegram, so do not use it for the Gateway.

Windows

Prefer WSL2

Native Windows paths are more fragile. Use the Linux install flow inside WSL2 and keep the service there as well.

macOS

CLI is enough, apps need Xcode / CLT

If you only run the CLI and Gateway, Node is enough. Only prepare extra toolchains when you want to build the macOS companion app.

Optional

Brave Search API and Docker

Brave Search API is recommended for web search features. Docker only matters if you need containerized or specific end-to-end workflows.

Installation Methods

If you want stable daily use, pick the script first. Use source install only when you need development and hot reload.

One-line install

The shortest path, recommended for new users and normal deployments.
curl -fsSL https://openclaw.ai/install.sh | bash

npm / pnpm install

Useful when you already maintain Node globally and prefer a package manager.
npm install -g openclaw@latest
pnpm add -g openclaw@latest

Build from source

For tracking latest code, modifying Gateway internals or local debugging.
git clone https://github.com/openclaw/openclaw.git
cd openclaw
pnpm install
pnpm ui:build
pnpm build

Standard Install Flow

If you are unsure what to do next, use this order and do not branch early.

1. Check the environment

Make sure node -v reports 22+ and decide whether deployment is local, WSL2, a Linux host or a VPS.

2. Complete installation

Run the install script or global npm / pnpm install until the openclaw command works in your shell.

3. Launch onboarding

Run openclaw onboard --install-daemon to configure model auth, Gateway, channels and background services.

4. Verify the control interface

Use openclaw gateway status or openclaw dashboard to confirm you can reach the local or remote Gateway.

5. Add channels or stay on Dashboard

If you need WhatsApp, Telegram or Discord, continue to channel setup. Otherwise you can start from Control UI immediately.