Metadata-Version: 2.4
Name: openclaw-installer
Version: 1.0.33
Summary: Installer for OpenClaw - installs OpenClaw and starts the gateway
Project-URL: Homepage, https://github.com/openclaw/openclaw-installer
Project-URL: Documentation, https://github.com/openclaw/openclaw-installer#readme
Project-URL: Repository, https://github.com/openclaw/openclaw-installer
Project-URL: Issues, https://github.com/openclaw/openclaw-installer/issues
Author-email: Gerald Enrique Nelson Mc Kenzie <lordxmen2k@gmail.com>
License: MIT
Keywords: ai,assistant,automation,claude,installer,kimi,openclaw
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: System :: Installation/Setup
Classifier: Topic :: Utilities
Requires-Python: >=3.9
Requires-Dist: rich>=13.0
Requires-Dist: typer>=0.12.0
Provides-Extra: dev
Requires-Dist: black>=23.0; extra == 'dev'
Requires-Dist: build>=1.0; extra == 'dev'
Requires-Dist: mypy>=1.0; extra == 'dev'
Requires-Dist: pytest>=7.0; extra == 'dev'
Requires-Dist: twine>=5.0; extra == 'dev'
Description-Content-Type: text/markdown

# OpenClaw Installer

A simple, zero-configuration installer for [OpenClaw](https://openclaw.ai) 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)

```bash
# 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

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

# Run installer
openclaw-installer install
```

## Usage

### Install OpenClaw

```bash
openclaw-installer install
```

This will:
- Set up Node.js in an isolated directory
- Install OpenClaw
- Start the gateway on http://localhost:18789

### Open Dashboard

```bash
openclaw dashboard
```

Or manually open http://localhost:18789 in your browser.

### Uninstall

```bash
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:

```bash
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

```bash
$ 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:

```bash
# 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:

```bash
openclaw gateway status
```

If not running, start it manually:

```bash
openclaw gateway start
```

### Wrapper not found

Make sure the bin directory is in your PATH:

```bash
# macOS/Linux
export PATH="$HOME/.local/share/openclaw-installer/bin:$PATH"

# Windows (PowerShell)
$env:PATH = "$env:LOCALAPPDATA\openclaw-installer\bin;$env:PATH"
```

## License

MIT
