← Back to Plugins
Channels

ClawWizard

openkrab By openkrab 👁 61 views ▲ 0 votes

ClawWizard is a premium, interactive setup wizard for OpenClaw, your personal AI assistant. It provides a full-featured GUI for configuring every aspect of the OpenClaw Gateway, from model providers to messaging channels and agent skills.

GitHub

Install

npm install
   ```

README

# 🦞 ClawWizard

**ClawWizard** is a premium, interactive setup wizard for [OpenClaw](https://github.com/openclaw/openclaw), your personal AI assistant. It provides a full-featured GUI for configuring every aspect of the OpenClaw Gateway — from model providers to messaging channels, agent workspace, persona templates, and one-click deployment.

<p align="center">
  <img src="/public/banner.png" alt="ClawWizard Banner" width="700">
</p>

## ✨ Features

- **🎯 Interactive Onboarding**: Step-by-step wizard guidance for beginners and power users alike.
- **🤖 Provider & Model Picker**: Support for 20+ LLM providers including Anthropic, OpenAI, Kilocode, Ollama, OpenRouter, Groq, Gemini, DeepSeek, Mistral, and more.
- **💬 Channel Management**: Easy configuration for **20+ platforms** — WhatsApp, Telegram, Discord, Slack, Signal, iMessage, BlueBubbles, LINE, Matrix, Nextcloud Talk, Microsoft Teams, Feishu, Mattermost, Google Chat, Tlon, Nostr, IRC, Twitch, Zalo, Synology Chat.
- **👥 Group Chat Support**: Per-group access control with `groupPolicy` (allowlist/blocklist/public) and per-group `requireMention` settings.
- **🔐 Pairing Workflow**: Guided DM pairing flow for secure private messaging (via `openclaw pairing approve`).
- **🎭 Workspace Templates**: 15+ pre-built persona and config templates for every OpenClaw system file (`AGENTS.md`, `SOUL.md`, `IDENTITY`, `BOOT.md`, `BOOTSTRAP.md`, `HEARTBEAT.md`, `TOOLS.md`, `USER`). Includes AI-agent styles, funny troll personas, and professional presets.
- **🛠️ Tools & Skills**: Select and configure tool groups for your AI agent.
- **🚀 Live Deployment**: One-click deployment that writes config files directly to `~/.openclaw/`, starts the gateway, and **auto-opens the OpenClaw Dashboard & TUI** in your browser and terminal.
- **🛰️ Log Streaming**: Watch your AI assistant come to life with real-time log streaming in a web-based terminal.
- **💎 Premium Design**: Dark-mode glassmorphism interface with fluid animations and micro-interactions.

---

## 🗺️ Wizard Flow

```mermaid
flowchart TD
    A([🦞 Start ClawWizard]) --> B

    subgraph STEP1["Step 1 · Welcome"]
        B[Choose Use Case\nPersonal / Coding / Research\nAutomation / Trading / Custom]
        B --> B2[Pick a pre-built Template\nor start blank]
    end

    B2 --> C

    subgraph STEP2["Step 2 · Model & Auth"]
        C[Select LLM Provider\n20+ providers available]
        C --> C2{Uses API Key?}
        C2 -- Yes --> C3[Enter API Key\nor skip]
        C2 -- No --> C4[OAuth / Local\ne.g. Ollama, Qwen]
    end

    C3 & C4 --> D

    subgraph STEP3["Step 3 · Workspace & Persona"]
        D[Edit OpenClaw system files]
        D --> D1[SOUL.md · Personality]
        D --> D2[AGENTS.md · Behavior rules]
        D --> D3[IDENTITY · Name & emoji]
        D --> D4[BOOT / HEARTBEAT / TOOLS / USER]
        D1 & D2 & D3 & D4 --> D5[🎭 Mix & match Templates\nAppend or replace per file]
    end

    D5 --> E

    subgraph STEP4["Step 4 · Gateway"]
        E[Configure Gateway\nPort / Bind / Tailscale / Auth mode]
    end

    E --> F

    subgraph STEP5["Step 5 · Channels"]
        F[Enable Messaging Channels\nWhatsApp · Telegram · Discord · Slack\nSignal · Matrix · LINE · Zalo · ...]
        F --> F2{Group Chat?}
        F2 -- Yes --> F3[Set groupPolicy\nallowlist / requireMention\nResolve Group ID via CLI]
        F2 -- No --> F4[Set dmPolicy\npairing / public]
    end

    F3 & F4 --> G

    subgraph STEP6["Step 6 · Tools & Skills"]
        G[Select Tool Groups\nFilesystem · Browser · Terminal\nCode Exec · Memory · Cron]
    end

    G --> H

    subgraph STEP7["Step 7 · Preview & Deploy"]
        H[Review openclaw.json config]
        H --> I{Deploy mode?}
        I -- Live Deploy --> J[🚀 Write config to ~/.openclaw/\nStart Gateway\nHealth check]
        I -- Manual --> K[📋 Copy CLI commands\nor download openclaw.json]
    end

    J --> L[✅ Gateway Online!\nOpens Dashboard 🌐\nOpens TUI 💻]
    K --> M[⚙️ Run: openclaw onboard\nThen: openclaw pairing approve]

    style A fill:#ff6b35,color:#fff,stroke:none
    style L fill:#22c55e,color:#fff,stroke:none
    style STEP1 fill:#1a1a2e,stroke:#ff6b35,color:#fff
    style STEP2 fill:#1a1a2e,stroke:#ff6b35,color:#fff
    style STEP3 fill:#1a1a2e,stroke:#ff6b35,color:#fff
    style STEP4 fill:#1a1a2e,stroke:#ff6b35,color:#fff
    style STEP5 fill:#1a1a2e,stroke:#ff6b35,color:#fff
    style STEP6 fill:#1a1a2e,stroke:#ff6b35,color:#fff
    style STEP7 fill:#1a1a2e,stroke:#ff6b35,color:#fff
