@melnicorn/bmad-dash
v1.0.2
Published
Visualize BMAD Method epics, stories & documents with AI-powered git commit matching
Downloads
384
Maintainers
Readme
bmad-dash
An unofficial, experimental dashboard for the BMAD Method.
Visualize BMAD epics, user stories, and the full set of planning documents (PRD, architecture, briefs, UX designs, specs, retrospectives, and more) from a project's .md files on a localhost dashboard. Optionally uses local AI (Transformers.js) to match git commits to stories.
bmad-dashis a fork ofbmad-visioby William Mesiti, extended with full document visibility, cross-linking, sprint-status integration, and filtering.
Quick Start
npx @melnicorn/bmad-dashRun from your project root. It reads your BMAD install config to locate artifacts, so it works with customized paths:
- BMAD v6 — reads
_bmad/bmm/config.yamlforplanning_artifacts,implementation_artifacts, andproject_knowledge; treatssprint-status.yamlas the authoritative status source. - BMAD v4 / v5 — reads
.bmad-core/core-config.{yaml,yml}(docs/stories/,docs/prd/). - Fallback — globs the default
_bmad-output/layout when no config file is present.
Features
- Next steps — Tells you what to do next using BMAD's own recommendation ladder (in-progress → review → ready-for-dev → backlog → retrospective), with a copyable workflow command and risk warnings (stale sprint status, orphaned stories, status drift)
- Epic overview — Grid of all epics with story counts, status, and progress
- Epic board — Project-level Backlog / In Progress / Done board driven by
sprint-status.yaml, with story rollups and blocking-dependency badges - Kanban board — Stories in 4 columns: To Do → Active → Review → Done
- Drag & drop — Move stories or epics between columns; writes status back to the
.mdfile andsprint-status.yaml - Story detail — Acceptance criteria, tasks with checkboxes, progress ring, related commits with a "why did this match?" signal breakdown
- Documents browser — Browse and read every BMAD document, grouped by type and initiative, with a table of contents and rendered Markdown — no more opening raw files
- Cross-linking — Follow a document's
inputDocumentsgraph (upstream inputs and downstream "used by" backlinks), jump from an epic to its dependencies and requirements, and click through internal.mdlinks in-app - Filtering — Hide completed epics or stories and text-filter across the sidebar, overview, and boards (persisted across sessions)
- Traceability — Epic dependency edges (
Depends on: Epic N) and the FR Coverage Map parsed fromepics.md - Git commit matching — AI-powered mapping of commits to stories (optional)
- Live editing — Toggle AC and tasks directly; the dashboard watches the filesystem and updates on change
AI Commit Matching
Install the optional dependency for commit-to-story matching:
npm install @huggingface/transformersThe dashboard will then:
- Parse your git history
- Embed stories and commits with
bge-small-en-v1.5 - Re-rank ambiguous matches with zero-shot NLI (
nli-deberta-v3-small) - Persist mappings in
bmad-dash/gitmap.json(migrates an existingbmad-visio/gitmap.jsonif present) - Show related commits on each story's detail page
First run downloads models locally. Everything runs on-device, no API keys needed.
Options
npx @melnicorn/bmad-dash [path] [options]
Arguments:
path Project root (default: .)
Options:
-p, --port <n> Port number (default: 3334)
--no-git Skip git commit matching
--debug Dump parsed data as JSON and exit
-h, --help Show helpStatus Mapping
| BMAD Status | Board Column |
| ------------------------------------ | ---------------- |
| backlog, ready-for-dev | To Do |
| in-progress | Active |
| review | Ready for Review |
| done, complete, cancelled | Done |
Epic and retrospective status come from sprint-status.yaml when present.
Development
pnpm install
pnpm dev -- /path/to/bmad/project # tsx, no build step
pnpm build # server (tsc) + client (vite)
pnpm test # vitestLicense
MIT — see LICENSE. Originally created by William Mesiti as bmad-visio.
Screenshots
Overview
The epic overview grid shows all epics with story counts and progress bars at a glance.

Kanban
The kanban board displays stories across four columns: To Do, Active, Ready for Review, and Done. Stories can be dragged between columns.

Story Detail View
The story detail view shows acceptance criteria, tasks with checkboxes, a progress ring, and related git commits.

