bmad-enhanced 1.5.1 → 1.6.0

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 (145) hide show
  1. package/CHANGELOG.md +104 -6
  2. package/INSTALLATION.md +93 -245
  3. package/README.md +121 -1106
  4. package/UPDATE-GUIDE.md +70 -265
  5. package/_bmad/_config/agent-manifest.csv +0 -2
  6. package/_bmad/bme/_vortex/README.md +150 -0
  7. package/_bmad/bme/_vortex/agents/hypothesis-engineer.md +117 -0
  8. package/_bmad/bme/_vortex/agents/production-intelligence-specialist.md +117 -0
  9. package/_bmad/bme/_vortex/agents/research-convergence-specialist.md +117 -0
  10. package/_bmad/bme/_vortex/compass-routing-reference.md +312 -0
  11. package/_bmad/bme/_vortex/config.yaml +2 -2
  12. package/_bmad/bme/_vortex/contracts/hc1-empathy-artifacts.md +152 -0
  13. package/_bmad/bme/_vortex/contracts/hc2-problem-definition.md +125 -0
  14. package/_bmad/bme/_vortex/contracts/hc3-hypothesis-contract.md +112 -0
  15. package/_bmad/bme/_vortex/contracts/hc4-experiment-context.md +140 -0
  16. package/_bmad/bme/_vortex/contracts/hc5-signal-report.md +130 -0
  17. package/_bmad/bme/_vortex/examples/hc2-example-problem-definition.md +85 -0
  18. package/_bmad/bme/_vortex/examples/hc3-example-hypothesis-contract.md +103 -0
  19. package/_bmad/bme/_vortex/examples/hc5-example-signal-report.md +76 -0
  20. package/_bmad/bme/_vortex/guides/LIAM-USER-GUIDE.md +260 -0
  21. package/_bmad/bme/_vortex/guides/MILA-USER-GUIDE.md +240 -0
  22. package/_bmad/bme/_vortex/guides/NOAH-USER-GUIDE.md +263 -0
  23. package/_bmad/bme/_vortex/workflows/assumption-mapping/steps/step-01-setup.md +66 -0
  24. package/_bmad/bme/_vortex/workflows/assumption-mapping/steps/step-02-context.md +93 -0
  25. package/_bmad/bme/_vortex/workflows/assumption-mapping/steps/step-03-risk-mapping.md +103 -0
  26. package/_bmad/bme/_vortex/workflows/assumption-mapping/steps/step-04-synthesize.md +101 -0
  27. package/_bmad/bme/_vortex/workflows/assumption-mapping/workflow.md +49 -0
  28. package/_bmad/bme/_vortex/workflows/behavior-analysis/steps/step-01-setup.md +81 -0
  29. package/_bmad/bme/_vortex/workflows/behavior-analysis/steps/step-02-context.md +67 -0
  30. package/_bmad/bme/_vortex/workflows/behavior-analysis/steps/step-03-classification.md +98 -0
  31. package/_bmad/bme/_vortex/workflows/behavior-analysis/steps/step-04-evidence.md +100 -0
  32. package/_bmad/bme/_vortex/workflows/behavior-analysis/steps/step-05-synthesize.md +174 -0
  33. package/_bmad/bme/_vortex/workflows/behavior-analysis/workflow.md +52 -0
  34. package/_bmad/bme/_vortex/workflows/contextualize-scope/contextualize-scope.template.md +1 -1
  35. package/_bmad/bme/_vortex/workflows/empathy-map/steps/step-06-synthesize.md +4 -1
  36. package/_bmad/bme/_vortex/workflows/experiment-design/steps/step-01-setup.md +66 -0
  37. package/_bmad/bme/_vortex/workflows/experiment-design/steps/step-02-context.md +77 -0
  38. package/_bmad/bme/_vortex/workflows/experiment-design/steps/step-03-design.md +114 -0
  39. package/_bmad/bme/_vortex/workflows/experiment-design/steps/step-04-synthesize.md +128 -0
  40. package/_bmad/bme/_vortex/workflows/experiment-design/workflow.md +51 -0
  41. package/_bmad/bme/_vortex/workflows/hypothesis-engineering/steps/step-01-setup.md +66 -0
  42. package/_bmad/bme/_vortex/workflows/hypothesis-engineering/steps/step-02-context.md +80 -0
  43. package/_bmad/bme/_vortex/workflows/hypothesis-engineering/steps/step-03-brainwriting.md +79 -0
  44. package/_bmad/bme/_vortex/workflows/hypothesis-engineering/steps/step-04-assumption-mapping.md +102 -0
  45. package/_bmad/bme/_vortex/workflows/hypothesis-engineering/steps/step-05-synthesize.md +130 -0
  46. package/_bmad/bme/_vortex/workflows/hypothesis-engineering/workflow.md +52 -0
  47. package/_bmad/bme/_vortex/workflows/lean-experiment/steps/step-06.md +4 -1
  48. package/_bmad/bme/_vortex/workflows/lean-persona/lean-persona.template.md +1 -1
  49. package/_bmad/bme/_vortex/workflows/learning-card/learning-card.template.md +1 -1
  50. package/_bmad/bme/_vortex/workflows/learning-card/steps/step-06-synthesize.md +4 -1
  51. package/_bmad/bme/_vortex/workflows/mvp/mvp.template.md +1 -1
  52. package/_bmad/bme/_vortex/workflows/mvp/steps/step-06-synthesize.md +3 -0
  53. package/_bmad/bme/_vortex/workflows/pattern-mapping/steps/step-01-setup.md +102 -0
  54. package/_bmad/bme/_vortex/workflows/pattern-mapping/steps/step-02-context.md +81 -0
  55. package/_bmad/bme/_vortex/workflows/pattern-mapping/steps/step-03-pattern-identification.md +88 -0
  56. package/_bmad/bme/_vortex/workflows/pattern-mapping/steps/step-04-theme-clustering.md +100 -0
  57. package/_bmad/bme/_vortex/workflows/pattern-mapping/steps/step-05-synthesize.md +135 -0
  58. package/_bmad/bme/_vortex/workflows/pattern-mapping/workflow.md +58 -0
  59. package/_bmad/bme/_vortex/workflows/pivot-patch-persevere/pivot-patch-persevere.template.md +1 -1
  60. package/_bmad/bme/_vortex/workflows/pivot-patch-persevere/steps/step-06-action-plan.md +5 -2
  61. package/_bmad/bme/_vortex/workflows/pivot-resynthesis/steps/step-01-setup.md +97 -0
  62. package/_bmad/bme/_vortex/workflows/pivot-resynthesis/steps/step-02-context.md +86 -0
  63. package/_bmad/bme/_vortex/workflows/pivot-resynthesis/steps/step-03-jtbd-reframing.md +88 -0
  64. package/_bmad/bme/_vortex/workflows/pivot-resynthesis/steps/step-04-pains-gains-revision.md +76 -0
  65. package/_bmad/bme/_vortex/workflows/pivot-resynthesis/steps/step-05-synthesize.md +158 -0
  66. package/_bmad/bme/_vortex/workflows/pivot-resynthesis/workflow.md +52 -0
  67. package/_bmad/bme/_vortex/workflows/product-vision/product-vision.template.md +1 -1
  68. package/_bmad/bme/_vortex/workflows/production-monitoring/steps/step-01-setup.md +84 -0
  69. package/_bmad/bme/_vortex/workflows/production-monitoring/steps/step-02-context.md +66 -0
  70. package/_bmad/bme/_vortex/workflows/production-monitoring/steps/step-03-monitoring.md +74 -0
  71. package/_bmad/bme/_vortex/workflows/production-monitoring/steps/step-04-prioritization.md +97 -0
  72. package/_bmad/bme/_vortex/workflows/production-monitoring/steps/step-05-synthesize.md +183 -0
  73. package/_bmad/bme/_vortex/workflows/production-monitoring/workflow.md +52 -0
  74. package/_bmad/bme/_vortex/workflows/proof-of-concept/steps/step-06.md +3 -0
  75. package/_bmad/bme/_vortex/workflows/proof-of-value/steps/step-06.md +3 -0
  76. package/_bmad/bme/_vortex/workflows/research-convergence/steps/step-01-setup.md +69 -0
  77. package/_bmad/bme/_vortex/workflows/research-convergence/steps/step-02-context.md +70 -0
  78. package/_bmad/bme/_vortex/workflows/research-convergence/steps/step-03-jtbd-framing.md +81 -0
  79. package/_bmad/bme/_vortex/workflows/research-convergence/steps/step-04-pains-gains.md +77 -0
  80. package/_bmad/bme/_vortex/workflows/research-convergence/steps/step-05-synthesize.md +147 -0
  81. package/_bmad/bme/_vortex/workflows/research-convergence/workflow.md +50 -0
  82. package/_bmad/bme/_vortex/workflows/signal-interpretation/steps/step-01-setup.md +68 -0
  83. package/_bmad/bme/_vortex/workflows/signal-interpretation/steps/step-02-context.md +67 -0
  84. package/_bmad/bme/_vortex/workflows/signal-interpretation/steps/step-03-signal-analysis.md +85 -0
  85. package/_bmad/bme/_vortex/workflows/signal-interpretation/steps/step-04-anomaly-detection.md +93 -0
  86. package/_bmad/bme/_vortex/workflows/signal-interpretation/steps/step-05-synthesize.md +163 -0
  87. package/_bmad/bme/_vortex/workflows/signal-interpretation/workflow.md +52 -0
  88. package/_bmad/bme/_vortex/workflows/user-discovery/steps/step-06-synthesize.md +4 -1
  89. package/_bmad/bme/_vortex/workflows/user-interview/steps/step-06-synthesize.md +4 -1
  90. package/_bmad/bme/_vortex/workflows/user-interview/user-interview.template.md +1 -1
  91. package/_bmad/bme/_vortex/workflows/user-interview/validate.md +1 -1
  92. package/_bmad-output/implementation-artifacts/1-1-expand-agent-registry-to-7-agents.md +190 -0
  93. package/_bmad-output/implementation-artifacts/1-2-update-validator-config-merger-doctor-for-7-agents.md +184 -0
  94. package/_bmad-output/implementation-artifacts/1-3-create-migration-delta-installer-updates.md +270 -0
  95. package/_bmad-output/implementation-artifacts/1-4-define-handoff-contract-schemas-hc1-hc5.md +292 -0
  96. package/_bmad-output/implementation-artifacts/1-5-create-compass-routing-reference-document.md +324 -0
  97. package/_bmad-output/implementation-artifacts/2-1-design-milas-agent-definition-persona.md +270 -0
  98. package/_bmad-output/implementation-artifacts/2-2-create-research-convergence-workflow.md +429 -0
  99. package/_bmad-output/implementation-artifacts/2-3-create-pivot-resynthesis-workflow.md +411 -0
  100. package/_bmad-output/implementation-artifacts/2-4-create-pattern-mapping-workflow.md +397 -0
  101. package/_bmad-output/implementation-artifacts/2-5-create-mila-user-guide-example-artifacts.md +243 -0
  102. package/_bmad-output/implementation-artifacts/3-1-design-liams-agent-definition-persona.md +301 -0
  103. package/_bmad-output/implementation-artifacts/3-2-create-hypothesis-engineering-workflow.md +403 -0
  104. package/_bmad-output/implementation-artifacts/3-3-create-assumption-mapping-workflow.md +373 -0
  105. package/_bmad-output/implementation-artifacts/3-4-create-experiment-design-workflow.md +359 -0
  106. package/_bmad-output/implementation-artifacts/3-5-create-liam-user-guide-example-artifacts.md +258 -0
  107. package/_bmad-output/implementation-artifacts/4-1-design-noahs-agent-definition-persona.md +191 -0
  108. package/_bmad-output/implementation-artifacts/4-2-create-signal-interpretation-workflow.md +352 -0
  109. package/_bmad-output/implementation-artifacts/4-3-create-behavior-analysis-workflow.md +406 -0
  110. package/_bmad-output/implementation-artifacts/4-4-create-production-monitoring-workflow.md +430 -0
  111. package/_bmad-output/implementation-artifacts/4-5-create-noah-user-guide-example-artifacts.md +342 -0
  112. package/_bmad-output/implementation-artifacts/5-1-update-islas-compass-routes-to-mila.md +210 -0
  113. package/_bmad-output/implementation-artifacts/5-2-update-wades-maxs-compass-routes.md +260 -0
  114. package/_bmad-output/implementation-artifacts/5-3-update-documentation-for-complete-7-agent-vortex.md +268 -0
  115. package/_bmad-output/implementation-artifacts/5-4-add-ci-dead-end-detection-final-version-bump.md +206 -0
  116. package/_bmad-output/implementation-artifacts/epic-1-retro-2026-02-24.md +90 -0
  117. package/_bmad-output/implementation-artifacts/epic-2-retro-2026-02-25.md +104 -0
  118. package/_bmad-output/implementation-artifacts/epic-3-retro-2026-02-25.md +126 -0
  119. package/_bmad-output/implementation-artifacts/epic-4-retro-2026-02-26.md +151 -0
  120. package/_bmad-output/implementation-artifacts/epic-5-retro-2026-02-26.md +168 -0
  121. package/_bmad-output/implementation-artifacts/sprint-status.yaml +85 -0
  122. package/_bmad-output/planning-artifacts/architecture.md +607 -0
  123. package/_bmad-output/planning-artifacts/epics.md +826 -0
  124. package/_bmad-output/planning-artifacts/implementation-readiness-report-2026-02-23.md +156 -0
  125. package/_bmad-output/planning-artifacts/prd.md +498 -0
  126. package/_bmad-output/planning-artifacts/product-brief-BMAD-Enhanced-2026-02-22.md +262 -0
  127. package/_bmad-output/vortex-artifacts/EMMA-USER-GUIDE.md +10 -10
  128. package/_bmad-output/vortex-artifacts/ISLA-USER-GUIDE.md +4 -4
  129. package/_bmad-output/vortex-artifacts/MAX-USER-GUIDE.md +4 -4
  130. package/_bmad-output/vortex-artifacts/WADE-USER-GUIDE.md +10 -10
  131. package/index.js +6 -5
  132. package/package.json +2 -6
  133. package/scripts/bmad-doctor.js +3 -7
  134. package/scripts/install-vortex-agents.js +23 -18
  135. package/scripts/postinstall.js +5 -10
  136. package/scripts/update/bmad-update.js +136 -87
  137. package/scripts/update/lib/agent-registry.js +144 -0
  138. package/scripts/update/lib/config-merger.js +75 -43
  139. package/scripts/update/lib/migration-runner.js +2 -1
  140. package/scripts/update/lib/refresh-installation.js +4 -37
  141. package/scripts/update/lib/validator.js +69 -19
  142. package/scripts/update/migrations/1.5.x-to-1.6.0.js +95 -0
  143. package/scripts/update/migrations/registry.js +7 -0
  144. package/scripts/install-emma.js +0 -14
  145. package/scripts/install-wade.js +0 -14