```

---

## 💡 Manual for Complete Beginners (No Tech Skills Required!)

If you've never used a coding program or don't know what a "Terminal" is, don't worry! Follow these simple steps and you'll have ClawWizard running in no time.

### 1. Get the Engine Ready (Easy Mode 🚀)

You need the "engine" to run this app. You have two choices:

- **Option 1 (Automatic)**: Find the file named `install_nodejs.ps1` in this folder, **right-click it**, and select **"Run with PowerShell"**. The system will download and install Node.js for you automatically!
- **Option 2 (Manual)**: Go to [nodejs.org](https://nodejs.org/) and click the button that says **"LTS"** to download and install it manually.

### 2. How to Open the App (The easy way)

**For Windows:**

1. Go to the `ClawWizard` folder you downloaded.
2. Click on the **address bar** at the top of the folder window (where it says `D:\Projects\...`).
3. Type the word `cmd` and press **Enter**.
   - *A black window will pop up. That is the Terminal (or Command Prompt).*
4. Type this command into the black window and press Enter:

   ```bash
   npm install
   ```

   *(Wait for it to finish. Do not close this window!)*
5. Once it's done, type the final command to start the app:

   ```bash
   npm run dev
   ```

### 3. Start Using It

- After typing the last command, your browser should open to a beautiful interface. (If it doesn't, copy and paste `http://localhost:5173` into Chrome).
- **Follow the on-screen instructions**: The wizard will ask you questions one by one. Just fill in the info as requested.
- **Top Tip**: When you reach the last step, click the purple **"Deploy Now"** button. The app will handle the rest — it will write all your config files, start the OpenClaw Gateway, and automatically open the **Control Dashboard** and **Terminal UI** for you. No more coding required!

---

## Getting Started

### Prerequisites

- **Node.js**: v22.0.0 or higher
- **OpenClaw CLI**: Recommended for full deployment functionality

  ```bash
  npm install -g openclaw@latest
  ```

### Installation

1. Clone the repository:

   ```bash
   git clone https://github.com/openkrab/ClawWizard.git
   cd ClawWizard
   ```

2. Install dependencies:

   ```bash
   npm install
   ```

3. Run in development mode:

   ```bash
   npm run dev
   ```

   *This command runs both the Vite frontend and the Node.js bridge server concurrently.*

### 🐳 Docker Deployment (Optional)

If you prefer to run ClawWizard in a container:

1. **Build and Start**:
   ```bash
   docker-compose up -d
   ```

2. **Access the App**:
   Open [http://localhost:5173](http://localhost:5173) in your browser.

> [!NOTE]
> The Docker setup automatically mounts `~/.openclaw` to persist your configurations.

---

4. Open [http://localhost:5173](http://localhost:5173) in your browser.


---

## 📸 Screenshots

<p align="center">
  <img src="assets/step1_welcome.png" width="400" alt="Step 1: Welcome">
  <img src="assets/step2_model.png" width="400" alt="Step 2: Model Auth">
  <img src="assets/step3_workspace.png" width="400" alt="Step 3: Workspace">
  <img src="assets/step4_gateway.png" width="400" alt="Step 4: Gateway">
  <img src="assets/step5_channels.png" width="400" alt="Step 5: Channels">
  <img src="assets/step6_tools.png" width="400" alt="Step 6: Tools">
</p>

---

## 🎭 Workspace Templates

ClawWizard includes a rich library of pre-built templates for every OpenClaw system file. Mix and match to build the perfect AI personality.

| File | Examples |
|------|---------|
| `AGENTS.md` | AutoGPT Planner, BabyAGI Queue, Coding Expert, Security Researcher, Minimalist Executor |
| `SOUL.md` | Sarcastic Bestie, Tsundere AI, Conspiracy Theorist, Stoic, Zen Master, Space Pirate |
| `IDENTITY` | GLaDOS, J.A.R.V.I.S., Sassy Cat, Gen Z Intern, Hype Bot, Noir Detective |
| `BOOT.md` | Silent Boot, Git Sync Boot, Daily Welcome, Docker Compose Boot |
| `BOOTSTRAP.md` | Quick Start, RPG Campaign Init, Auto-detect Stack, Roast Setup |
| `HEARTBEAT.md` | GitHub Monitor, Server Health, Task Queue (BabyAGI), Focus Enforcer |
| `TOOLS.md` | Docker Swarm, AWS, K8s, Raspberry Pi, PyTorch ML Stack |
| `USER` | The Founder, The Micro-Manager, ADHD Creator, Grumpy Sysadmin, The Novelist |

---

## Project Structure

- `src/context/` — State management and configuration generation logic.
- `src/pages/` — Modular wizard steps (Welcome, Model, Channels, Gateway, Workspace, Deploy).
- `src/server/` — Bridge server to interact with the local filesystem and OpenClaw CLI.
- `src/data/templates.js` — Metadata for LLM providers, messaging channels, and use-case presets.
- `src/data/templates.json` — Workspace persona template library (15+ templates per file type).

---

## Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

---

*Powered by the Lobster Way 🦞*
channels

Comments

Sign in to leave a comment

Loading comments...