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.
Author: Gerald Enrique Nelson Mc Kenzie
What It Does
This installer handles everything in one command:
- Downloads and installs Node.js v22.16.0 (isolated, doesn't affect your system)
- Installs OpenClaw from npm
- Starts the OpenClaw gateway on port 18789
- Opens the dashboard in your browser
No complex configuration needed.
Installation
Prerequisites: Python 3.10+ and an internet connection.
# Install pipx if you don't have it
pip install pipx
pipx ensurepath
# Install the OpenClaw Installer
pipx install openclaw-installer
# Run the installer
openclaw-installer install
Usage
Install OpenClaw
openclaw-installer install
Sets up Node.js in an isolated directory, installs OpenClaw, and starts the gateway at http://localhost:18789.
Open the Dashboard
openclaw dashboard
Or open http://localhost:18789 directly in your browser.
Uninstall
openclaw-installer uninstall
Configure OpenClaw (Required After Install)
Step 1: Run the onboard command
openclaw onboard
This starts an interactive setup where you choose your AI provider and enter your API key:
$ 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
Step 2: Refresh the dashboard
Go back to your browser at http://127.0.0.1:18789 and press F5 (or Ctrl+R / Cmd+R). Your configured AI providers will appear and you're ready to use OpenClaw.
Commands
| Command | Description |
|---|---|
openclaw-installer install |
Install OpenClaw and start the gateway |
openclaw-installer uninstall |
Remove the OpenClaw installation |
openclaw-installer dashboard |
Open the OpenClaw dashboard |
openclaw-installer --help |
Show help |
Installation Locations
Everything is stored in isolated directories — no system files are modified.
- Windows:
%LOCALAPPDATA%\openclaw-installer\ - macOS / Linux:
~/.local/share/openclaw-installer/
OpenClaw's own configuration lives in ~/.openclaw/ and is not touched by the installer.
Requirements
- Windows 10/11, macOS 12+, or Linux
- ~200MB free disk space
- Internet connection for initial download
Troubleshooting
Port 18789 is already in use
Find and stop the process using that port:
# macOS / Linux
lsof -i :18789
# Windows
netstat -ano | findstr 18789
Gateway not starting
Check the gateway status and start it manually if needed:
openclaw gateway status
openclaw gateway start
Command not found after install
Make sure the bin directory is on 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 License — see LICENSE
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.36.tar.gz.
File metadata
- Download URL: openclaw_installer-1.0.36.tar.gz
- Upload date:
- Size: 203.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
655348a59522c8ddec52e024c5caa670693de70fb89274be67eaa0651f64349a
|
|
| MD5 |
2cf26a6451a648be6592b0e3b9ef1f56
|
|
| BLAKE2b-256 |
585df9edc4696b3a87c35ce1ce0fd324b87a2ac7257f8c4fa914695a691c0007
|
File details
Details for the file openclaw_installer-1.0.36-py3-none-any.whl.
File metadata
- Download URL: openclaw_installer-1.0.36-py3-none-any.whl
- Upload date:
- Size: 29.1 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 |
a3912094169c6d9dfc174c62572b8d6d719306313a9ab3cc12351ed642f3d450
|
|
| MD5 |
c0081d46d1b22c49aab125cc4a9d4e0d
|
|
| BLAKE2b-256 |
9b7222c7741c7de61eb3697e8d46aa47b6c15d44df7a736b5ebd204255440621
|