package/CHANGELOG.md CHANGED
@@ -7,10 +7,74 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
7
7
 
8
8
  ---
9
9
 
10
+ ## [1.6.0] - 2026-02-26
11
+
12
+ ### Added
13
+
14
+ - **Mila — Research Convergence Specialist** (Stream 3: Synthesize) — New agent that converges divergent research into actionable problem definitions using JTBD framing and Pains & Gains analysis
15
+ - `research-convergence` workflow — Synthesize multiple research artifacts into a single problem definition
16
+ - `pivot-resynthesis` workflow — Re-synthesize problem definition after failed experiments
17
+ - `pattern-mapping` workflow — Surface convergent patterns across research sources
18
+ - **Liam — Hypothesis Engineer** (Stream 4: Hypothesize) — New agent that engineers testable hypotheses from validated problem definitions using structured brainwriting and assumption mapping
19
+ - `hypothesis-engineering` workflow — Produce testable hypotheses in 4-field contract format
20
+ - `assumption-mapping` workflow — Classify hidden assumptions by risk level
21
+ - `experiment-design` workflow — Design experiments targeting riskiest assumptions first
22
+ - **Noah — Production Intelligence Specialist** (Stream 6: Sensitize) — New agent that interprets production signals through experiment lineage context
23
+ - `signal-interpretation` workflow — Contextual interpretation of production signals
24
+ - `behavior-analysis` workflow — Behavioral pattern analysis against experiment baselines
25
+ - `production-monitoring` workflow — Multi-signal monitoring across active experiments
26
+ - **10 Handoff Contracts (HC1-HC10)** — Structured information flow between all 7 agents
27
+ - HC1-HC5: Artifact contracts with schema definitions in `_bmad/bme/_vortex/contracts/`
28
+ - HC6-HC8: Decision-driven routing contracts (Max → Mila/Isla/Emma)
29
+ - HC9-HC10: Flag-driven routing contracts (Liam → Isla, Noah → Isla)
30
+ - **Compass Routing** — Every workflow's final step includes evidence-driven routing table with agent recommendations
31
+ - **Compass Routing Reference** — Authoritative routing document (`_bmad/bme/_vortex/compass-routing-reference.md`) defining all routes across 22 workflows
32
+ - **Cross-agent routing for existing agents** — Emma, Isla, Wade, and Max now route to Mila, Liam, and Noah where appropriate
33
+ - **Module README** — Technical inventory at `_bmad/bme/_vortex/README.md` with complete agent, workflow, and contract listings
34
+ - **Extensibility documentation** — 4-step pattern for adding new agents (registry → agent file → workflows → guide) validates NFR9/E4
35
+
36
+ ### Changed
37
+
38
+ - **README.md** — Updated from 4-agent to 7-agent framework with non-linear Vortex diagram, 10 HC contracts, and Compass routing
39
+ - **docs/agents.md** — Expanded from 4-agent reference to comprehensive 7-agent practitioner guide with user journeys, handoff contracts, and Compass documentation
40
+ - **Agent registry** — Now contains 7 agents and 22 workflows (was 4 agents, 13 workflows)
41
+ - **Roadmap** — v1.6.0 marked as current release; Wave 3 complete
42
+
43
+ ---
44
+
45
+ ## [1.5.2] - 2026-02-22
46
+
47
+ ### Changed
48
+
49
+ - **Registry-driven postinstall** — `postinstall.js` now imports from `agent-registry.js` instead of hardcoding agent names; agent list stays current automatically
50
+ - **Removed deprecated installer wrappers** — Deleted `install-emma.js` and `install-wade.js`; removed `bmad-install-emma` / `bmad-install-wade` bin entries and `install:emma` / `install:wade` scripts
51
+ - **Manifest persona data moved to registry** — `createAgentManifest()` now reads role, identity, communication_style, and expertise from `agent-registry.js` instead of hardcoded CSV strings
52
+ - **Formalized config schema** — `validateConfig()` rewritten to iterate a declarative `CONFIG_SCHEMA`; added type checks for `submodule_name`, `module`, `output_folder`, `communication_language`, `party_mode_enabled`, and array-item types for `agents`/`workflows`
53
+
54
+ ### Fixed
55
+
56
+ - CHANGELOG.md backfilled with missing v1.4.0, v1.4.1, and v1.5.1 entries
57
+
58
+ ---
59
+
10
60
  ## [1.5.1] - 2026-02-20
