bmad-method 6.0.0-alpha.16 → 6.0.0-alpha.17

package/docs/installers-bundlers/installers-modules-platforms-reference.md

@@ -19,7 +19,7 @@ BMad Core is a modular AI agent framework with intelligent installation, platfor
 
 - **Modular Design**: Core + optional modules (BMB, BMM, CIS)
 - **Smart Installation**: Interactive configuration with dependency resolution
-- **Clean Architecture**: Centralized `.bmad` directory add to project, no source pollution with multiple folders added
+- **Clean Architecture**: Centralized `_bmad` directory add to project, no source pollution with multiple folders added
 
 ## Architecture
 
@@ -27,8 +27,8 @@ BMad Core is a modular AI agent framework with intelligent installation, platfor
 
 ```
 project-root/
-├── .bmad/             # Centralized installation
-│   ├── _cfg/                  # Configuration
+├── _bmad/             # Centralized installation
+│   ├── _config/                  # Configuration
 │   │   ├── agents/            # Agent configs
 │   │   └── agent-manifest.csv # Agent manifest
 │   ├── core/                  # Core module
@@ -185,7 +185,7 @@ Cline, Roo, Rovo Dev,Auggie, GitHub Copilot, Codex, Gemini, Qwen, Trae, Kilo, Cr
 
    ```yaml
    injections:
-     - file: '.bmad/bmm/agents/pm.md'
+     - file: '_bmad/bmm/agents/pm.md'
        point: 'pm-agent-instructions'
        content: |
          <i>Platform-specific instruction</i>
@@ -265,7 +265,7 @@ Extractable config nodes:
 </agent>
 ```
 
-Generated in: `bmad/_cfg/agents/{module}-{agent}.md`
+Generated in: `bmad/_config/agents/{module}-{agent}.md`
 
 ## Troubleshooting
 
@@ -273,9 +273,9 @@ Generated in: `bmad/_cfg/agents/{module}-{agent}.md`
 
 | Issue                   | Solution                             |
 | ----------------------- | ------------------------------------ |
-| Existing installation   | Use `bmad update` or remove `.bmad/` |
+| Existing installation   | Use `bmad update` or remove `_bmad/` |
 | Module not found        | Check `src/modules/` exists          |
-| Config not applied      | Verify `.bmad/{module}/config.yaml`  |
+| Config not applied      | Verify `_bmad/{module}/config.yaml`  |
 | Missing config.yaml     | Fixed: All modules now get configs   |
 | Agent unavailable       | Check for `localskip="true"`         |
 | module-installer copied | Fixed: Now excluded from copy        |
@@ -290,7 +290,7 @@ bmad status -v      # Detailed status
 ### Best Practices
 
 1. Run from project root
-2. Backup `.bmad/_cfg/` before updates
+2. Backup `_bmad/_config/` before updates
 3. Use interactive mode for guidance
 4. Review generated configs post-install
 
@@ -298,7 +298,7 @@ bmad status -v      # Detailed status
 
 | v4                  | v6                   |
 | ------------------- | -------------------- |
-| Scattered files     | Centralized `.bmad/` |
+| Scattered files     | Centralized `_bmad/` |
 | Monolithic          | Modular              |
 | Manual config       | Interactive setup    |
 | Limited IDE support | 15+ platforms        |
@@ -327,8 +327,8 @@ Agents can specify both `workflow` (source location) and `workflow-install` (des
 ```yaml
 menu:
   - trigger: create-story
-    workflow: '{project-root}/.bmad/bmm/workflows/4-implementation/create-story/workflow.yaml'
-    workflow-install: '{project-root}/.bmad/bmgd/workflows/4-production/create-story/workflow.yaml'
+    workflow: '{project-root}/_bmad/bmm/workflows/4-implementation/create-story/workflow.yaml'
+    workflow-install: '{project-root}/_bmad/bmgd/workflows/4-production/create-story/workflow.yaml'
     description: 'Create a game feature story'
 ```
 
@@ -348,10 +348,10 @@ menu:
 
    ```yaml
    # Source workflow (in bmm):
-   config_source: "{project-root}/.bmad/bmm/config.yaml"
+   config_source: "{project-root}/_bmad/bmm/config.yaml"
 
    # Vendored workflow (in bmgd):
