bmad-viewer 0.1.6 → 0.1.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +70 -24
  2. package/package.json +7 -3
package/README.md CHANGED
@@ -1,48 +1,94 @@
1
1
  # bmad-viewer
2
2
 
3
- Visual dashboard for BMAD (Boring Maintainable Agile Development) projects.
3
+ **Stop wasting tokens asking "where am I?"** — see your BMAD project status, browse the full agent/workflow catalog, and search everything with Ctrl+K. Zero tokens, zero config.
4
4
 
5
- ## Features
5
+ ![bmad-viewer demo](./docs/demo.gif)
6
6
 
7
- - 📊 Live project dashboard with sprint status visualization
8
- - 🔍 Fuzzy search across agents, workflows, and tools
9
- - 📝 Markdown-based wiki with auto-refresh
10
- - 🎨 Dark/light theme support
11
- - 🚀 Zero-config - auto-detects `_bmad/` folder
12
- - 📦 Installable via npx - no global installation needed
7
+ ## The problem
13
8
 
14
- ## Quick Start
9
+ BMAD is powerful — 21 agents, 43 workflows, hundreds of resources. But:
10
+
11
+ - **New users** face 500+ markdown files with no map
12
+ - **Active developers** burn tokens every morning asking the agent "where did I leave off?"
13
+ - **Non-technical stakeholders** can't see project progress without opening a terminal
14
+ - **Solo devs** don't know half the capabilities BMAD offers
15
+
16
+ bmad-viewer fixes all of that with a single command.
17
+
18
+ ## Quick start
19
+
20
+ **From Claude Code** — just type:
21
+
22
+ ```
23
+ /viewer
24
+ ```
25
+
26
+ The package includes a `/viewer` slash command that auto-installs as a skill. Claude launches the dashboard for you in the background.
27
+
28
+ **From terminal:**
15
29
 
16
30
  ```bash
17
- # Run in a BMAD project directory
18
31
  npx bmad-viewer
32
+ ```
33
+
34
+ Auto-detects your `_bmad/` folder, opens your browser, dashboard ready.
35
+
36
+ ## What you get
19
37
 
20
- # Or specify a custom path
21
- npx bmad-viewer --path /path/to/bmad/project
38
+ **Wiki / Catalog** — Browse all BMAD modules (Core, BMB, BMM, CIS) with a navigable sidebar. Click any agent or workflow to read its full description rendered as clean HTML.
39
+
40
+ **Project Viewer** — Sprint status at a glance: stats boxes + kanban columns (Pending → In Progress → Done). Reads directly from your `sprint-status.yaml`. Auto-refreshes when files change on disk.
41
+
42
+ **Fuzzy Search (Ctrl+K)** — Find any agent, workflow, or tool instantly. Tolerates typos. You type "brainstrom", you get "brainstorming".
43
+
44
+ **Dark/Light theme** — Respects your OS preference, toggle manually anytime. Persists across sessions.
45
+
46
+ ## Who is this for
47
+
48
+ | You are... | You get... |
49
+ |------------|-----------|
50
+ | New to BMAD | A visual map of everything BMAD offers — no more guessing which agent does what |
51
+ | A developer mid-sprint | Sprint dashboard on your second monitor, always up to date, zero tokens spent |
52
+ | A solo dev | Discover workflows you didn't know existed via search |
53
+ | A stakeholder | A shareable link with project progress — no terminal needed |
54
+ | An open source contributor | A complete catalog to understand how BMAD fits together |
55
+
56
+ ## CLI options
22
57
 
23
- # Custom port
24
- npx bmad-viewer --port 8080
25
58
  ```
59
+ bmad-viewer [options]
60
+
61
+ Options:
62
+ --port <number> Custom port (default: auto-detect from 3000)
63
+ --path <directory> Path to BMAD project (default: auto-detect _bmad/ in cwd)
64
+ --output <directory> Generate static HTMLs (no server)
65
+ --no-open Don't open browser automatically
66
+ --version Show version
67
+ --help Show help
68
+ ```
69
+
70
+ ## How it works
71
+
72
+ bmad-viewer reads the files BMAD already generates — CSV manifests, YAML configs, Markdown docs — and renders them as a local HTML dashboard. The filesystem is the database. No backend, no data entry, no sync.
73
+
74
+ When you edit a file, a file watcher detects the change and pushes an update to your browser via WebSocket. The dashboard refreshes automatically.
26
75
 
27
76
  ## Requirements
28
77
 
29
78
  - Node.js 18+ (LTS)
79
+ - A project with BMAD installed (`_bmad/` folder)
30
80
 
31
- ## Development
81
+ ## Try without a BMAD project
32
82
 
33
83
  ```bash
34
- # Install dependencies
35
- npm install
84
+ npx bmad-viewer --path ./node_modules/bmad-viewer/example-data
85
+ ```
36
86
 
37
- # Run tests
38
- npm test
87
+ Bundled example data lets you explore the dashboard without a real project.
39
88
 
40
- # Lint code
41
- npm run lint
89
+ ## Contributing
42
90
 
43
- # Format code
44
- npm run format
45
- ```
91
+ Issues and PRs welcome at [github.com/CamiloValderramaGonzalez/bmad-viewer](https://github.com/CamiloValderramaGonzalez/bmad-viewer).
46
92
 
47
93
  ## License
48
94
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "bmad-viewer",
3
- "version": "0.1.6",
3
+ "version": "0.1.8",
4
4
  "description": "Visual dashboard for BMAD (Boring Maintainable Agile Development) projects. Wiki browser + sprint status viewer with live reload.",
5
5
  "type": "module",
6
6
  "bin": {
@@ -43,6 +43,8 @@
43
43
  },
44
44
  "keywords": [
45
45
  "bmad",
46
+ "bmad-method",
47
+ "bmad-viewer",
46
48
  "agile",
47
49
  "dashboard",
48
50
  "cli",
@@ -51,8 +53,10 @@
51
53
  "sprint",
52
54
  "kanban",
53
55
  "markdown",
54
- "project-management"
56
+ "project-management",
57
+ "claude-code",
58
+ "ai-development"
55
59
  ],
56
- "author": "",
60
+ "author": "Camilo Valderrama",
57
61
  "license": "MIT"
58
62
  }