11
61
 
12
62
  ### Added
13
63
 
64
+ - **Test hardening** — 184 tests (130 unit + 54 integration), all green
65
+ - Line coverage raised to 83.4% (up from 68%)
66
+ - `validator.js` coverage: 96% (was 21%)
67
+ - `migration-runner.js` coverage: 81% (was 28%)
68
+ - Installer E2E test (CLI as child process)
69
+ - `bmad-doctor` negative-path tests (8 scenarios)
70
+
71
+ ### Fixed
72
+
73
+ - Validator now checks all 4 agents (was only 2)
74
+ - `mergeConfig` seeds structural defaults for fresh installs so config and validation stay consistent
75
+
76
+ ### Added
77
+
14
78
  - **Vortex Compass** — Evidence-driven cross-stream navigation in every workflow's final step
15
79
  - Conditional "If you learned X → go to Y" tables replace fixed "Next suggested workflow" links
16
80
  - Each compass points to workflows across different agents, creating true vortex loops
@@ -45,6 +109,40 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
45
109
 
46
110
  ---
47
111
 
112
+ ## [1.4.1] - 2026-02-19
113
+
114
+ ### Added
115
+
116
+ - CI pipeline with GitHub Actions (lint + test on Node 18/20/22)
117
+ - ESLint configuration and full lint pass
118
+ - `bmad-doctor` diagnostic CLI with 7 installation checks
119
+ - 112 tests (82 unit + 30 integration)
120
+ - `.c8rc.json` for coverage configuration
121
+
122
+ ### Fixed
123
+
124
+ - Silenced console in tests that trigger heavy source-code logging (Node 20 IPC bug)
125
+
126
+ ---
127
+
128
+ ## [1.4.0] - 2026-02-18
129
+
130
+ ### Changed
131
+
132
+ - **Architecture refactor** — Centralized agent/workflow data into `agent-registry.js`
133
+ - Single source of truth consumed by validator, refresh-installation, bmad-doctor, migration-runner, and index.js
134
+ - To add a new agent: push one entry to `AGENTS` + its workflows to `WORKFLOWS`; all consumers pick up the change automatically
135
+ - **`refresh-installation.js`** — Shared refresh logic extracted; copies agents, workflows, config, and user guides from package to project
136
+ - **`migration-runner.js`** — Rewritten as 8-step orchestration (deltas → refresh → validate) with lock file, backup, and rollback
137
+ - **`validator.js`** — Data-driven validation using registry arrays instead of hardcoded checks
138
+ - **`config-merger.js`** — Seeds structural defaults (`submodule_name`, `description`, `module`, `output_folder`) so fresh installs pass validation
139
+
140
+ ### Removed
141
+
142
+ - Hardcoded agent/workflow arrays throughout codebase (replaced by registry imports)
143
+
144
+ ---
145
+
48
146
  ## [1.3.6] - 2026-02-18