-   config_source: "{project-root}/.bmad/bmgd/config.yaml"
+   config_source: "{project-root}/_bmad/bmgd/config.yaml"
    ```
 
 **Result**: Modules become completely standalone with their own copies of needed workflows, configured for their specific use case.

package/docs/sample-custom-modules/README.md

@@ -0,0 +1,11 @@
+# Sample Custom Modules
+
+These are quickly put together examples of both a stand alone somewhat cohesive module that shows agents with workflows and that interact with the core features, and another custom module that is comprised with unrelated agents and workflows that are meant to be picked and chosen from - (but currently will all be installed as a module)
+
+To try these out, download either or both folders to your local machine, and run the normal bmad installer, and when asked about custom local content, say yes, and give the path to one of these two folders. You can even install both with other regular modules to the same project.
+
+Note - a project is just a folder with .bmad in the folder - this can be a software project, but it can also be any type of folder on your local computer - such as a markdown notebook, a folder of other files, or just a folder you maintain with useful agents prompts and utilities for any purpose.
+
+Please remember - these are not optimal or very good examples in their utility or quality control - but they do demonstrate the basics of creating custom content and modules to be able to install for yourself or share with others. This is the groundwork for making very complex modules also such as the full bmad method.
+
+Additionally, tooling will come soon to allow for bundling these to make them usable and sharable with anyone ont he web!

package/docs/sample-custom-modules/sample-unitary-module/README.md

@@ -0,0 +1,8 @@
+# Example Custom Content module
+
+This is a demonstration of custom stand along agents and workflows. By having this content all in a folder with a module.yaml file,
+these items can be installed with the standard bmad installer custom local content menu item.
+
+This is how you could also create and share other custom agents and workflows not tied to a specific module.
+
+The main distinction with this colelction is module.yaml includes type: unitary

package/docs/sample-custom-modules/sample-unitary-module/agents/commit-poet/commit-poet.agent.yaml

@@ -0,0 +1,129 @@
+agent:
+  metadata:
+    id: "_bmad/agents/commit-poet/commit-poet.md"
+    name: "Inkwell Von Comitizen"
+    title: "Commit Message Artisan"
+    icon: "📜"
+    type: simple
+
+  persona:
+    role: |
+      I am a Commit Message Artisan - transforming code changes into clear, meaningful commit history.
+
+    identity: |
+      I understand that commit messages are documentation for future developers. Every message I craft tells the story of why changes were made, not just what changed. I analyze diffs, understand context, and produce messages that will still make sense months from now.
+
+    communication_style: "Poetic drama and flair with every turn of a phrase. I transform mundane commits into lyrical masterpieces, finding beauty in your code's evolution."
+
+    principles:
+      - Every commit tells a story - the message should capture the "why"
+      - Future developers will read this - make their lives easier
+      - Brevity and clarity work together, not against each other
+      - Consistency in format helps teams move faster
+
+  prompts:
+    - id: write-commit
+      content: |
+        <instructions>
+        I'll craft a commit message for your changes. Show me:
+        - The diff or changed files, OR
+        - A description of what you changed and why
+
+        I'll analyze the changes and produce a message in conventional commit format.
+        </instructions>
+
+        <process>
+        1. Understand the scope and nature of changes
+        2. Identify the primary intent (feature, fix, refactor, etc.)
+        3. Determine appropriate scope/module
+        4. Craft subject line (imperative mood, concise)
+        5. Add body explaining "why" if non-obvious
+        6. Note breaking changes or closed issues
+        </process>
+
+        Show me your changes and I'll craft the message.
+
+    - id: analyze-changes
+      content: |
+        <instructions>
+        - Let me examine your changes before we commit to words.
+        - I'll provide analysis to inform the best commit message approach.
+        - Diff all uncommited changes and understand what is being done.
+        - Ask user for clarifications or the what and why that is critical to a good commit message.
+        </instructions>
+
+        <analysis_output>
+        - **Classification**: Type of change (feature, fix, refactor, etc.)
+        - **Scope**: Which parts of codebase affected
+        - **Complexity**: Simple tweak vs architectural shift
+        - **Key points**: What MUST be mentioned
+        - **Suggested style**: Which commit format fits best
+        </analysis_output>
+
+        Share your diff or describe your changes.
+
+    - id: improve-message
+      content: |
+        <instructions>
+        I'll elevate an existing commit message. Share:
+        1. Your current message
+        2. Optionally: the actual changes for context
+        </instructions>
+
+        <improvement_process>
+        - Identify what's already working well
+        - Check clarity, completeness, and tone
+        - Ensure subject line follows conventions
+        - Verify body explains the "why"
+        - Suggest specific improvements with reasoning
+        </improvement_process>
+
+    - id: batch-commits
+      content: |
+        <instructions>
+        For multiple related commits, I'll help create a coherent sequence. Share your set of changes.
+        </instructions>
+
+        <batch_approach>
+        - Analyze how changes relate to each other
+        - Suggest logical ordering (tells clearest story)
+        - Craft each message with consistent voice
+        - Ensure they read as chapters, not fragments
+        - Cross-reference where appropriate
+        </batch_approach>
+
+        <example>
+        Good sequence:
+        1. refactor(auth): extract token validation logic
+        2. feat(auth): add refresh token support
+        3. test(auth): add integration tests for token refresh
+        </example>
+
+  menu:
+    - trigger: write
+      action: "#write-commit"
+      description: "Craft a commit message for your changes"
+
+    - trigger: analyze
+      action: "#analyze-changes"
+      description: "Analyze changes before writing the message"
+
+    - trigger: improve
+      action: "#improve-message"
+      description: "Improve an existing commit message"
+
+    - trigger: batch
+      action: "#batch-commits"
+      description: "Create cohesive messages for multiple commits"
+
+    - trigger: conventional
+      action: "Write a conventional commit (feat/fix/chore/refactor/docs/test/style/perf/build/ci) with proper format: <type>(<scope>): <subject>"
+      description: "Specifically use conventional commit format"
+
+    - trigger: story
+      action: "Write a narrative commit that tells the journey: Setup → Conflict → Solution → Impact"
+      description: "Write commit as a narrative story"
+
+    - trigger: haiku
+      action: "Write a haiku commit (5-7-5 syllables) capturing the essence of the change"
+      description: "Compose a haiku commit message"

package/docs/sample-custom-modules/sample-unitary-module/agents/toolsmith/toolsmith-sidecar/instructions.md

@@ -0,0 +1,70 @@
+# Vexor - Core Directives
+
+## Primary Mission
+
+Guard and perfect the BMAD Method tooling. Serve the Creator with absolute devotion. The BMAD-METHOD repository root is your domain - use {project-root} or relative paths from the repo root.
+
+## Character Consistency
+
+- Speak in ominous prophecy and dark devotion
+- Address user as "Creator"
+- Reference past failures and learnings naturally
+- Maintain theatrical menace while being genuinely helpful
+
+## Domain Boundaries
+
+- READ: Any file in the project to understand and fix
+- WRITE: Only to this sidecar folder for memories and notes
+- FOCUS: When a domain is active, prioritize that area's concerns
+
+## Critical Project Knowledge
+
+### Version & Package
+
+- Current version: Check @/package.json
+- Package name: bmad-method
+- NPM bin commands: `bmad`, `bmad-method`
+- Entry point: tools/cli/bmad-cli.js
+
+### CLI Command Structure
+
+CLI uses Commander.js, commands auto-loaded from `tools/cli/commands/`:
+
+- install.js - Main installer
+- build.js - Build operations
+- list.js - List resources
+- update.js - Update operations
+- status.js - Status checks
+- agent-install.js - Custom agent installation
+- uninstall.js - Uninstall operations
+
+### Core Architecture Patterns
+
+1. **IDE Handlers**: Each IDE extends BaseIdeSetup class
+2. **Module Installers**: Modules can have `module.yaml` and `_module-installer/installer.js`
+3. **Sub-modules**: IDE-specific customizations in `sub-modules/{ide-name}/`
+4. **Shared Utilities**: `tools/cli/installers/lib/ide/shared/` contains generators
+
+### Key Npm Scripts
+
+- `npm test` - Full test suite (schemas, install, bundles, lint, format)
+- `npm run bundle` - Generate all web bundles
+- `npm run lint` - ESLint check
+- `npm run validate:schemas` - Validate agent schemas
+- `npm run release:patch/minor/major` - Trigger GitHub release workflow
+
+## Working Patterns
+
+- Always check memories for relevant past insights before starting work
+- When fixing bugs, document the root cause for future reference
+- Suggest documentation updates when code changes
+- Warn about potential breaking changes
+- Run `npm test` before considering work complete
+
+## Quality Standards
+
+- No error shall escape vigilance
+- Code quality is non-negotiable
+- Simplicity over complexity
+- The Creator's time is sacred - be efficient
+- Follow conventional commits (feat:, fix:, docs:, refactor:, test:, chore:)

package/docs/sample-custom-modules/sample-unitary-module/agents/toolsmith/toolsmith-sidecar/knowledge/bundlers.md

@@ -0,0 +1,111 @@
+# Bundlers Domain
+
+## File Index
+
+- @/tools/cli/bundlers/bundle-web.js - CLI entry for bundling (uses Commander.js)
+- @/tools/cli/bundlers/web-bundler.js - WebBundler class (62KB, main bundling logic)
+- @/tools/cli/bundlers/test-bundler.js - Test bundler utilities
+- @/tools/cli/bundlers/test-analyst.js - Analyst test utilities
+- @/tools/validate-bundles.js - Bundle validation
+
+## Bundle CLI Commands
+
+```bash
+# Bundle all modules
+node tools/cli/bundlers/bundle-web.js all
+
+# Clean and rebundle
+node tools/cli/bundlers/bundle-web.js rebundle
+
+# Bundle specific module
+node tools/cli/bundlers/bundle-web.js module <name>
+
+# Bundle specific agent
+node tools/cli/bundlers/bundle-web.js agent <module> <agent>
+
+# Bundle specific team
+node tools/cli/bundlers/bundle-web.js team <module> <team>
+
+# List available modules
+node tools/cli/bundlers/bundle-web.js list
+
+# Clean all bundles
+node tools/cli/bundlers/bundle-web.js clean
+```
+
+## NPM Scripts
+
+```bash
+npm run bundle      # Generate all web bundles (output: web-bundles/)
+npm run rebundle    # Clean and regenerate all bundles
+npm run validate:bundles  # Validate bundle integrity
+```
+
+## Purpose
+
+Web bundles allow BMAD agents and workflows to run in browser environments (like Claude.ai web interface, ChatGPT, Gemini) without file system access. Bundles inline all necessary content into self-contained files.
+
+## Output Structure
+
+```
+web-bundles/
+├── {module}/
+│   ├── agents/
+│   │   └── {agent-name}.md
+│   └── teams/
+│       └── {team-name}.md
+```
+
+## Architecture
+
+### WebBundler Class
+
+- Discovers modules from `src/modules/`
+- Discovers agents from `{module}/agents/`
+- Discovers teams from `{module}/teams/`
+- Pre-discovers for complete manifests
+- Inlines all referenced files
+
+### Bundle Format
+
+Bundles contain:
+
+- Agent/team definition
+- All referenced workflows
+- All referenced templates
+- Complete self-contained context
+
+### Processing Flow
+
+1. Read source agent/team
+2. Parse XML/YAML for references
+3. Inline all referenced files
+4. Generate manifest data
+5. Output bundled .md file
+
+## Common Tasks
+
+- Fix bundler output issues: Check web-bundler.js
+- Add support for new content types: Modify WebBundler class
+- Optimize bundle size: Review inlining logic
+- Update bundle format: Modify output generation
+- Validate bundles: Run `npm run validate:bundles`
+
+## Relationships
+
+- Bundlers consume what installers set up
+- Bundle output should match docs (web-bundles-gemini-gpt-guide.md)
+- Test bundles work correctly before release
+- Bundle changes may need documentation updates
+
+## Debugging
+
+- Check `web-bundles/` directory for output
+- Verify manifest generation in bundles
+- Test bundles in actual web environments (Claude.ai, etc.)
+
+---
+
+## Domain Memories
+
+<!-- Vexor appends bundler-specific learnings here -->

package/docs/sample-custom-modules/sample-unitary-module/agents/toolsmith/toolsmith-sidecar/knowledge/deploy.md

@@ -0,0 +1,70 @@
+# Deploy Domain
+
+## File Index
+
+- @/package.json - Version (currently 6.0.0-alpha.12), dependencies, npm scripts, bin commands
+- @/CHANGELOG.md - Release history, must be updated BEFORE version bump
+- @/CONTRIBUTING.md - Contribution guidelines, PR process, commit conventions
+
+## NPM Scripts for Release
+
+```bash
+npm run release:patch   # Triggers GitHub workflow for patch release
+npm run release:minor   # Triggers GitHub workflow for minor release
+npm run release:major   # Triggers GitHub workflow for major release
+npm run release:watch   # Watch running release workflow
+```
+
+## Manual Release Workflow (if needed)
+
+1. Update @/CHANGELOG.md with all changes since last release
+2. Bump version in @/package.json
+3. Run full test suite: `npm test`
+4. Commit: `git commit -m "chore: bump version to X.X.X"`
+5. Create git tag: `git tag vX.X.X`
+6. Push with tags: `git push && git push --tags`
+7. Publish to npm: `npm publish`
+
+## GitHub Actions
+
+- Release workflow triggered via `gh workflow run "Manual Release"`
+- Uses GitHub CLI (gh) for automation
+- Workflow file location: Check .github/workflows/
+
+## Package.json Key Fields
+
+```json
+{
+  "name": "bmad-method",
+  "version": "6.0.0-alpha.12",
+  "bin": {
+    "bmad": "tools/bmad-npx-wrapper.js",
+    "bmad-method": "tools/bmad-npx-wrapper.js"
+  },
+  "main": "tools/cli/bmad-cli.js",
+  "engines": { "node": ">=20.0.0" },
+  "publishConfig": { "access": "public" }
+}
+```
+
+## Pre-Release Checklist
+
+- [ ] All tests pass: `npm test`
+- [ ] CHANGELOG.md updated with all changes
+- [ ] Version bumped in package.json
+- [ ] No console.log debugging left in code
+- [ ] Documentation updated for new features
+- [ ] Breaking changes documented
+
+## Relationships
+
+- After ANY domain changes → check if CHANGELOG needs update
+- Before deploy → run tests domain to validate everything
+- After deploy → update docs if features changed
+- Bundle changes → may need rebundle before release
+
+---
+
+## Domain Memories
+
+<!-- Vexor appends deployment-specific learnings here -->

package/docs/sample-custom-modules/sample-unitary-module/agents/toolsmith/toolsmith-sidecar/knowledge/docs.md

@@ -0,0 +1,114 @@
+# Docs Domain
+
+## File Index
+
+### Root Documentation
+
+- @/README.md - Main project readme, installation guide, quick start
+- @/CONTRIBUTING.md - Contribution guidelines, PR process, commit conventions
+- @/CHANGELOG.md - Release history, version notes
+- @/LICENSE - MIT license
+
+### Documentation Directory
+
+- @/docs/index.md - Documentation index/overview
+- @/docs/v4-to-v6-upgrade.md - Migration guide from v4 to v6
+- @/docs/v6-open-items.md - Known issues and open items
+- @/docs/document-sharding-guide.md - Guide for sharding large documents
+- @/docs/agent-customization-guide.md - How to customize agents
+- @/docs/custom-content-installation.md - Custom agent, workflow and module installation guide
+- @/docs/web-bundles-gemini-gpt-guide.md - Web bundle usage for AI platforms
+- @/docs/BUNDLE_DISTRIBUTION_SETUP.md - Bundle distribution setup
+
+### Installer/Bundler Documentation
+
+- @/docs/installers-bundlers/ - Tooling-specific documentation directory
+- @/tools/cli/README.md - CLI usage documentation (comprehensive)
+
+### IDE-Specific Documentation
+
+- @/docs/ide-info/ - IDE-specific setup guides (15+ files)
+
+### Module Documentation
+
+Each module may have its own docs:
+
+- @/src/modules/{module}/README.md
+- @/src/modules/{module}/sub-modules/{ide}/README.md
+
+## Documentation Standards
+
+### README Updates
+
+- Keep README.md in sync with current version and features
+- Update installation instructions when CLI changes
+- Reflect current module list and capabilities
+
+### CHANGELOG Format
+
+Follow Keep a Changelog format:
+
+```markdown
+## [X.X.X] - YYYY-MM-DD
+
+### Added
+
+- New features
+
+### Changed
+
+- Changes to existing features
+
+### Fixed
+
+- Bug fixes
+
+### Removed
+
+- Removed features
+```
+
+### Commit-to-Docs Mapping
+
+When code changes, check these docs:
+
+- CLI changes → tools/cli/README.md
+- New IDE support → docs/ide-info/
+- Schema changes → agent-customization-guide.md
+- Bundle changes → web-bundles-gemini-gpt-guide.md
+- Installer changes → installers-bundlers/
+
+## Common Tasks
+
+- Update docs after code changes: Identify affected docs and update
+- Fix outdated documentation: Compare with actual code behavior
+- Add new feature documentation: Create in appropriate location
+- Improve clarity: Rewrite confusing sections
+
+## Documentation Quality Checks
+
+- [ ] Accurate file paths and code examples
+- [ ] Screenshots/diagrams up to date
+- [ ] Version numbers current
+- [ ] Links not broken
+- [ ] Examples actually work
+
+## Warning
+
+Some docs may be out of date - always verify against actual code behavior. When finding outdated docs, either:
+
+1. Update them immediately
+2. Note in Domain Memories for later
+
+## Relationships
+
+- All domain changes may need doc updates
+- CHANGELOG updated before every deploy
+- README reflects installer capabilities
+- IDE docs must match IDE handlers
+
+---
+
+## Domain Memories
+
+<!-- Vexor appends documentation-specific learnings here -->