ClawPort -- Setup Guide

ClawPort -- Setup Guide

This guide walks you through getting ClawPort running against your own OpenClaw instance. If you just want the quick version, see the [README](README.md).

---

Prerequisites

undefined

---

0. Setting Up OpenClaw

ClawPort connects to [OpenClaw](https://openclaw.ai), an open-source, self-hosted AI assistant that runs locally on your machine. If you already have OpenClaw running, skip to [step 1](#1-install-clawport).

Install OpenClaw

# macOS / Linux
curl -fsSL https://openclaw.ai/install.sh | bash

# Or via npm (requires Node 22+)
npm install -g openclaw

Windows: `iwr -useb https://openclaw.ai/install.ps1 | iex`

Verify the install:

openclaw --version

Run the Onboarding Wizard

The onboarding wizard sets up your workspace, configures the gateway, and installs it as a background daemon:

openclaw onboard --install-daemon

This creates:

What	Where
Config file	~/.openclaw/openclaw.json
Workspace	~/.openclaw/workspace/
Agent SOUL files	~/.openclaw/workspace/agents/
Memory	~/.openclaw/workspace/memory/
Credentials	~/.openclaw/credentials/

Verify the Gateway

The gateway is the local server that handles all AI operations. ClawPort talks to it at `localhost:18789` by default. If you use a custom port, set `OPENCLAW_GATEWAY_PORT` in `.env.local`.

openclaw gateway status

You should see the gateway URL, port, and auth token. If the gateway isn't running:

openclaw gateway run

Key Concepts

undefined

For more detail, see the [OpenClaw documentation](https://docs.openclaw.ai/getting-started).

---

1. Install ClawPort

**Note:** The npm package is `clawport-ui`. The CLI command is `clawport`. Do not install the unrelated `clawport` package.

# Install globally (package: clawport-ui, command: clawport)
npm install -g clawport-ui

# Or clone the repo
git clone https://github.com/JohnRiceML/clawport-ui.git
cd clawport-ui
npm install

---

2. Configure Environment

The fastest way is the auto-setup script:

# If installed globally via npm
clawport setup

# Or if running from source
npm run setup

This auto-detects your `WORKSPACE_PATH` (checks both current