49
147
 
50
148
  ### Fixed
@@ -127,7 +225,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
127
225
  ### Fixed
128
226
 
129
227
  **🚨 CRITICAL Package Bug:**
130
- - Fixed `.npmignore` excluding Vortex framework files from published package
228
+ - Fixed `.npmignore` excluding Vortex pattern files from published package
131
229
  - Agent files (`contextualization-expert.md`, `lean-experiments-specialist.md`) now included in package
132
230
  - All workflow template files now included in package
133
231
  - `CHANGELOG.md` and `UPDATE-GUIDE.md` now included in package
@@ -355,9 +453,9 @@ npx bmad-update
355
453
 
356
454
  ## [1.2.0] - 2026-02-17
357
455
 
358
- ### Major Release: Complete Vortex Framework Implementation
456
+ ### Major Release: Complete Vortex Pattern Implementation
359
457
 
360
- This release completes the Vortex Framework by implementing all 7 new Lean Startup workflows, updating documentation, and cleaning up deprecated workflows.
458
+ This release completes the Vortex Pattern by implementing all 7 new Lean Startup workflows, updating documentation, and cleaning up deprecated workflows.
361
459
 
362
460
  ### Added
363
461
 
@@ -485,7 +583,7 @@ This release completes the Vortex Framework by implementing all 7 new Lean Start
485
583
 
486
584
  ## [1.1.0] - 2026-02-16
487
585
 
488
- ### MAJOR REPOSITIONING: From Design Agents to Vortex Framework
586
+ ### MAJOR REPOSITIONING: From Design Agents to Vortex Pattern
489
587
 
490
588
  This release represents a fundamental repositioning of BMAD-Enhanced from design-focused agents (empathy mapping, wireframing) to a Lean Startup validation framework.
491
589
 
@@ -501,11 +599,11 @@ This release represents a fundamental repositioning of BMAD-Enhanced from design
501
599
  - New workflows: mvp, lean-experiment, proof-of-concept, proof-of-value (wireframe deprecated)
502
600
  - **BREAKING:** Output folder changed from `_bmad-output/design-artifacts` to `_bmad-output/vortex-artifacts`
503
601
  - Updated all installer scripts to reflect new module name and agent descriptions
504
- - Updated config.yaml structure to version 1.1.0 with Vortex framework metadata
602
+ - Updated config.yaml structure to version 1.1.0 with Vortex pattern metadata
505
603
  - Updated agent-manifest.csv with new agent identities and expertise
506
604
 
507
605
  ### Added
508
- - Vortex framework structure with Contextualize and Externalize streams
606
+ - Vortex pattern structure with Contextualize and Externalize streams
509
607
  - 7 new workflow placeholders (v1.2.0):
510
608
  - Emma (Contextualize): lean-persona, product-vision, contextualize-scope
511
609
  - Wade (Externalize): mvp, lean-experiment, proof-of-concept, proof-of-value
package/INSTALLATION.md CHANGED
@@ -1,124 +1,52 @@
1
- # BMAD-Enhanced Installation Guide
1
+ # Installation Guide
2
2
 
3
- Complete guide to installing BMAD-Enhanced agents into your project.
3
+ Complete guide to installing BMAD-Enhanced Vortex agents into your project.
4
4
 
5
5
  ---
6
6
 
7
- ## ⚠️ Prerequisites
7
+ ## Prerequisites
8
8
 
9
- **BMAD Method Required**
9
+ - Node.js 18+ or Bun
10
+ - Git
11
+ - Claude Code or Claude.ai
10
12
 
