@harness-engineering/dashboard

中文文档
0.17.1发布于 2026/11/17MITES Module构建来源已验证近 30 天下载 9616

Local web dashboard for harness project health and roadmap visualization

原始使用文档
文档目录12 节
  1. Quick Start
  2. CLI Options
  3. Pages
  4. Architecture
  5. Client-Server Communication
  6. Server API Routes
  7. Configuration
  8. Environment Variables
  9. Constants
  10. Development
  11. Dependencies
  12. License

@harness-engineering/dashboard

Local web dashboard for harness project health, roadmap visualization, orchestrator monitoring, and knowledge graph exploration. Built with React + Hono, with Server-Sent Events for live updates.

Quick Start

# From any harness-enabled project:
harness dashboard

# Or during development (from packages/dashboard):
pnpm dev

The dashboard opens at http://localhost:3701 by default. The harness dashboard command auto-opens the browser (pass --no-open to suppress).

CLI Options

harness dashboard [options]

  --port <port>      Client dev server port (default: 3700)
  --api-port <port>  API server port (default: 3701)
  --no-open          Do not automatically open browser
  --cwd <path>       Project directory (defaults to cwd)

Pages

The dashboard has 11 pages:

PageRouteDescription
Overview/At-a-glance project summary: roadmap progress, health score, graph stats, security/perf/arch check results
Attention/attentionEscalated interactions from the orchestrator requiring human review, with enriched specs and concern signals
Adoption/adoptionSkill usage metrics: invocation counts, success rates, average duration, and last-used timestamps
Health/healthEntropy-based project health with collapsible sections for security findings, perf checks, and arch violations
Analyze/analyzeInteractive intelligence pipeline: submit a task description and stream SEL, CML, and PESL results in real time
Roadmap/roadmapStats bar, milestone-grouped feature table with claim workflow, dependency graph, and assignment history
Orchestrator/orchestratorLive orchestrator state: running agents, rate limits, concurrency, token usage, tick activity, and agent streams
Work in Flight/s/kanbanLive kanban of orchestrator/parallel-coordinator work: Queued / In Progress / Blocked / Done lanes with per-task cards (owning agent, worktree, phase, elapsed time, blocker reason, and blockedBy dependency chips). Read-only — derived client-side from the same useOrchestratorSocket WebSocket snapshot, with no server-side changes.
Impact/impactGraph anomaly detection (articulation points, outliers) and interactive blast radius visualization
Graph/graphKnowledge graph statistics: node/edge counts, type breakdown, density, connected components
Chat/chatFull-screen AI chat interface with skill-aware context, command palette, and session management

Architecture

packages/dashboard/
  src/
    client/              React SPA (Vite + Tailwind CSS)
      pages/             10 page components (one per route)
      components/        Shared UI: KpiCard, BlastRadiusGraph, chat system, roadmap components
      hooks/             useSSE, useOrchestratorSocket, useApi, useChatContext, etc.
      utils/             Type guards, chat streaming, context-to-prompt
    server/              Hono API server
      routes/            Route handlers (one file per domain)
      gather/            Data gatherers: roadmap, health, graph, security, perf, arch, anomalies
      sse.ts             SSEManager: shared polling loop, broadcast to all connected clients
      cache.ts           In-memory cache with configurable TTL (default 60s)
      gather-cache.ts    Cache for expensive one-shot gatherers (security, perf, arch, anomalies)
      context.ts         ServerContext: project path, cache, SSE manager
    shared/              Types, constants, and type guards shared between client and server

Client-Server Communication

The dashboard uses two communication patterns:

SSE (Server-Sent Events) -- The Overview, Health, Roadmap, and Graph pages subscribe to /api/sse. The server runs a shared polling loop (default 30s interval) that gathers roadmap, health, and graph data and broadcasts to all connected clients. Expensive checks (security, perf, arch, anomalies) run once on first connection and are cached for subsequent clients.

WebSocket -- The Orchestrator and Attention pages connect to the orchestrator's WebSocket at /ws for real-time snapshots of running agents, pending interactions, rate limits, and agent streaming events.

REST -- All pages can also fetch data via REST endpoints. The Adoption, Impact, and Chat pages use direct API calls.

