OpenClaw InstallationSetupCLIQuickstartGuide
The core flow you need to know
Script
Recommended: Auto Script
The easiest way. No prerequisites required – the script detects your OS and handles the runtime setup for you.
Package
Developer Option: npm/pnpm
If you already have Node.js 22+ active in your environment, using a standard package manager is natively supported.
Setup
Interactive Onboarding
Once installed, the onboard command guides you through authentications, models, and initial preferences.
CLI
A straightforward CLI
Whether spinning up the Web UI or adding new agents, OpenClaw provides concise commands for your workflows.
Method 1: Script Installation (Recommended)
This is the most straightforward method. You do not need to install Node or configure anything beforehand. The script automatically fetches what it needs and initiates the onboarding process. Add the skip flag to avoid prompts during automated setups.
macOS / Linux / WSL2
Run the Bash script
Downloads the CLI, installs it globally, and automatically launches the onboarding wizard.
Windows
Run the PowerShell script
Answers Node detection and installs the CLI. The example command includes a flag to skip onboarding.
Method 2 Prerequisites
If you choose to skip the automated script and deploy using a Node package manager directly, you must make sure your environment matches these requirements:
Required
- Node.js≥ 22.0.0
- Package Managernpm ≥ 10.0.0 (or pnpm ≥ 8.0.0)
Recommended
- OS SupportLinux, macOS, Windows 10/11
- HardwareAt least 8GB RAM, 2GB free storage
Verify current environment
Package Manager Installation
If you are already familiar with frontend tooling and have Node ready, select from the package manager methods below. We recommend npm (universal) or pnpm (fastest).
Primary Choice
Install via npm
The default and most universal package manager bundled with Node.js.
Recommended
Install via pnpm
If you work heavily with Node, pnpm is often the preferred choice for its speed.
Alternative
Install via bun
If you prefer using the bun runtime tooling, it is fully supported as well.
Final Step
Verify the installation
Run this command to check if the version is printed correctly.
Quickstart: The Detailed 3-Step Flow
With the CLI installed, you need to configure your AI credentials and select a messaging channel. Review the precise steps to get fully operational.
Prerequisites
- Completed OpenClaw installation (via script or package manager)
- Have at least one API Key ready (e.g. OpenAI, DeepSeek, Claude)
- Have a messaging platform account (Telegram, Discord, Feishu, etc.)
Step 1
Run the Onboarding Wizard
This initializes an interactive CLI flow setting up all foundational structures.
Start Config Wizard
Execute this command in your terminal:
- Launches the interactive wizard
- Installs the background daemon (optional)
- Creates necessary configuration files
1. Select Mode
We highly recommend "QuickStart" for an easy setup.
2. Choose AI Provider
Select the model provider you want to use. We suggest an accessible tier like OpenAI or DeepSeek.
3. Enter API Key
Paste the key from your provider console.
- OpenAI: Visit platform.openai.com
- DeepSeek: Visit platform.deepseek.com
- Claude: Visit console.anthropic.com
4. Skip Optionals
For the first run, skipping channels and plugins prevents a bloated setup flow.
5. Launch Web UI
The dashboard serves as your primary visual management hub.
Step 2
Connect a Chat Platform
Link your agent to a messaging app so you can summon it from anywhere.
Fast-track: Telegram (Recommended)
Telegram has the easiest API bridging experience.
- Search for @BotFather in Telegram
- Send /newbot to create a new bot
- Follow prompts to set a name and distinct username
- Copy the provided Bot Token
Return to terminal with the token and run:
- Select Telegram from the CLI menu
- Paste the @BotFather token to finish binding!
Step 3
Test Your Interaction
Time to see the fruits of your setup. Check if your AI is alive!
Method 1: Chat Platform Test
- Open your configured chat (e.g. Telegram)
- Find your bot conversation thread
- Say "Hello, OpenClaw!"
- Wait for a coherent response to verify the full stack.
Method 2: Native CLI Test
Too much hassle connecting a chat? Test it instantly through the terminal:
Common Commands
We compiled the most important CLI commands you will use daily. Keep these handy for administrative tasks or rapid executions.