Skip to content

Repository files navigation

ClawDeck

中文说明

Warning: This is a beta version. Do not use in production environments.

When users open ClawDeck, they should be able to:

  1. See — which Agents are running, where tasks are stuck, and whether there are errors
  2. Judge — which tasks are worth following up, which decisions need approval
  3. Act — send instructions, abort sessions, approve or reject dangerous operations

ClawDeck reads real-time data from OpenClaw Gateway (WebSocket push + polling fallback) and presents task status, session history, and resource usage through structured panels. It is a visual extension of OpenClaw, not a standalone tool.

How It Differs from OpenClaw Built-in UI

OpenClaw CLI ClawDeck
Interaction Terminal commands Browser GUI
Real-time Active polling WebSocket push + panel refresh
Actions Full access Minimal viable set (instruct/abort/approve)
Data view Log stream Structured cards + timeline + stats

Features

  • Workshop Home: Real-time display of online Agents, active tasks, today's completed count
  • Task Board: Card-based Agent status view with send-instruction and abort-session support
  • Session Timeline: Expandable view of each message's input/output/tool call details
  • AI Advice Panel: Intelligent recommendations based on running status
  • Log Panel: Dual-mode logs (server-side/client-side) with incremental polling
  • i18n: Built-in English/Chinese support, language follows system settings

Quick Start

Option 1: Official Plugin Install (Recommended)

# Generate the standard plugin package inside this repository
npm run package:plugin

# Install from the generated package directory
openclaw plugins install ./dist/plugin-package/clawdeck

# Enable plugin
openclaw plugins enable clawdeck

# Restart Gateway
openclaw gateway restart

The default package output directory is ./dist/plugin-package/clawdeck. The packaging step only writes there by default and will not install directly into your OpenClaw home automatically.

For normal users, do not use install.sh or run node scripts/deploy-plugin.mjs directly. Those paths are deprecated for user installation and only kept for internal development or historical compatibility.

Then open http://localhost:<port>/plugins/clawdeck/ (run openclaw web to find the actual port).

Dev Link Install (Development Only)

If you need a development-time workflow, use the official link mode:

npm run package:plugin
openclaw plugins install -l ./dist/plugin-package/clawdeck
openclaw plugins enable clawdeck
openclaw gateway restart

The -l flag installs the plugin as a link for development and debugging. It is not the primary install path for normal users. Keep the link target on ./dist/plugin-package/clawdeck instead of the repository root.

Option 2: Standalone Dev Server

# Install dependencies
npm install

# Build Bridge layer (TypeScript)
npm run build:bridge

# Start dev server (Mock mode, no OpenClaw required)
node dev-server.cjs --mock

Then open http://localhost:<port>/?mock=demo (run openclaw web to find the actual port).

Option 3: Connect to Real OpenClaw Gateway

# Ensure OpenClaw Gateway is running
openclaw gateway start

# Start dev server (connects to real Gateway)
node dev-server.cjs

Project Structure

plugin/           Plugin entry + backend (TypeScript)
bridge/           Data bridge layer (GatewayClient + DataRouter)
ui/               Frontend UI panels (pure ES Module, zero build)
css/              Stylesheets
i18n/             Internationalization

Tech Stack

  • Frontend: Native DOM + CSS, ES Modules, zero build step
  • Backend: TypeScript + OpenClaw Plugin SDK
  • Data: WebSocket + polling dual-track flow
  • Rendering: No Canvas, no WebGL, pure CSS theming

Development

# Run tests
npm test

# Build Bridge layer
npm run build:bridge

License

MIT

Contact

微信 Welcome to connect

About

A clear and focused interface for interacting with OpenClaw tasks — see agent states, understand progress, and act instantly.

Resources

Stars

2 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages