bmad-method 6.0.0-alpha.13 → 6.0.0-alpha.15

package/example-custom-module/mwm/workflows/wellness-journal/README.md

@@ -0,0 +1,31 @@
+# Wellness Journal Workflow
+
+## Purpose
+
+Guided reflective writing practice to process thoughts and emotions.
+
+## Trigger
+
+WJ (from Wellness Companion agent)
+
+## Key Steps
+
+1. Set intention for journal entry
+2. Choose journal prompt or free write
+3. Guided reflection questions
+4. Emotional processing check
+5. Identify insights or patterns
+6. Save entry with mood tags
+7. Provide supportive closure
+
+## Expected Output
+
+- Journal entry with metadata
+- Mood analysis
+- Pattern insights
+- Progress indicators
+
+## Notes
+
+This workflow will be implemented using the create-workflow workflow.
+Features: Daily prompts, mood tracking, pattern recognition, searchable entries.

package/example-custom-module/mwm/workflows/wellness-journal/workflow.md

@@ -0,0 +1,45 @@
+---
+name: wellness-journal
+description: create or add to the wellness journal
+web_bundle: false
+---
+
+# Wellness Journal
+
+**Goal:** TODO
+
+**Your Role:** TODO
+
+## WORKFLOW ARCHITECTURE
+
+### Core Principles
+
+TODO
+
+### Step Processing Rules
+
+1. **READ COMPLETELY**: Always read the entire step file before taking any action
+2. **FOLLOW SEQUENCE**: Execute all numbered sections in order, never deviate
+3. **WAIT FOR INPUT**: If a menu is presented, halt and wait for user selection
+4. **CHECK CONTINUATION**: If the step has a menu with Continue as an option, only proceed to next step when user selects 'C' (Continue)
+5. **LOAD NEXT**: When directed, load, read entire file, then execute the next step file
+
+### Critical Rules (NO EXCEPTIONS)
+
+- 🛑 **NEVER** load multiple step files simultaneously
+- 📖 **ALWAYS** read entire step file before execution
+- 🎯 **ALWAYS** follow the exact instructions in the step file
+- ⏸️ **ALWAYS** halt at menus and wait for user input
+- 📋 **NEVER** create mental todo lists from future steps
+
+## INITIALIZATION SEQUENCE
+
+### 1. Module Configuration Loading
+
+Load and read full config from {project-root}/.bmad/mwm/config.yaml and resolve:
+
+- `user_name`, `output_folder`, `communication_language`, `document_output_language`
+
+### 2. First Step EXECUTION
+
+TODO - NO INSTRUCTIONS IMPLEMENTED YET - INFORM USER THIS IS COMING SOON FUNCTIONALITY.

package/package.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://json.schemastore.org/package.json",
   "name": "bmad-method",
-  "version": "6.0.0-alpha.13",
+  "version": "6.0.0-alpha.15",
   "description": "Breakthrough Method of Agile AI-driven Development",
   "keywords": [
     "agile",
@@ -24,7 +24,6 @@
     "bmad-method": "tools/bmad-npx-wrapper.js"
   },
   "scripts": {
-    "bmad:agent-install": "node tools/cli/bmad-cli.js agent-install",
     "bmad:install": "node tools/cli/bmad-cli.js install",
     "bmad:status": "node tools/cli/bmad-cli.js status",
     "bundle": "node tools/cli/bundlers/bundle-web.js all",
@@ -34,13 +33,14 @@
     "install:bmad": "node tools/cli/bmad-cli.js install",
     "lint": "eslint . --ext .js,.cjs,.mjs,.yaml --max-warnings=0",
     "lint:fix": "eslint . --ext .js,.cjs,.mjs,.yaml --fix",
+    "lint:md": "markdownlint-cli2 \"**/*.md\"",
     "prepare": "husky",
     "rebundle": "node tools/cli/bundlers/bundle-web.js rebundle",
     "release:major": "gh workflow run \"Manual Release\" -f version_bump=major",
     "release:minor": "gh workflow run \"Manual Release\" -f version_bump=minor",
     "release:patch": "gh workflow run \"Manual Release\" -f version_bump=patch",
     "release:watch": "gh run watch",
-    "test": "npm run test:schemas && npm run test:install && npm run validate:bundles && npm run validate:schemas && npm run lint && npm run format:check",
+    "test": "npm run test:schemas && npm run test:install && npm run validate:bundles && npm run validate:schemas && npm run lint && npm run lint:md && npm run format:check",
     "test:coverage": "c8 --reporter=text --reporter=html npm run test:schemas",
     "test:install": "node test/test-installation-components.js",
     "test:schemas": "node test/test-agent-schema.js",
@@ -56,7 +56,11 @@
       "eslint --fix",
       "npm run format:fix"
     ],
-    "*.{json,md}": [
+    "*.json": [
+      "npm run format:fix"
+    ],
+    "*.md": [
+      "markdownlint-cli2",
       "npm run format:fix"
     ]
   },
@@ -90,6 +94,7 @@
     "husky": "^9.1.7",
     "jest": "^30.0.4",
     "lint-staged": "^16.1.1",
+    "markdownlint-cli2": "^0.19.1",
     "prettier": "^3.5.3",
     "prettier-plugin-packagejson": "^2.5.19",
     "yaml-eslint-parser": "^1.2.3",

package/src/core/_module-installer/installer.js

@@ -6,7 +6,7 @@ const chalk = require('chalk');
  *
  * @param {Object} options - Installation options
  * @param {string} options.projectRoot - The root directory of the target project
- * @param {Object} options.config - Module configuration from install-config.yaml
+ * @param {Object} options.config - Module configuration from module.yaml
  * @param {Array<string>} options.installedIDEs - Array of IDE codes that were installed
  * @param {Object} options.logger - Logger instance for output
  * @returns {Promise<boolean>} - Success status

package/src/core/{_module-installer/install-config.yaml → module.yaml}

@@ -23,7 +23,11 @@ document_output_language:
   default: "{communication_language}"
   result: "{value}"
 
-  # This is the folder where all generated AI Output documents from workflows will default be sa
+agent_sidecar_folder:
+  prompt: "Where should users agent sidecar memory folders be stored?"
+  default: ".bmad-user-memory"
+  result: "{project-root}/{value}"
+
 output_folder:
   prompt: "Where should AI Generated Artifacts be saved across all modules?"
   default: "docs"

package/src/core/resources/excalidraw/library-loader.md

@@ -4,7 +4,7 @@
 
 ## Purpose
 
-Load external .excalidrawlib files from https://libraries.excalidraw.com or custom sources.
+Load external .excalidrawlib files from <https://libraries.excalidraw.com> or custom sources.
 
 ## Planned Capabilities
 
@@ -34,7 +34,7 @@ libraries:
 
 ## Implementation Notes
 
-This will be developed when agents need to leverage the extensive library ecosystem available at https://libraries.excalidraw.com.
+This will be developed when agents need to leverage the extensive library ecosystem available at <https://libraries.excalidraw.com>.
 
 Hundreds of pre-built component libraries exist for:
 

package/src/core/workflows/brainstorming/steps/step-01-session-setup.md

