claw-dashboard 1.9.0 → 2.0.0

package/jest.config.js

@@ -0,0 +1,11 @@
+export default {
+  testEnvironment: 'node',
+  transform: {},
+  moduleFileExtensions: ['js', 'mjs'],
+  testMatch: ['**/tests/**/*.test.js'],
+  // c8 handles coverage - Jest coverage disabled
+  collectCoverage: false,
+  coverageProvider: 'v8',
+  verbose: true,
+  testTimeout: 10000,
+};

package/man/clawdash.1

@@ -0,0 +1,276 @@
+.TH CLAWDASH 1 "February 2026" "claw-dashboard 2.0.0" "User Commands"
+.SH NAME
+clawdash \- A beautiful terminal dashboard for monitoring OpenClaw instances
+.SH SYNOPSIS
+.B clawdash
+[\fIOPTIONS\fR]
+.SH DESCRIPTION
+.B clawdash
+is a real-time terminal dashboard for monitoring OpenClaw instances,
+inspired by modern system monitors like btop, htop, and mactop.
+It provides beautiful visualizations including ASCII art logo, gradient
+colors, donut charts, progress bars, and sparklines.
+.PP
+The dashboard displays:
+.IP \(bu 2
+System stats (CPU, memory, GPU, disk, network)
+.IP \(bu 2
+OpenClaw sessions list with real-time updates
+.IP \(bu 2
+OpenClaw agents list
+.IP \(bu 2
+Uptime tracking
+.IP \(bu 2
+OpenClaw logs
+.IP \(bu 2
+Settings panel for customization
+.SH OPTIONS
+.TP
+.BR \-h ", " \-\-help
+Display help message and exit.
+.TP
+.BR \-v ", " \-\-version
+Display version information and exit.
+.TP
+.BR \-d ", " \-\-debug
+Run in debug mode with additional logging output.
+.TP
+.BR \-c ", " \-\-config " "\fICONFIG\fR
+Use alternative configuration file.
+.TP
+.BR \-w ", " \-\-web
+Run in web server mode instead of TUI. Exposes dashboard data via HTTP API.
+.TP
+.BR \-p ", " \-\-web-port " "\fIPORT\fR
+Set the web server port (default: 18790). Requires \-\-web option.
+.TP
+.B "\-\-web-host "\fIHOST\fR
+Set the web server bind host (default: 0.0.0.0). Requires \-\-web option.
+.SH CONTROLS
+.SS Navigation
+.TP
+.BR q ", " Q ", " Ctrl+C
+Quit the dashboard.
+.TP
+.BR r ", " R
+Force refresh all data immediately.
+.TP
+.BR p ", " Space
+Pause or resume auto-refresh.
+.TP
+.BR ? ", " h
+Toggle the help panel.
+.TP
+.BR s ", " S
+Open or close the settings panel.
+.TP
+.BR Esc
+Close the settings panel (when open).
+.SS Session Sorting
+.TP
+.B o
+Cycle through session sort modes:
+.RS
+.IP \(bu 2
+time - Most recently updated first (default)
+.IP \(bu 2
+tokens - Highest token usage first
+.IP \(bu 2
+idle - Longest idle time first
+.IP \(bu 2
+name - Alphabetical by agent name
+.RE
+.SS Widget Toggles
+.TP
+.BR 1 \- 8
+Toggle individual widgets:
+.RS
+.IP \(bu 2
+1 - CPU widget
+.IP \(bu 2
+2 - Memory widget
+.IP \(bu 2
+3 - GPU widget
+.IP \(bu 2
+4 - Network widget
+.IP \(bu 2
+5 - Disk widget
+.IP \(bu 2
+6 - System widget
+.IP \(bu 2
+7 - Uptime widget
+.IP \(bu 2
+8 - Health widget
+.RE
+.TP
+.B 0
+Cycle log level filter.
+.SS Vi-Mode Navigation
+.TP
+.BR h ", " l
+Previous/next page.
+.TP
+.BR j ", " k
+Select next/previous session.
+.TP
+.BR g ", " G
+Go to first/last page.
+.TP
+.BR Ctrl+B ", " Ctrl+F
+Page up/down.
+.SS Data Export
+.TP
+.B e
+Export dashboard data (JSON/CSV).
+.TP
+.B E
+Cycle export format between JSON and CSV.
+.SS Favorites
+.TP
+.B f
+Toggle favorite status on current session.
+.TP
+.B F
+Show favorites only (toggle filter).
+.SS Themes
+.TP
+.B t
+Cycle through available themes:
+.RS
+.IP \(bu 2
+default - Standard color scheme
+.IP \(bu 2
+dark - Dark color scheme
+.IP \(bu 2
+high-contrast - High contrast accessibility theme
+.IP \(bu 2
+ocean - Ocean-inspired blue tones
+.RE
+.SH FILES
+.TP
+.I ~/.openclaw/dashboard-settings.json
+User settings file containing refresh interval, widget visibility,
+theme preferences, and sort mode.
+.TP
+.I ~/.openclaw/config.json
+OpenClaw configuration file for gateway port and authentication token.
+.TP
+.I ~/Library/Logs/OpenClaw/
+OpenClaw log directory (monitored by the dashboard).
+.SH ENVIRONMENT
+.TP
+.B CLAWDASH_THEME
+Override the default theme. Values: default, dark, high-contrast, ocean.
+.TP
+.B CLAWDASH_REFRESH
+Override the default refresh interval in milliseconds.
+.SH WEB INTERFACE
+When running with the \-\-web option, clawdash starts an HTTP server that
+exposes dashboard data via a REST API. This allows remote monitoring without
+launching the TUI.
+.PP
+Available endpoints:
+.TP
+.B GET /health
+Health check returning server status and uptime.
+.TP
+.B GET /metrics
+System metrics including CPU, memory, GPU, disk, and network.
+.TP
+.B GET /sessions
+List of active OpenClaw sessions.
+.TP
+.B GET /agents
+List of available OpenClaw agents.
+.TP
+.B GET /logs
+Recent OpenClaw logs.
+.TP
+.B GET /status
+Full dashboard status including all data types.
+.PP
+All endpoints return JSON data with CORS headers for cross-origin requests.
+.SH WIDGET PLUGIN SYSTEM
+The dashboard supports a plugin system for custom widgets. Plugins can be
+installed in
+.I ~/.openclaw/plugins/
+and are automatically discovered on startup.
+.PP
+Each plugin consists of:
+.IP \(bu 2
+.I plugin.json
+- Plugin manifest with metadata
+.IP \(bu 2
+.I index.js
+- Widget implementation extending BaseWidget
+.PP
+Configuration options in settings:
+.IP \(bu 2
+widgetLoading.enabled - Enable lazy loading (default: true)
+.IP \(bu 2
+widgetLoading.preloadPriority - Widgets to load immediately
+.IP \(bu 2
+widgetLoading.autoDiscover - Auto-discover plugins (default: true)
+.PP
+See
+.I docs/PLUGINS.md
+for full documentation and examples.
+.SH EXAMPLES
+.PP
+Run the dashboard:
+.RS
+.nf
+$ clawdash
+.fi
+.RE
+.PP
+Run with debug mode:
+.RS
+.nf
+$ clawdash --debug
+.fi
+.RE
+.PP
+Run web server mode on default port (18790):
+.RS
+.nf
+$ clawdash --web
+.fi
+.RE
+.PP
+Run web server on custom port:
+.RS
+.nf
+$ clawdash --web --web-port 8080
+.fi
+.RE
+.PP
+Query the web API:
+.RS
+.nf
+$ curl http://localhost:18790/health
+$ curl http://localhost:18790/metrics
+$ curl http://localhost:18790/status
+.fi
+.RE
+.SH REQUIREMENTS
+.IP \(bu 2
+Node.js v18 or higher
+.IP \(bu 2
+OpenClaw installed and configured
+.IP \(bu 2
+macOS (Apple Silicon optimized)
+.IP \(bu 2
+Terminal with 256 color support
+.SH SEE ALSO
+.BR openclaw (1)
+.SH BUGS
+Report bugs at: https://github.com/spleck/claw-dashboard/issues
+.SH AUTHOR
+Written by Kevin Smith.
+.SH COPYRIGHT
+Copyright 2026 Kevin Smith.
+License: MIT
+.PP
+This is free software; you can redistribute it and/or modify it under
+the terms of the MIT License. There is NO WARRANTY.

package/package.json

@@ -1,15 +1,42 @@
 {
   "name": "claw-dashboard",
-  "version": "1.9.0",
+  "version": "2.0.0",
   "description": "A beautiful console dashboard for monitoring OpenClaw instances — inspired by htop/btop/mactop",
   "main": "index.js",
+  "exports": {
+    ".": {
+      "import": "./index.js",
+      "require": "./index.cjs"
+    },
+    "./widgets": {
+      "import": "./src/widgets/index.js",
+      "require": "./dist/widgets.cjs"
+    },
+    "./package.json": "./package.json"
+  },
   "bin": {
     "clawdash": "./index.js"
   },
+  "man": [
+    "./man/clawdash.1"
+  ],
   "type": "module",
   "scripts": {
     "start": "node index.js",
-    "dev": "node index.js --debug"
+    "dev": "node index.js --debug",
+    "test": "node --experimental-vm-modules node_modules/.bin/jest",
+    "test:coverage": "c8 --reporter=text --reporter=html --reporter=lcov npm test",
+    "test:coverage:check": "c8 --check-coverage npm test",
+    "coverage:report": "c8 report",
+    "coverage:clean": "rm -rf coverage",
+    "build": "node esbuild.config.js",
+    "build:dev": "node esbuild.config.js --dev",
+    "build:cjs": "node build-cjs.js",
+    "lint": "eslint src/ --ignore-pattern 'src/workers/**'",
+    "release": "node scripts/release.js",
+    "release:sign": "node scripts/release.js --sign",
+    "release:github": "node scripts/release.js --github --sign",
+    "prepare": "husky"
   },
   "repository": {
     "type": "git",
@@ -34,8 +61,30 @@
   },
   "dependencies": {
     "blessed": "^0.1.81",
-    "blessed-contrib": "^4.11.0",
-    "systeminformation": "^5.21.22",
-    "chalk": "^5.3.0"
+    "blessed-contrib": "^1.0.11",
+    "chalk": "^5.3.0",
+    "sql.js": "^1.14.0",
+    "systeminformation": "^5.21.22"
+  },
+  "devDependencies": {
+    "@eslint/js": "^10.0.1",
+    "c8": "^11.0.0",
+    "esbuild": "^0.25.12",
+    "eslint": "^10.0.2",
+    "husky": "^9.1.7",
+    "jest": "^30.2.0",
+    "lint-staged": "^16.3.0"
+  },
+  "lint-staged": {
+    "src/**/*.{js,mjs,cjs}": [
+      "eslint --fix --ignore-pattern 'src/workers/**'",
+      "node --experimental-vm-modules node_modules/.bin/jest --bail --findRelatedTests"
+    ]
+  },
+  "overrides": {
+    "xml2js": "^0.6.2",
+    "form-data": "^4.0.0",
+    "qs": "^6.14.1",
+    "tough-cookie": "^5.0.0"
   }
 }

package/schemas/plugin-manifest.json

@@ -0,0 +1,128 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://claw-dashboard.io/schemas/plugin-manifest.json",
+  "title": "Claw Dashboard Plugin Manifest",
+  "description": "Schema for validating claw-dashboard plugin.json files",
+  "type": "object",
+  "required": ["id", "name", "version", "type"],
+  "additionalProperties": false,
+  "properties": {
+    "id": {
+      "type": "string",
+      "description": "Unique identifier for the plugin (kebab-case recommended)",
+      "pattern": "^[a-zA-Z0-9]([a-zA-Z0-9_-]*[a-zA-Z0-9])?$",
+      "minLength": 1,
+      "maxLength": 64,
+      "examples": ["my-custom-widget", "system-metrics-chart"]
+    },
+    "name": {
+      "type": "string",
+      "description": "Display name for the widget",
+      "minLength": 1,
+      "maxLength": 100,
+      "examples": ["My Custom Widget", "System Metrics Chart"]
+    },
+    "description": {
+      "type": "string",
+      "description": "Brief description of the widget",
+      "maxLength": 500,
+      "default": ""
+    },
+    "version": {
+      "type": "string",
+      "description": "Semantic version (major.minor.patch)",
+      "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-([0-9A-Za-z-]+(?:\\.[0-9A-Za-z-]+)*))?(?:\\+([0-9A-Za-z-]+(?:\\.[0-9A-Za-z-]+)*))?$",
+      "examples": ["1.0.0", "1.2.3-beta.1"]
+    },
+    "author": {
+      "type": "string",
+      "description": "Author name or email",
+      "maxLength": 200,
+      "default": "",
+      "examples": ["John Doe", "Jane Doe <jane@example.com>"]
+    },
+    "category": {
+      "type": "string",
+      "description": "Category for organization",
+      "enum": ["system", "monitoring", "custom", "example"],
+      "default": "custom"
+    },
+    "type": {
+      "type": "string",
+      "description": "Plugin type",
+      "enum": ["widget"],
+      "default": "widget"
+    },
+    "lazyLoad": {
+      "type": "boolean",
+      "description": "Whether to defer loading until needed",
+      "default": true
+    },
+    "priority": {
+      "type": "number",
+      "description": "Loading priority (lower = earlier, range: 0-1000)",
+      "minimum": 0,
+      "maximum": 1000,
+      "default": 100
+    },
+    "config": {
+      "type": "object",
+      "description": "Default configuration values",
+      "default": {},
+      "additionalProperties": true
+    },
+    "entryPoint": {
+      "type": "string",
+      "description": "Main JavaScript file (deprecated, use standard index.js)",
+      "default": "index.js",
+      "deprecated": true
+    },
+    "permissions": {
+      "type": "array",
+      "description": "Required permissions for the plugin",
+      "items": {
+        "type": "string",
+        "enum": ["filesystem", "network", "system", "database", "config"]
+      },
+      "default": [],
+      "uniqueItems": true
+    },
+    "dependencies": {
+      "type": "array",
+      "description": "Plugin dependencies (other plugin IDs)",
+      "items": {
+        "type": "string",
+        "pattern": "^[a-zA-Z0-9]([a-zA-Z0-9_-]*[a-zA-Z0-9])?$"
+      },
+      "default": [],
+      "uniqueItems": true
+    },
+    "__version": {
+      "type": "number",
+      "description": "Widget config schema version for migration tracking",
+      "minimum": 1,
+      "examples": [1, 2],
+      "default": 1
+    }
+  },
+  "definitions": {},
+  "examples": [
+    {
+      "id": "my-custom-widget",
+      "name": "My Custom Widget",
+      "description": "A widget that displays custom data",
+      "version": "1.0.0",
+      "author": "Your Name <you@example.com>",
+      "category": "monitoring",
+      "type": "widget",
+      "lazyLoad": true,
+      "priority": 50,
+      "config": {
+        "refreshInterval": 5000,
+        "maxDataPoints": 30
+      },
+      "permissions": ["network"],
+      "__version": 1
+    }
+  ]
+}