Installer for OpenClaw - installs OpenClaw and starts the gateway
Project description
OpenClaw Installer
A simple, zero-configuration installer for OpenClaw that works on Windows, macOS, and Linux.
What It Does
This installer:
- Downloads and installs Node.js v22.16.0 (isolated, doesn't affect system)
- Installs OpenClaw from npm
- Starts the OpenClaw gateway on port 18789
- Opens the dashboard in your browser
That's it. No complex configuration needed.
Installation
Prerequisites
- Python 3.10+
- Internet connection
Install via pipx (Recommended)
# Install pipx if you don't have it
pip install pipx
pipx ensurepath
# Install OpenClaw-Installer (Python Environment)
pipx install openclaw-installer
# Initialize OpenClaw Gateway (Application Setup)
openclaw-installer install
Usage
Install OpenClaw-Installer
openclaw-installer install
This will:
- Set up Node.js in an isolated directory
- Install OpenClaw
- Start the gateway on http://localhost:18789
Open Dashboard
openclaw dashboard
Or manually open http://localhost:18789 in your browser.
Uninstall
openclaw-installer uninstall
Configure OpenClaw (Required After Install)
After installation, you need to configure OpenClaw with your AI provider credentials:
Step 1: Run the Onboard Command
Open a terminal and run:
openclaw onboard
This will start an interactive setup where you can:
- Choose your AI provider (Kimi, Anthropic, OpenAI, etc.)
- Enter your API key for the selected provider
- Configure additional settings as prompted
Step 2: Refresh the Dashboard
Once onboarding is complete:
- Go back to your browser (the dashboard should already be open at http://127.0.0.1:18789)
- Refresh the page (press F5 or Ctrl+R / Cmd+R)
- The dashboard will now show your configured AI providers and be ready to use!
Example: Kimi Setup
$ openclaw onboard
? Select authentication provider: (Use arrow keys)
❯ Kimi
Anthropic
OpenAI
Skip (configure later)
? Enter your Kimi API key: sk-xxxxxxxxxxxxxxxxxxxxxxxx
✓ Configuration saved to ~/.openclaw/openclaw.json
Then refresh your browser and you're ready to go!
What Happens After Install?
- Gateway is running on port 18789
- Dashboard opens automatically in your browser
- You run
openclaw onboardto configure AI providers - Refresh the dashboard to see your configured providers
OpenClaw stores its configuration in ~/.openclaw/ - the installer doesn't touch these files.
Installation Locations
- Windows:
%LOCALAPPDATA%\openclaw-installer\ - macOS/Linux:
~/.local/share/openclaw-installer/
Everything is isolated in these directories. No system files are modified.
Commands
| Command | Description |
|---|---|
openclaw-installer install |
Install OpenClaw and start gateway |
openclaw-installer uninstall |
Remove OpenClaw installation |
openclaw-installer dashboard |
Open the OpenClaw dashboard |
openclaw-installer --help |
Show help |
Requirements
- Windows 10/11, macOS 12+, or Linux
- ~200MB free space
- Internet connection for initial download
Troubleshooting
Port 18789 in use
If port 18789 is already in use, stop the existing process:
# Find what's using the port
lsof -i :18789 # macOS/Linux
netstat -ano | findstr 18789 # Windows
# Or use a different port in OpenClaw's dashboard after install
Gateway not starting
Check if the gateway is running:
openclaw gateway status
If not running, start it manually:
openclaw gateway start
Wrapper not found
Make sure the bin directory is in your PATH:
# macOS/Linux
export PATH="$HOME/.local/share/openclaw-installer/bin:$PATH"
# Windows (PowerShell)
$env:PATH = "$env:LOCALAPPDATA\openclaw-installer\bin;$env:PATH"
License
MIT
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file openclaw_installer-1.0.35.tar.gz.
File metadata
- Download URL: openclaw_installer-1.0.35.tar.gz
- Upload date:
- Size: 61.9 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
3938570f52c521e751803bfd9c642d10a5643044dec2e67afd10a2caf269f3cc
|
|
| MD5 |
4f1cb351371adcf63aa02ee733b47698
|
|
| BLAKE2b-256 |
f0715de2ea3829000ef4e59320fbea3b17c2a3844a325aebac8376d8ddc5efa0
|
File details
Details for the file openclaw_installer-1.0.35-py3-none-any.whl.
File metadata
- Download URL: openclaw_installer-1.0.35-py3-none-any.whl
- Upload date:
- Size: 29.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
51ed0bdcc604c66855a8b6fc22fbbeba781feec39a69b8d8779832c9cbed052a
|
|
| MD5 |
70036a149ba44a6946cbce8d27dfe085
|
|
| BLAKE2b-256 |
4bcd0d9d0f33414efe1b66a6d36624b1b9c63cc32913cfb4045f16b6ab4ea32c
|