# ibadmore/bmad-progress-dashboard architecture

> Architecture diagram of the GitHub repository ibadmore/bmad-progress-dashboard, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-04). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/ibadmore/bmad-progress-dashboard
- Repository: https://github.com/ibadmore/bmad-progress-dashboard

## Overview

BMAD Progress Dashboard scans a project’s documentation and story checklists, calculates planning and development completion, derives milestones, and writes a Markdown dashboard. Users can update on demand, watch for file changes, trigger updates programmatically, or view progress interactively in the terminal. The calculation stages are implemented in one substantial source file, so they share its path. The README documents the generated dashboard and major user modes; links between the CLI wrapper and individual commands are not shown in the sampled source.

Main entry points: [`progress-tracking-bundle/tools/progress-tracking/update-progress.js`](https://github.com/ibadmore/bmad-progress-dashboard/blob/main/progress-tracking-bundle/tools/progress-tracking/update-progress.js) (Project scanner), [`progress-tracking-bundle/bmad-progress`](https://github.com/ibadmore/bmad-progress-dashboard/blob/main/progress-tracking-bundle/bmad-progress) (Progress CLI), [`progress-tracking-bundle/tools/progress-tracking/progress-terminal.js`](https://github.com/ibadmore/bmad-progress-dashboard/blob/main/progress-tracking-bundle/tools/progress-tracking/progress-terminal.js) (Terminal dashboard), [`progress-tracking-bundle/tools/progress-tracking/progress-watcher.js`](https://github.com/ibadmore/bmad-progress-dashboard/blob/main/progress-tracking-bundle/tools/progress-tracking/progress-watcher.js) (File watcher)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_entrypoints["User entrypoints"]
  node_cli["Progress CLI"]
  node_terminal["Terminal dashboard"]
  node_watcher["File watcher"]
  node_trigger["Update trigger"]
end

subgraph group_engine["Progress engine"]
  node_scanner["Project scanner<br/>[update-progress.js]"]
  node_calculator["Progress calculator<br/>[update-progress.js]"]
  node_milestones["Milestone derivation<br/>[update-progress.js]"]
  node_generator["Dashboard generator<br/>[update-progress.js]"]
end

subgraph group_artifacts["Project artifacts"]
  node_projectdocs["BMAD docs and stories"]
  node_dashboard["Progress dashboard"]
end

node_developer(("BMAD developer"))

node_developer -->|"runs commands"| node_cli
node_developer -->|"opens view"| node_terminal
node_developer -->|"starts watching"| node_watcher
node_projectdocs -->|"scans files"| node_scanner
node_scanner -->|"provides scan results"| node_calculator
node_calculator -->|"provides progress"| node_milestones
node_calculator -->|"provides metrics"| node_generator
node_milestones -->|"provides milestones"| node_generator
node_generator -->|"generates"| node_dashboard
node_terminal -->|"calls scan functions"| node_scanner
node_watcher -->|"executes update script"| node_scanner
node_trigger -->|"executes update script"| node_scanner
node_cli -.->|"dispatches view"| node_terminal
node_cli -.->|"dispatches watch"| node_watcher

click node_cli "https://github.com/ibadmore/bmad-progress-dashboard/blob/main/progress-tracking-bundle/bmad-progress"
click node_terminal "https://github.com/ibadmore/bmad-progress-dashboard/blob/main/progress-tracking-bundle/tools/progress-tracking/progress-terminal.js"
click node_watcher "https://github.com/ibadmore/bmad-progress-dashboard/blob/main/progress-tracking-bundle/tools/progress-tracking/progress-watcher.js"
click node_trigger "https://github.com/ibadmore/bmad-progress-dashboard/blob/main/progress-tracking-bundle/tools/progress-tracking/trigger-progress-update.js"
click node_scanner "https://github.com/ibadmore/bmad-progress-dashboard/blob/main/progress-tracking-bundle/tools/progress-tracking/update-progress.js"
click node_calculator "https://github.com/ibadmore/bmad-progress-dashboard/blob/main/progress-tracking-bundle/tools/progress-tracking/update-progress.js"
click node_milestones "https://github.com/ibadmore/bmad-progress-dashboard/blob/main/progress-tracking-bundle/tools/progress-tracking/update-progress.js"
click node_generator "https://github.com/ibadmore/bmad-progress-dashboard/blob/main/progress-tracking-bundle/tools/progress-tracking/update-progress.js"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_cli,node_terminal,node_watcher,node_trigger toneBlue
class node_scanner,node_calculator,node_milestones,node_generator toneAmber
class node_projectdocs,node_dashboard toneMint
class node_developer toneIndigo
```

## Components

### User entrypoints

- [Progress CLI](https://github.com/ibadmore/bmad-progress-dashboard/blob/main/progress-tracking-bundle/bmad-progress): `progress-tracking-bundle/bmad-progress`
- [Terminal dashboard](https://github.com/ibadmore/bmad-progress-dashboard/blob/main/progress-tracking-bundle/tools/progress-tracking/progress-terminal.js): `progress-tracking-bundle/tools/progress-tracking/progress-terminal.js`
- [File watcher](https://github.com/ibadmore/bmad-progress-dashboard/blob/main/progress-tracking-bundle/tools/progress-tracking/progress-watcher.js): `progress-tracking-bundle/tools/progress-tracking/progress-watcher.js`
- [Update trigger](https://github.com/ibadmore/bmad-progress-dashboard/blob/main/progress-tracking-bundle/tools/progress-tracking/trigger-progress-update.js): `progress-tracking-bundle/tools/progress-tracking/trigger-progress-update.js`

### Progress engine

- [Project scanner](https://github.com/ibadmore/bmad-progress-dashboard/blob/main/progress-tracking-bundle/tools/progress-tracking/update-progress.js): `progress-tracking-bundle/tools/progress-tracking/update-progress.js`
- [Progress calculator](https://github.com/ibadmore/bmad-progress-dashboard/blob/main/progress-tracking-bundle/tools/progress-tracking/update-progress.js): `progress-tracking-bundle/tools/progress-tracking/update-progress.js`
- [Milestone derivation](https://github.com/ibadmore/bmad-progress-dashboard/blob/main/progress-tracking-bundle/tools/progress-tracking/update-progress.js): `progress-tracking-bundle/tools/progress-tracking/update-progress.js`
- [Dashboard generator](https://github.com/ibadmore/bmad-progress-dashboard/blob/main/progress-tracking-bundle/tools/progress-tracking/update-progress.js): `progress-tracking-bundle/tools/progress-tracking/update-progress.js`

### Project artifacts

- **BMAD docs and stories**
- **Progress dashboard**

### Other components

- **BMAD developer**

## Connections

- BMAD developer → Progress CLI: runs commands (evidence: `README.md`)
- BMAD developer → Terminal dashboard: opens view (evidence: `README.md`)
- BMAD developer → File watcher: starts watching (evidence: `README.md`)
- BMAD docs and stories → Project scanner: scans files (evidence: `README.md`)
- Project scanner → Progress calculator: provides scan results (evidence: `progress-tracking-bundle/tools/progress-tracking/update-progress.js`)
- Progress calculator → Milestone derivation: provides progress (evidence: `progress-tracking-bundle/tools/progress-tracking/update-progress.js`)
- Progress calculator → Dashboard generator: provides metrics (evidence: `progress-tracking-bundle/tools/progress-tracking/update-progress.js`)
- Milestone derivation → Dashboard generator: provides milestones (evidence: `progress-tracking-bundle/tools/progress-tracking/update-progress.js`)
- Dashboard generator → Progress dashboard: generates (evidence: `README.md`)
- Terminal dashboard → Project scanner: calls scan functions (evidence: `progress-tracking-bundle/tools/progress-tracking/progress-terminal.js`)
- File watcher → Project scanner: executes update script (evidence: `progress-tracking-bundle/tools/progress-tracking/progress-watcher.js`)
- Update trigger → Project scanner: executes update script (evidence: `progress-tracking-bundle/tools/progress-tracking/trigger-progress-update.js`)
- Progress CLI → Terminal dashboard: dispatches view
- Progress CLI → File watcher: dispatches watch