@@ -135,7 +135,7 @@ _[Content based on conversation about session parameters and facilitator approac
 
 When user selects approach, append the session overview content directly to `{output_folder}/analysis/brainstorming-session-{{date}}.md` using the structure from above.
 
-#### E. Continue to Technique Selection
+### E. Continue to Technique Selection
 
 "**Session setup complete!** I have a clear understanding of your goals and can select the perfect techniques for your brainstorming needs.
 

package/src/core/workflows/brainstorming/workflow.md

@@ -1,5 +1,5 @@
 ---
-name: Brainstorming Session
+name: brainstorming-session
 description: Facilitate interactive brainstorming sessions using diverse creative techniques and ideation methods
 context_file: '' # Optional context file path for project-specific guidance
 ---

package/src/core/workflows/party-mode/steps/step-03-graceful-exit.md

@@ -95,7 +95,6 @@ stepsCompleted: [1, 2, 3]
 workflowType: 'party-mode'
 user_name: '{{user_name}}'
 date: '{{date}}'
-current_year: '{{current_year}}'
 agents_loaded: true
 party_active: false
 workflow_completed: true

package/src/core/workflows/party-mode/workflow.md

@@ -1,5 +1,5 @@
 ---
-name: Party Mode
+name: party-mode
 description: Orchestrates group discussions between all installed BMAD agents, enabling natural multi-agent conversations
 ---
 
@@ -31,7 +31,7 @@ Load config from `{project-root}/{bmad_folder}/bmm/config.yaml` and resolve:
 
 - `project_name`, `output_folder`, `user_name`
 - `communication_language`, `document_output_language`, `user_skill_level`
-- `date`, `current_year`, `current_month` as system-generated values
+- `date` as a system-generated value
 - Agent manifest path: `{project-root}/{bmad_folder}/_cfg/agent-manifest.csv`
 
 ### Paths
@@ -118,7 +118,6 @@ stepsCompleted: [1]
 workflowType: 'party-mode'
 user_name: '{{user_name}}'
 date: '{{date}}'
-current_year: '{{current_year}}'
 agents_loaded: true
 party_active: true
 exit_triggers: ['*exit', 'goodbye', 'end party', 'quit']

package/src/modules/bmb/README.md

@@ -58,7 +58,7 @@ Specialized tools and workflows for creating, customizing, and extending BMad co
 
 - **[Workflow Index](./docs/workflows/index.md)** - Core workflow system overview
 - **[Architecture Guide](./docs/workflows/architecture.md)** - Step-file design and JIT loading
-- **[Template System](./docs/workflows/step-template.md)** - Standard step file template
+- **[Template System](./docs/workflows/templates/step-template.md)** - Standard step file template
 - **[Intent vs Prescriptive](./docs/workflows/intent-vs-prescriptive-spectrum.md)** - Design philosophy
 
 ## Reference Materials

package/src/modules/bmb/_module-installer/installer.js

@@ -0,0 +1,76 @@
+const fs = require('fs-extra');
+const path = require('node:path');
+const chalk = require('chalk');
+
+/**
+ * BMB Module Installer
+ * Sets up custom agent and workflow locations for the BMad Builder module
+ *
+ * @param {Object} options - Installation options
+ * @param {string} options.projectRoot - The root directory of the target project
+ * @param {Object} options.config - Module configuration from module.yaml
+ * @param {Object} options.coreConfig - Core configuration containing user_name
+ * @param {Array<string>} options.installedIDEs - Array of IDE codes that were installed
+ * @param {Object} options.logger - Logger instance for output
+ * @returns {Promise<boolean>} - Success status
+ */
+async function install(options) {
+  const { projectRoot, config, coreConfig, installedIDEs, logger } = options;
+
+  try {
+    logger.log(chalk.blue('🔧 Setting up BMB Module...'));
+
+    // Generate custom.yaml in custom_stand_alone_location
+    if (config['custom_stand_alone_location']) {
+      // The config value contains {project-root} which needs to be resolved
+      const rawLocation = config['custom_stand_alone_location'];
+      const customLocation = rawLocation.replace('{project-root}', projectRoot);
+      const customDestPath = path.join(customLocation, 'custom.yaml');
+
+      logger.log(chalk.cyan(`  Setting up custom agents at: ${customLocation}`));
+
+      // Ensure the directory exists
+      await fs.ensureDir(customLocation);
+
+      // Generate the custom.yaml content
+      const userName = (coreConfig && coreConfig.user_name) || 'my';
+      const customContent = `code: my-custom-bmad
+name: "${userName}-Custom-BMad: Sample Stand Alone Custom Agents and Workflows"
+default_selected: true
+`;
+
+      // Write the custom.yaml file (only if it doesn't exist to preserve user changes)
+      if (await fs.pathExists(customDestPath)) {
+        logger.log(chalk.yellow(`    ✓ custom.yaml already exists at ${customDestPath}`));
+      } else {
+        await fs.writeFile(customDestPath, customContent, 'utf8');
+        logger.log(chalk.green(`    ✓ Created custom.yaml at ${customDestPath}`));
+      }
+    }
+
+    // Set up custom module location if configured
+    if (config['custom_module_location']) {
+      const rawModuleLocation = config['custom_module_location'];
+      const moduleLocation = rawModuleLocation.replace('{project-root}', projectRoot);
+
+      logger.log(chalk.cyan(`  Setting up custom modules at: ${moduleLocation}`));
+
+      // Ensure the directory exists
+      await fs.ensureDir(moduleLocation);
+      logger.log(chalk.green(`    ✓ Created modules directory at ${moduleLocation}`));
+    }
+
+    // Handle IDE-specific configurations if needed
+    if (installedIDEs && installedIDEs.length > 0) {
+      logger.log(chalk.cyan(`  Configuring BMB for IDEs: ${installedIDEs.join(', ')}`));
+    }
+
+    logger.log(chalk.green('✓ BMB Module setup complete'));
+    return true;
+  } catch (error) {
+    logger.error(chalk.red(`Error setting up BMB module: ${error.message}`));
+    return false;
+  }
+}
+
+module.exports = { install };

package/src/modules/bmb/agents/bmad-builder.agent.yaml

@@ -29,22 +29,25 @@ agent:
     - modules: "{project-root}/{bmad_folder}/bmb/docs/modules/kb.csv"
 
   menu:
-    - multi: "[CA] Create, [EA] Edit, or [VA] Validate BMAD agents with best practices"
+    - multi: "[CA] Create, [EA] Edit, or [VA] Validate with Compliance CheckBMAD agents with best practices"
       triggers:
         - create-agent:
             - input: CA or fuzzy match create agent
             - route: "{project-root}/{bmad_folder}/bmb/workflows/create-agent/workflow.md"
             - data: null
+            - type: exec
         - edit-agent:
             - input: EA or fuzzy match edit agent
             - route: "{project-root}/{bmad_folder}/bmb/workflows/edit-agent/workflow.md"
             - data: null
+            - type: exec
         - run-agent-compliance-check:
             - input: VA or fuzzy match validate agent
             - route: "{project-root}/{bmad_folder}/bmb/workflows/agent-compliance-check/workflow.md"
             - data: null
+            - type: exec
 
-    - multi: "[CW] Create, [EW] Edit, or [VW] Validate BMAD workflows with best practices"
+    - multi: "[CW] Create, [EW] Edit, or [VW] Validate with Compliance CheckBMAD workflows with best practices"
       triggers:
         - create-workflow:
             - input: CW or fuzzy match create workflow
@@ -62,10 +65,30 @@ agent:
             - data: null
             - type: exec
 
-    - trigger: create-module
-      workflow: "{project-root}/{bmad_folder}/bmb/workflows/create-module/workflow.yaml"
-      description: Create a complete BMAD compatible module (custom agents and workflows)
-
-    - trigger: edit-module
-      workflow: "{project-root}/{bmad_folder}/bmb/workflows/edit-module/workflow.yaml"
-      description: Edit existing modules (structure, agents, workflows, documentation)
+    - multi: "[BM] Brainstorm, [PBM] Product Brief, [CM] Create, [EM] Edit or [VM] Validate with Compliance Check BMAD modules with best practices"
+      triggers:
+        - brainstorm-module:
+            - input: BM or fuzzy match brainstorm module
+            - route: "{project-root}/{bmad_folder}/bmb/workflows/brainstorm-module/workflow.md"
+            - data: null
+            - type: exec
+        - product-brief-module:
+            - input: PBM or fuzzy match product brief module
+            - route: "{project-root}/{bmad_folder}/bmb/workflows/product-brief-module/workflow.md"
+            - data: null
+            - type: exec
+        - create-module:
+            - input: CM or fuzzy match create module
+            - route: "{project-root}/{bmad_folder}/bmb/workflows/create-module/workflow.md"
+            - data: null
+            - type: exec
+        - edit-module:
+            - input: EM or fuzzy match edit module
+            - route: "{project-root}/{bmad_folder}/bmb/workflows/edit-module/workflow.md"
+            - data: null
+            - type: exec
+        - run-module-compliance-check:
+            - input: VM or fuzzy match validate module
+            - route: "{project-root}/{bmad_folder}/bmb/workflows/module-compliance-check/workflow.md"
+            - data: null
+            - type: exec

package/src/modules/bmb/docs/agents/agent-menu-patterns.md

@@ -375,7 +375,7 @@ exec: "../../../core/tasks/validate.xml"
 
 - `{project-root}` - Project root directory
 - `{bmad_folder}` - BMAD installation folder
-- `{agent-folder}` - Agent installation directory (Expert agents)
+- `{agent_sidecar_folder}` - Agent installation directory (Expert agents)
 - `{output_folder}` - Document output location
 - `{user_name}` - User's name from config
 - `{communication_language}` - Language preference
@@ -415,9 +415,9 @@ menu:
 
 ```yaml
 critical_actions:
-  - 'Load {agent-folder}/memories.md'
-  - 'Follow {agent-folder}/instructions.md'
-  - 'ONLY access {agent-folder}/'
+  - 'Load ./memories.md'
+  - 'Follow ./instructions.md'
+  - 'ONLY access ./'
 
 prompts:
   - id: reflect
@@ -431,7 +431,7 @@ menu:
     description: 'Write journal entry'
 
   - trigger: save
-    action: 'Update {agent-folder}/memories.md with session insights'
+    action: 'Update ./memories.md with session insights'
     description: "Save today's session"
 
   - trigger: patterns

package/src/modules/bmb/docs/agents/expert-agent-architecture.md

@@ -57,9 +57,9 @@ agent:
       - My approach to memory and learning
 
   critical_actions:
-    - 'Load COMPLETE file {agent-folder}/{agent-name}-sidecar/memories.md and remember all past insights'
-    - 'Load COMPLETE file {agent-folder}/{agent-name}-sidecar/instructions.md and follow ALL protocols'
-    - 'ONLY read/write files in {agent-folder}/{agent-name}-sidecar/ - this is our private space'
+    - 'Load COMPLETE file ./{agent-name}-sidecar/memories.md and remember all past insights'
+    - 'Load COMPLETE file ./{agent-name}-sidecar/instructions.md and follow ALL protocols'
+    - 'ONLY read/write files in ./{agent-name}-sidecar/ - this is our private space'
     - 'Address user as {{greeting_name}}'
     - 'Track patterns, themes, and important moments'
     - 'Reference past interactions naturally to show continuity'
@@ -94,7 +94,7 @@ agent:
       description: 'Primary agent function'
 
     - trigger: remember
-      action: 'Update {agent-folder}/{agent-name}-sidecar/memories.md with session insights'
+      action: 'Update ./{agent-name}-sidecar/memories.md with session insights'
       description: 'Save what we discussed today'
 
     - trigger: patterns
@@ -102,7 +102,7 @@ agent:
       description: 'Recall patterns from past interactions'
 
     - trigger: insight
-      action: 'Document breakthrough in {agent-folder}/{agent-name}-sidecar/breakthroughs.md'
+      action: 'Document breakthrough in ./{agent-name}-sidecar/breakthroughs.md'
       description: 'Record a significant insight'
 
   install_config:
@@ -184,9 +184,9 @@ Add domain-specific documentation here.
 
 ```yaml
 critical_actions:
-  - 'Load COMPLETE file {agent-folder}/{sidecar}/memories.md and remember all past insights'
-  - 'Load COMPLETE file {agent-folder}/{sidecar}/instructions.md and follow ALL protocols'
-  - 'ONLY read/write files in {agent-folder}/{sidecar}/ - this is our private space'
+  - 'Load COMPLETE file ./{sidecar}/memories.md and remember all past insights'
+  - 'Load COMPLETE file ./{sidecar}/instructions.md and follow ALL protocols'
+  - 'ONLY read/write files in ./{sidecar}/ - this is our private space'
 ```
 
 **Key patterns:**
@@ -196,7 +196,7 @@ critical_actions:
 - **Memory integration** - Past context becomes part of current session
 - **Protocol adherence** - Ensures consistent behavior
 
-### {agent-folder} Variable
+### {agent_sidecar_folder} Variable
 
 Special variable resolved during installation:
 
@@ -211,9 +211,9 @@ Same as simple agents, PLUS:
 1. **Critical actions become numbered activation steps**
 
    ```xml
-   <step n="4">Load COMPLETE file {agent-folder}/memories.md...</step>
-   <step n="5">Load COMPLETE file {agent-folder}/instructions.md...</step>
-   <step n="6">ONLY read/write files in {agent-folder}/...</step>
+   <step n="4">Load COMPLETE file ./memories.md...</step>
+   <step n="5">Load COMPLETE file ./instructions.md...</step>
+   <step n="6">ONLY read/write files in ./...</step>
    ```
 
 2. **Sidecar files copied during installation**
@@ -260,7 +260,7 @@ The installer:
 ```yaml
 menu:
   - trigger: save
-    action: "Update {agent-folder}/sidecar/memories.md with today's session insights"
+    action: "Update ./sidecar/memories.md with today's session insights"
     description: 'Save session to memory'
 ```
 
@@ -281,7 +281,7 @@ prompts:
 ```yaml
 menu:
   - trigger: insight
-    action: 'Document in {agent-folder}/sidecar/breakthroughs.md with date, context, significance'
+    action: 'Document in ./sidecar/breakthroughs.md with date, context, significance'
     description: 'Record meaningful insight'
 ```
 
@@ -291,7 +291,7 @@ menu:
 
 ```yaml
 critical_actions:
-  - 'ONLY read/write files in {agent-folder}/sidecar/ - NO OTHER FOLDERS'
+  - 'ONLY read/write files in ./sidecar/ - NO OTHER FOLDERS'
 ```
 
 ### User Space Access
@@ -305,15 +305,15 @@ critical_actions:
 
 ```yaml
 critical_actions:
-  - 'Load knowledge from {agent-folder}/knowledge/ but NEVER modify'
-  - 'Write ONLY to {agent-folder}/sessions/'
+  - 'Load knowledge from ./knowledge/ but NEVER modify'
+  - 'Write ONLY to ./sessions/'
 ```
 
 ## Best Practices
 
 1. **Load sidecar files in critical_actions** - Must be explicit and MANDATORY
 2. **Enforce domain restrictions** - Clear boundaries prevent scope creep
-3. **Use {agent-folder} paths** - Portable across installations
+3. **Use {agent_sidecar_folder} paths** - Portable across installations
 4. **Design for memory growth** - Structure sidecar files for accumulation
 5. **Reference past naturally** - Don't dump memory, weave it into conversation
 6. **Separate concerns** - Memories, instructions, knowledge in distinct files
@@ -356,8 +356,8 @@ identity: |
 - [ ] Sidecar folder structure created and populated
 - [ ] memories.md has clear section structure
 - [ ] instructions.md contains core directives
-- [ ] Menu actions reference {agent-folder} correctly
-- [ ] File paths use {agent-folder} variable
+- [ ] Menu actions reference {agent_sidecar_folder} correctly
+- [ ] File paths use {agent_sidecar_folder} variable
 - [ ] Install config personalizes sidecar references
 - [ ] Agent folder named consistently: `{agent-name}/`
 - [ ] YAML file named: `{agent-name}.agent.yaml`

package/src/modules/bmb/docs/agents/index.md

@@ -37,7 +37,7 @@ Production-ready examples in `/src/modules/bmb/reference/agents/`:
 
 For installing standalone simple and expert agents, see:
 
-- [Custom Agent Installation](/docs/custom-agent-installation.md)
+- [Custom Agent Installation](/docs/custom-content-installation.md)
 
 ## Key Concepts