Skip to main content

Installer for OpenClaw - installs OpenClaw and starts the gateway

Reason this release was yanked:

cleanup

Project description

OpenClaw Installer

A simple, zero-configuration installer for OpenClaw that works on Windows, macOS, and Linux.

What It Does

This installer:

  1. Downloads and installs Node.js v22.16.0 (isolated, doesn't affect system)
  2. Installs OpenClaw from npm
  3. Starts the OpenClaw gateway on port 18789
  4. 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
pipx install openclaw-installer

# Install OpenClaw
openclaw-installer install

Install from Source

git clone https://github.com/yourusername/openclaw-installer.git
cd openclaw-installer
pipx install .

# Run installer
openclaw-installer install

Usage

Install OpenClaw

openclaw-installer install

This will:

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:

  1. Go back to your browser (the dashboard should already be open at http://127.0.0.1:18789)
  2. Refresh the page (press F5 or Ctrl+R / Cmd+R)
  3. 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?

  1. Gateway is running on port 18789
  2. Dashboard opens automatically in your browser
  3. You run openclaw onboard to configure AI providers
  4. 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

openclaw_installer-1.0.34.tar.gz (61.9 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

openclaw_installer-1.0.34-py3-none-any.whl (29.3 kB view details)

Uploaded Python 3

File details

Details for the file openclaw_installer-1.0.34.tar.gz.

File metadata

  • Download URL: openclaw_installer-1.0.34.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

Hashes for openclaw_installer-1.0.34.tar.gz
Algorithm Hash digest
SHA256 b59820b70d3b12dcc183753934def12abe7cdffd3e18fc40e04dad58301e991e
MD5 8a274ef04a98d8cd13e1bc1fbfcaf58f
BLAKE2b-256 1e6d2b4bcd5f9191440bb43acea01f44d91cc7405a06cd3ae4784006b511d058

See more details on using hashes here.

File details

Details for the file openclaw_installer-1.0.34-py3-none-any.whl.

File metadata

File hashes

Hashes for openclaw_installer-1.0.34-py3-none-any.whl
Algorithm Hash digest
SHA256 6b0d90412eec3cc85dd16629334e2391c09cc15b67cd68983a6e964fbfc1d6fa
MD5 887110c155cb68d493c00b6d4d5e05f5
BLAKE2b-256 a2eae986e448532f41f1ae1498cb42577a01d79fc4e70ef8a4add69b60f0c690

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page