beadboard/README.md
2026-02-13 00:20:44 -08:00

2.4 KiB

BeadBoard

The Windows-native Control Center for Beads.

BeadBoard is a high-performance local dashboard for managing your software development tasks. Built on the Beads protocol, it provides a unified, visualization-rich interface over your distributed project landscape. alt text

🚀 Why BeadBoard?

Most task managers are siloes. BeadBoard is a lens over your source code.

  • Source of Truth: Reads directly from .beads/issues.jsonl in your repo. No database sync skew.
  • Windows Optimized: Built from the ground up to handle Windows paths, drive letters, and filesystem performance.
  • Zero Latency: Optimistic UI updates make interactions feel instant.

Core Features

1. Multi-Project Registry & Scanner

Stop context switching between repos.

  • Project Registry: Persist your favorite project roots for one-click access.
  • Auto-Discovery: Built-in filesystem scanner finds Bead-enabled projects across your drives.
  • Aggregate Mode: View tasks from all registered projects in a single unified board.

2. Interactive Kanban Dashboard (/)

Manage your flow state. Kanban Dashboard

  • Live Updates: Boards refresh automatically when the underlying JSONL files change (e.g., via CLI).
  • Progressive Disclosure: Task details, metadata, and relations are tucked away until you need them.
  • Smart Filtering: Filter by priority, assignee, status, or full-text search across thousands of beads.

3. Dependency Graph Explorer (/graph)

Understand the "Why" and "What's Next". alt text

  • Epic-Centric Layout: Automatically groups tasks by Epic for logical clustering.
  • True DAG Visualization: Uses Dagre layout engine to enforce a strict Left-to-Right dependency flow.
    • Left: Incoming Blockers
    • Center: Focus Task
    • Right: Unlocks / Downstream
  • Focus Mode: Minimizable dependency strip and deep-linking support for sharing exact views.
  • Smart Metadata: See bead counts, priorities, and status health at a glance.

🛠️ Stack

  • Framework: Next.js 15 (App Router)
  • UI Engine: React 19 + Framer Motion
  • Styling: Tailwind CSS + Custom Design System
  • Type Safety: Strict TypeScript

Quick Start

  1. Install: npm install
  2. Run: npm run dev
  3. Explore: Open http://localhost:3000

🤝 Contribution

  • Typecheck: npm run typecheck
  • Test: npm run test