@futurx/openclaw-operator-ui 0.1.0

package/README.md

@@ -0,0 +1,95 @@
+# OpenClaw Operator UI
+
+A standalone plugin that provides a web-based management interface for [OpenClaw](https://github.com/openclaw/openclaw), designed for non-technical operators.
+
+## Features
+
+- **Agent Management** — Create, edit and delete agents; edit all workspace markdown files (IDENTITY.md, SOUL.md, AGENTS.md, TOOLS.md, etc.)
+- **Channel Monitoring** — View channel status, account connections, and manage logout
+- **Group Bindings** — Visualise which groups are routed to which agents across channels
+- **Skill Management** — Browse skills, toggle enable/disable, install missing dependencies directly from the UI
+- **Real-time Test Chat** — Stream responses in a chat interface to test agents live
+- **Session Management** — View, reset and delete conversation sessions
+- **Cron Jobs** — Monitor and control scheduled tasks
+- **System Settings** — Edit `openclaw.json` configuration, view system health and available models
+- **Password Authentication** — Secured via Gateway password
+
+## Installation
+
+### From npm
+
+```bash
+openclaw plugins install @futurx/openclaw-operator-ui
+```
+
+### From local path
+
+```bash
+openclaw plugins install /path/to/futurclaw-operator-ui
+```
+
+### From Git
+
+```bash
+openclaw plugins install git+https://git.futurx.cc/futurx/futurclaw-operator-ui.git
+```
+
+After installation, restart the Gateway. The Operator UI will be available at:
+
+```
+http://localhost:18789/operator
+```
+
+## Prerequisites
+
+- OpenClaw >= 2026.1.26
+- Node.js >= 22
+- Gateway must have password authentication configured in `~/.openclaw/openclaw.json`:
+
+```json
+{
+  "gateway": {
+    "auth": {
+      "password": "your-password-here"
+    }
+  }
+}
+```
+
+### Client ID Registration
+
+This plugin connects to the Gateway using the client ID `openclaw-operator-ui`. If your target OpenClaw instance does not recognise this ID, you have two options:
+
+1. **Add the ID upstream** — Submit a PR to add `openclaw-operator-ui` to `GATEWAY_CLIENT_IDS` in `src/gateway/protocol/client-info.ts`
+2. **Use an existing ID** — Edit `web/src/lib/gateway.ts` and change the `CLIENT_ID` constant to a recognised value such as `"openclaw-control-ui"` or `"webchat-ui"`
+
+## Development
+
+```bash
+# Install dependencies and build the frontend
+npm run build
+
+# Or develop with hot-reload (proxy to local Gateway)
+cd web && npm install && npm run dev
+```
+
+The dev server proxies WebSocket connections to `ws://localhost:18789`.
+
+## Project Structure
+
+```
+├── package.json              # npm package manifest
+├── openclaw.plugin.json      # OpenClaw plugin descriptor
+├── index.ts                  # Plugin entry — serves built SPA at /operator
+├── web/                      # React + Vite frontend
+│   ├── src/
+│   │   ├── lib/              # Gateway client, auth context, hooks
+│   │   ├── components/       # Shared UI components
+│   │   └── pages/            # Route pages
+│   └── ...config files
+└── dist/web/                 # Built frontend (generated)
+```
+
+## License
+
+MIT