Server API Routes

MethodEndpointDescription
GET/api/health-checkServer liveness check ({ status: "ok" })
GET/api/overviewCombined roadmap + health + graph snapshot
GET/api/roadmapParsed roadmap data (milestones, features)
GET/api/roadmap/chartsChart-specific data (milestones, features, blocker edges)
GET/api/healthHealth result with optional security/perf/arch data
GET/api/graphKnowledge graph statistics
GET/api/adoptionSkill adoption snapshot
GET/api/ciCI check data from gather cache
GET/api/impact/anomaliesGraph anomalies (articulation points, outliers)
POST/api/impact/blast-radiusCompute blast radius for a node ({ nodeId, maxDepth? })
GET/api/sseSSE event stream (overview + checks events)
POST/api/actions/roadmap-statusUpdate a feature's status in roadmap.md
POST/api/actions/validateRun harness validate and return output
POST/api/actions/regen-chartsInvalidate caches and regenerate chart markers
POST/api/actions/refresh-checksRe-run security/perf/arch/anomaly checks and broadcast via SSE

Configuration

Environment Variables

VariableDefaultDescription
DASHBOARD_API_PORT3701Hono API server port
DASHBOARD_CLIENT_PORT3700Vite dev server port
HARNESS_PROJECT_PATHcwd()Project root for data gathering

Constants

ConstantValueDescription
API_PORT3701Default API server port
DASHBOARD_PORT3700Default client dev server port
DEFAULT_POLL_INTERVAL_MS30000SSE polling interval (30 seconds)
GRAPH_DIR.harness/graphKnowledge graph directory path

Development

# Install dependencies
pnpm install

# Start dev mode (Vite client + tsx server, hot reload)
pnpm dev

# Build for production
pnpm build

# Run tests
pnpm test

# Type check
pnpm typecheck

# Lint
pnpm lint

In dev mode, pnpm dev runs the Vite client dev server (port 3700) and the Hono API server (port 3701) concurrently. In production, the Hono server serves both the API and the built client assets from a single port (3701).

Dependencies

@harness-engineering/core   -> project health, entropy detection
@harness-engineering/graph  -> knowledge graph queries, blast radius
@harness-engineering/types  -> shared type definitions
hono                        -> API server framework
@hono/node-server           -> Node.js adapter for Hono
react / react-dom           -> UI framework
react-router                -> client-side routing
tailwindcss                 -> utility-first CSS
framer-motion               -> animations
lucide-react                -> icons
react-virtuoso              -> virtualized lists (Attention page)
react-markdown              -> markdown rendering (Chat, Attention)
react-syntax-highlighter    -> code block highlighting

License

MIT

版本与发布记录

@harness-engineering/dashboard 共发布 64 个版本,首次发布于 2026/04/11;过去 12 个月发布了 64 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.17.1latest2026/11/17今天
0.17.02026/11/125 天前
0.16.142026/10/2027 天前
0.16.132026/09/241 个月前
0.16.122026/09/181 个月前
0.16.112026/09/172 个月前

关于 @harness-engineering/dashboard 的常见问题

@harness-engineering/dashboard 是什么?

Local web dashboard for harness project health and roadmap visualization

如何安装 @harness-engineering/dashboard?

在项目目录运行 npm install @harness-engineering/dashboard,或使用 pnpm add / yarn add / bun add。

@harness-engineering/dashboard 支持 TypeScript 吗?

该包的 package.json 没有声明类型入口。需要类型提示时,可以在 npm 上查找社区维护的 @types/harness-engineering__dashboard 是否存在。

@harness-engineering/dashboard 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@harness-engineering/dashboard 可以商用吗?

@harness-engineering/dashboard 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@harness-engineering/dashboard 的下载量有多少?

根据 npm 官方下载统计,@harness-engineering/dashboard 在 2026/10/17 – 2026/11/15 这 30 天内被下载 9,616 次,日均约 321 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@harness-engineering/dashboard 还在维护吗?

最新版本 0.17.1 发布于 2026/11/17(今天);至今共发布 64 个版本,其中过去 12 个月发布了 64 个;首次发布于 2026/04/11。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。