11
- BMAD-Enhanced is an **extension package** for the [BMAD Method](https://github.com/bmadhub/bmad). You **must** install BMAD Method first.
12
-
13
- ### Step 1: Install BMAD Method
14
-
15
- ```bash
16
- # Install BMAD Method using npx
17
- npx bmad-method@alpha install
18
-
19
- # Verify BMAD is installed
20
- ls _bmad/ # Should show BMAD directory structure
21
- ```
22
-
23
- ### Step 2: Install BMAD-Enhanced Agents
24
-
25
- Once BMAD Method is installed, proceed with BMAD-Enhanced installation below.
13
+ BMAD-Enhanced works **standalone** or as an extension to [BMAD Method](https://github.com/bmadhub/bmad). No prior BMAD installation required.
26
14
 
27
15
  ---
28
16
 
29
17
  ## Quick Install
30
18
 
31
- **Install all agents at once:**
32
-
33
19
  ```bash
34
- # From your project directory (where BMAD Method is installed)
35
- npm install bmad-enhanced@alpha
36
- npx bmad-install-agents
20
+ npm install bmad-enhanced && npx bmad-install-vortex-agents
37
21
  ```
38
22
 
39
- That's it! Emma and Wade are now added to your BMAD installation.
23
+ All 4 Vortex agents (Emma, Isla, Wade, Max) with 13 workflows are installed and ready to use.
40
24
 
41
25
  ---
42
26
 
43
27
  ## Installation Options
44
28
 
45
- ### Option 1: Install All Agents (Recommended)
46
-
47
- Install both Emma (empathy-mapper) and Wade (wireframe-designer) at once.
29
+ ### Option 1: Install from npm (Recommended)
48
30
 
49
31
  ```bash
50
- npm install bmad-enhanced@alpha
51
- npx bmad-install-agents
52
- ```
32
+ # Install into your project
33
+ npm install bmad-enhanced
53
34
 
54
- **Output:**
35
+ # Install all Vortex agents and workflows
36
+ npx bmad-install-vortex-agents
55
37
  ```
56
- ╔════════════════════════════════════════════════════╗
57
- ║ ║
58
- ║ BMAD-Enhanced Complete Installer 🚀 ║
59
- ║ ║
60
- ║ Installing Emma + Wade Design Agents ║
61
- ║ ║
62
- ╚════════════════════════════════════════════════════╝
63
-
64
- [1/5] Checking prerequisites...
65
- ✓ Prerequisites met
66
- [2/5] Installing Emma + Wade agent files...
67
- → Installing Emma (empathy-mapper)...
68
- ✓ Emma installed
69
- → Installing Wade (wireframe-designer)...
70
- ✓ Wade installed
71
- [3/5] Configuring agents...
72
- ✓ Created config.yaml
73
- ✓ Created agent-manifest.csv
74
- [4/5] Setting up output directory...
75
- ✓ Output directory ready
76
- [5/5] Installing user guides...
77
- ✓ User guides installed
78
-
79
- ╔════════════════════════════════════════════════════╗
80
- ║ ║
81
- ║ ✓ All Agents Successfully Installed! 🎉 ║
82
- ║ ║
83
- ╚════════════════════════════════════════════════════╝
84
-
85
- Installed Agents:
86
-
87
- ✓ Emma (empathy-mapper) - Empathy Mapping Specialist 🎨
88
- ✓ Wade (wireframe-designer) - Wireframe Design Expert 🎨
89
- ```
90
-
91
- ---
92
38
 
93
- ### Option 2: Install Individual Agents
39
+ ### Option 2: Clone from Source (Contributors Only)
94
40
 
95
- Install Emma or Wade separately.
41
+ For contributors or developers who want to modify agents or contribute to the project. This sets up a development environment — not an end-user installation.
96
42
 
97
- **Install Emma only:**
98
43
  ```bash
99
- npm install bmad-enhanced@alpha
100
- npx bmad-install-emma
101
- ```
102
-
103
- **Install Wade only:**
104
- ```bash
105
- npm install bmad-enhanced@alpha
106
- npx bmad-install-wade
107
- ```
108
-
109
- ---
110
-
111
- ### Option 3: Clone from Source
112
-
113
- For contributors or advanced users who want to modify agents.
114
-
115
- ```bash
116
- git clone https://github.com/yourusername/BMAD-Enhanced.git
44
+ git clone https://github.com/amalik/BMAD-Enhanced.git
117
45
  cd BMAD-Enhanced
118
46
  npm install
119
47
  ```
120
48
 
121
- Agents are already installed in the repository. No additional steps needed.
49
+ Agents are pre-installed in the repository for development. Note that this does not create the same output directory structure as the npm install path — use Option 1 for project installations.
122
50
 
123
51
  ---
124
52
 
@@ -130,238 +58,158 @@ Agents are already installed in the repository. No additional steps needed.
130
58
  your-project/
131
59
  ├── _bmad/
132
60
  │ ├── bme/
133
- │ │ └── _designos/
61
+ │ │ └── _vortex/
134
62
  │ │ ├── agents/
135
- │ │ │ ├── empathy-mapper.md # Emma agent definition
136
- │ │ │ └── wireframe-designer.md # Wade agent definition
63
+ │ │ │ ├── contextualization-expert.md # Emma
64
+ │ │ │ ├── discovery-empathy-expert.md # Isla
65
+ │ │ │ ├── lean-experiments-specialist.md # Wade
66
+ │ │ │ └── learning-decision-expert.md # Max
137
67
  │ │ ├── workflows/
138
- │ │ │ ├── empathy-map/
139
- │ │ │ ├── workflow.md # Main empathy map workflow
140
- │ │ │ ├── empathy-map.template.md # Output template
141
- │ │ │ │ └── steps/
142
- │ │ │ ├── step-01-define-user.md
143
- │ │ │ ├── step-02-says-thinks.md
144
- │ │ │ ├── step-03-does-feels.md
145
- │ │ │ ├── step-04-pain-points.md
146
- │ │ │ ├── step-05-gains.md
147
- │ │ │ │ └── step-06-synthesize.md
148
- │ │ │ └── wireframe/
149
- │ │ │ ├── workflow.md # Main wireframe workflow
150
- │ │ │ ├── wireframe.template.md # Output template
151
- │ │ └── steps/
152
- │ │ │ ├── step-01-define-requirements.md
153
- │ │ │ ├── step-02-user-flows.md
154
- │ │ │ ├── step-03-information-architecture.md
155
- │ │ │ ├── step-04-wireframe-sketch.md
156
- │ │ │ ├── step-05-components-interactions.md
157
- │ │ │ └── step-06-synthesize.md
158
- │ │ └── config.yaml # Agent configuration
68
+ │ │ │ ├── lean-persona/ # Emma workflows
69
+ │ │ │ ├── product-vision/
70
+ │ │ │ ├── contextualize-scope/
71
+ │ │ │ ├── empathy-map/ # Isla workflows
72
+ │ │ │ ├── user-interview/
73
+ │ │ │ ├── user-discovery/
74
+ │ │ │ ├── mvp/ # Wade workflows
75
+ │ │ │ ├── lean-experiment/
76
+ │ │ │ ├── proof-of-concept/
77
+ │ │ │ ├── proof-of-value/
78
+ │ │ │ ├── learning-card/ # Max workflows
79
+ │ │ │ ├── pivot-patch-persevere/
80
+ │ │ │ └── vortex-navigation/
81
+ │ │ └── config.yaml
159
82
  │ └── _config/
160
- │ └── agent-manifest.csv # Agent registry
83
+ │ └── agent-manifest.csv
161
84
  └── _bmad-output/
162
- └── design-artifacts/
163
- ├── EMMA-USER-GUIDE.md # Complete Emma documentation
164
- ├── WADE-USER-GUIDE.md # Complete Wade documentation
165
- └── (your generated artifacts) # Empathy maps, wireframes, etc.
85
+ └── vortex-artifacts/
86
+ ├── EMMA-USER-GUIDE.md
87
+ ├── ISLA-USER-GUIDE.md
88
+ ├── WADE-USER-GUIDE.md
89
+ ├── MAX-USER-GUIDE.md
90
+ └── (your generated artifacts)
166
91
  ```
167
92
 
168
- ### File Sizes
93
+ ### Summary
169
94
 
170
- - **Emma Agent Files:** ~45KB (agent + 6 workflow steps + template)
171
- - **Wade Agent Files:** ~52KB (agent + 6 workflow steps + template)
172
- - **Emma User Guide:** 16KB
173
- - **Wade User Guide:** 16KB
174
- - **Total:** ~129KB
95
+ - **4 agent definitions** in `_bmad/bme/_vortex/agents/`
96
+ - **13 workflows** (104 files) each with steps, templates, and validation
97
+ - **Configuration** in `_bmad/bme/_vortex/config.yaml`
98
+ - **4 user guides** in `_bmad-output/vortex-artifacts/`
175
99
 
176
100
  ---
177
101
 
178
102
  ## Configuration
179
103
 
180
- ### config.yaml
181
-
182
- Default configuration created during installation:
104
+ The installer creates `_bmad/bme/_vortex/config.yaml`. The key fields you'll want to customize:
183
105
 
184
106
  ```yaml
185
- # BMAD _designos Configuration
186
- # Used by: Emma (empathy-mapper), Wade (wireframe-designer)
187
-
188
- user_name: "User"
189
- communication_language: "English"
190
- output_folder: "_bmad-output/design-artifacts"
191
-
192
- agents:
193
- - empathy-mapper # Emma - Empathy Mapping Specialist
194
- - wireframe-designer # Wade - Wireframe Specialist
195
-
196
- workflows:
197
- - empathy-map # Create empathy maps
198
- - wireframe # Create wireframes
107
+ # User-facing settings
108
+ user_name: "{user}" # Your name (used in agent greetings)
109
+ communication_language: "en" # Language for agent communication
110
+ output_folder: "{project-root}/_bmad-output/vortex-artifacts" # Where artifacts are saved
199
111
  ```
200
112
 
201
- **Customization:**
202
- - `user_name`: Your name (used in agent greetings)
203
- - `communication_language`: Language for agent communication
204
- - `output_folder`: Where artifacts are saved
113
+ The config also includes auto-generated fields (`submodule_name`, `module`, `version`, `agents`, `workflows`) that you typically don't need to edit — the installer and update system manage those.
205
114
 
206
115
  ---
207
116
 
208
117
  ## Verification
209
118
 
210
- After installation, verify agents are working:
211
-
212
- ### Test Emma
119
+ After installation, verify agents are working by activating one:
213
120
 
214
121
  ```bash
215
- cat _bmad/bme/_designos/agents/empathy-mapper.md
122
+ cat _bmad/bme/_vortex/agents/contextualization-expert.md # Emma
216
123
  ```
217
124
 
218
- **Expected output:**
219
- ```
220
- Hey there! Emma here - your empathy mapping specialist. 🎨
125
+ **Expected result:** Emma should greet you by name and display a numbered menu like this:
221
126
 
222
- I help teams build deep understanding of users through structured empathy mapping...
223
-
224
- Here's what I can do for you:
127
+ ```
128
+ Hey Amalik! I'm Emma — your Contextualization Expert...
225
129
 
226
130
  1. [MH] Redisplay Menu Help
227
- 2. [CH] Chat with Emma about empathy mapping, user research, or Jobs-to-be-Done
228
- 3. [EM] Create Empathy Map: Guided 5-step process to create comprehensive empathy maps
229
- 4. [VM] Validate Empathy Map: Review existing empathy map against research best practices
230
- 5. [PM] Start Party Mode
231
- 6. [DA] Dismiss Agent
232
-
233
- What would you like to do?
131
+ 2. [CH] Chat with Emma
132
+ 3. [LP] Lean Persona
133
+ 4. [PV] Product Vision
134
+ 5. [CS] Contextualize Scope
135
+ ...
234
136
  ```
235
137
 
236
- ### Test Wade
138
+ If the agent doesn't activate or you see raw markdown instead, run diagnostics:
237
139
 
238
140
  ```bash
239
- cat _bmad/bme/_designos/agents/wireframe-designer.md
141
+ npx bmad-doctor
240
142
  ```
241
143
 
242
- **Expected output:**
243
- ```
244
- Hey there! Wade here - your wireframe design specialist. 🎨
245
-
246
- Ready to turn ideas into structured layouts? I'll help you create wireframes...
247
-
248
- Here's what I can do for you:
249
-
250
- 1. [MH] Redisplay Menu Help
251
- 2. [CH] Chat with Wade about wireframe design, UI patterns, or information architecture
252
- 3. [WM] Create Wireframe: Guided 6-step process to create comprehensive wireframe artifacts
253
- 4. [VM] Validate Wireframe: Review existing wireframe against usability principles
254
- 5. [PM] Start Party Mode
255
- 6. [DA] Dismiss Agent
256
-
257
- What would you like to do?
258
- ```
144
+ This checks project root, config validity, agent files, workflows, output directory, and version consistency — with actionable fix suggestions for each issue.
259
145
 
260
146
  ---
261
147
 
262
148
  ## Troubleshooting
263
149
 
264
- ### Installation fails with "Cannot find module 'fs-extra'"
150
+ Start with diagnostics it catches most issues:
265
151
 
266
- **Solution:**
267
152
  ```bash
268
- npm install fs-extra chalk
269
- npx bmad-install-agents
153
+ npx bmad-doctor
270
154
  ```
271
155
 
272
156
  ### Permission denied errors
273
157
 
274
- **Solution:**
275
158
  ```bash
276
159
  chmod +x scripts/*.js
277
- npx bmad-install-agents
160
+ npx bmad-install-vortex-agents
278
161
  ```
279
162
 
280
163
  ### Config file already exists
281
164
 
282
- The installers are smart - they will:
283
- - Update existing config files (not overwrite)
284
- - Add missing agents to existing configuration
285
- - Preserve your custom settings
165
+ The installer preserves your custom settings and only adds missing entries. To force a clean installation:
286
166
 
287
- To force a clean installation:
288
167
  ```bash
289
- rm -rf _bmad/bme/_designos/
290
- npx bmad-install-agents
168
+ rm -rf _bmad/bme/_vortex/
169
+ npx bmad-install-vortex-agents
291
170
  ```
292
171
 
293
172
  ### Installation succeeds but agents don't activate
294
173
 
295
- **Check file paths:**
296
- ```bash
297
- # Should list agent files
298
- ls -la _bmad/bme/_designos/agents/
299
-
300
- # Should list workflow files
301
- ls -la _bmad/bme/_designos/workflows/empathy-map/
302
- ls -la _bmad/bme/_designos/workflows/wireframe/
303
- ```
174
+ Check that files are in place:
304
175
 
305
- **Check config:**
306
176
  ```bash
307
- cat _bmad/bme/_designos/config.yaml
177
+ ls -la _bmad/bme/_vortex/agents/
178
+ ls -la _bmad/bme/_vortex/workflows/
179
+ npx bmad-doctor
308
180
  ```
309
181
 
310
182
  ---
311
183
 
312
184
  ## Next Steps
313
185
 
314
- After successful installation:
315
-
316
- 1. **Read User Guides**
317
- - Emma: `_bmad-output/design-artifacts/EMMA-USER-GUIDE.md`
318
- - Wade: `_bmad-output/design-artifacts/WADE-USER-GUIDE.md`
319
-
320
- 2. **Create Your First Empathy Map**
321
- ```bash
322
- cat _bmad/bme/_designos/agents/empathy-mapper.md
323
- # Then type: EM
324
- ```
186
+ 1. **Read the user guides** in `_bmad-output/vortex-artifacts/`
187
+ 2. **Activate an agent** — start with Emma for strategic framing or Isla for user research
188
+ 3. **Follow a workflow** — each agent presents a menu of guided workflows
189
+ 4. **Check updates** — run `npx bmad-version` periodically
325
190
 
326
- 3. **Create Your First Wireframe**
327
- ```bash
328
- cat _bmad/bme/_designos/agents/wireframe-designer.md
329
- # Then type: WM
330
- ```
331
-
332
- 4. **Explore Advanced Features**
333
- - Party Mode: Collaborate with multiple agents
334
- - Validation workflows: Review and improve artifacts
335
- - Custom templates: Modify output templates for your needs
191
+ See the [Agent Guide](docs/agents.md) for detailed workflow descriptions and the recommended Vortex flow.
336
192
 
337
193
  ---
338
194
 
339
195
  ## Uninstallation
340
196
 
341
- To remove BMAD-Enhanced agents:
197
+ Back up any artifacts you want to keep before removing:
342
198
 
343
199
  ```bash
344
- # Remove all agent files
345
- rm -rf _bmad/bme/_designos/
200
+ # 1. Back up your generated artifacts first
201
+ cp -r _bmad-output/vortex-artifacts/ ~/my-vortex-backup/
202
+
203
+ # 2. Remove agent files and workflows
204
+ rm -rf _bmad/bme/_vortex/
346
205
 
347
- # Remove output directory (keeps your artifacts)
348
- # WARNING: This deletes all empathy maps and wireframes!
349
- rm -rf _bmad-output/design-artifacts/
206
+ # 3. Remove generated artifacts (this deletes all your empathy maps, personas, etc.)
207
+ rm -rf _bmad-output/vortex-artifacts/
350
208
 
351
- # Uninstall npm package
209
+ # 4. Uninstall npm package
352
210
  npm uninstall bmad-enhanced
353
211
  ```
354
212
 
355
213
  ---
356
214
 
357
- ## Support
358
-
359
- - **User Guides:** See `_bmad-output/design-artifacts/` after installation
360
- - **Issues:** https://github.com/yourusername/BMAD-Enhanced/issues
361
- - **Documentation:** [README.md](README.md)
362
-
363
- ---
364
-
365
- **Version:** 1.0.4-alpha
366
- **Last Updated:** 2026-02-16
367
- **Status:** Production Ready (Emma ✅, Wade ✅)
215
+ [Back to README](README.md) | [Update Guide](UPDATE-GUIDE.md) | [Agent Guide](docs/agents.md)