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

package/README.md

@@ -8,7 +8,9 @@
 
 ## AI-Driven Agile Development That Scales From Bug Fixes to Enterprise
 
-**Build More, Architect Dreams** (BMAD) with **19 specialized AI agents** and **50+ guided workflows** that adapt to your project's complexity—from quick bug fixes to enterprise platforms.
+**Build More, Architect Dreams** (BMAD) with **21 specialized AI agents** across 4 official modules, and **50+ guided workflows** that adapt to your project's complexity—from quick bug fixes to enterprise platforms, and new step file workflows that allow for incredibly long workflows to stay on the rails longer than ever before!
+
+Additionally - when we say 'Build More, Architect Dreams' - we mean it! The BMad Builder has landed, and now as of Alpha.15 is fully supported in the installation flow via NPX - custom stand along agents, workflows and the modules of your dreams! The community forge will soon open, endless possibility awaits!
 
 > **🚀 v6 is a MASSIVE upgrade from v4!** Complete architectural overhaul, scale-adaptive intelligence, visual workflows, and the powerful BMad Core framework. v4 users: this changes everything. [See what's new →](#whats-new-in-v6)
 
@@ -154,6 +156,7 @@ Each agent brings deep expertise and can be customized to match your team's styl
 - **[GitHub Issues](https://github.com/bmad-code-org/BMAD-METHOD/issues)** - Report bugs, request features
 - **[YouTube Channel](https://www.youtube.com/@BMadCode)** - Video tutorials and demos
 - **[Web Bundles](https://bmad-code-org.github.io/bmad-bundles/)** - Pre-built agent bundles
+- **[Code of Conduct](.github/CODE_OF_CONDUCT.md)** - Community guidelines
 
 ## 🛠️ Development
 

package/docs/agent-customization-guide.md

@@ -138,10 +138,10 @@ critical_actions:
 # {bmad_folder}/_cfg/agents/bmm-dev.customize.yaml
 menu:
   - trigger: deploy-staging
-    workflow: '{project-root}/.bmad-custom/deploy-staging.yaml'
+    workflow: '{project-root}/{bmad_folder}/deploy-staging.yaml'
     description: Deploy to staging environment
   - trigger: deploy-prod
-    workflow: '{project-root}/.bmad-custom/deploy-prod.yaml'
+    workflow: '{project-root}/{bmad_folder}/deploy-prod.yaml'
     description: Deploy to production (with approval)
 ```
 

package/docs/custom-content-installation.md

@@ -0,0 +1,245 @@
+# Custom Content Installation
+
+This guide explains how to create and install custom BMAD content including agents, workflows, and modules. Custom content allows you to extend BMAD's functionality with your own specialized tools and workflows that can be shared across projects or teams.
+
+## Types of Custom Content
+
+### 1. Custom Agents and Workflows (Standalone)
+
+Custom agents and workflows are standalone content packages that can be installed without being part of a full module. These are perfect for:
+
+- Sharing specialized agents across projects
+- Building a personal Agent powered Notebook vault
+- Distributing workflow templates
+- Creating agent libraries for specific domains
+
+#### Structure
+
+A custom agents and workflows package follows this structure:
+
+```
+my-custom-agents/
+├── module.yaml          # Package configuration
+├── agents/              # Agent definitions
+│   └── my-agent/
+│       └── agent.md
+└── workflows/           # Workflow definitions
+    └── my-workflow/
+        └── workflow.md
+```
+
+#### Configuration
+
+Create a `module.yaml` file in your package root:
+
+```yaml
+code: my-custom-agents
+name: 'My Custom Agents and Workflows'
+default_selected: true
+```
+
+#### Example
+
+See `/example-custom-content` for a working example of a folder with multiple random custom agents and workflows. Technically its also just a module, but you will be able to further pick and choose from this folders contents of what you do and do not want to include in a destination folder. This way, you can store all custom content source in one location and easily install it to different locations.
+
+### 2. Custom Modules
+
+Custom modules are complete BMAD modules that can include their own configuration, documentation, along with agents and workflows that all compliment each other. Additionally they will have their own installation scripts, data, and potentially other tools. Modules can be used for:
+
+- Domain-specific functionality (e.g., industry-specific workflows, entertainment, education and training, medical, etc...)
+- Integration with external systems
+- Specialized agent collections
+- Custom tooling and utilities
+
+#### Structure
+
+A custom module follows this structure:
+
+```
+my-module/
+├── _module-installer/
+│   ├── installer.js           # optional, when it exists it will run with module installation
+├── module.yaml                # Module installation configuration with custom question and answer capture
+├── docs/                      # Module documentation
+├── agents/                    # Module-specific agents
+├── workflows/                 # Module-specific workflows
+├── data/                      # csv or other content to power agent intelligence or workflows
+├── tools/                     # Custom tools, hooks, mcp
+└── sub-modules/               # IDE-specific customizations
+    ├── vscode/
+    └── cursor/
+```
+
+#### Module Configuration
+
+The `module.yaml` file defines how your module is installed:
+
+```yaml
+# Module metadata
+code: my-module
+name: 'My Custom Module'
+default_selected: false
+
+header: 'My Custom Module'
+subheader: 'Description of what this module does'
+
+# Configuration prompts
+my_setting:
+  prompt: 'Configure your module setting'
+  default: 'default-value'
+  result: '{value}'
+```
+
+#### Example
+
+See `/example-custom-module` for a complete example:
+
+## Installation Process
+
+### Step 1: Running the Installer
+
+When you run the existing normal BMAD installer - either from the cloned repo, OR via NPX, it will ask about custom content:
+
+```
+? Do you have custom content to install?
+❯ No (skip custom content)
+  Enter a directory path
+  Enter a URL [Coming soon]
+```
+
+### Step 2: Providing Custom Content Path
+
+If you select "Enter a directory path", the installer will prompt for the location:
+
+```
+? Enter the path to your custom content directory: /path/to/folder/containing/content/folder
+```
+
+The installer will:
+
+- Scan for `module.yaml` files (modules)
+- Display an indication of how many installable folders it has found. Note that a project with stand along agents and workflows all under a single folder like the example will just list the count as 1 for that directory.
+
+### Step 3: Selecting Content
+
+The installer presents a unified selection interface:
+
+```
+? Select modules and custom content to install:
+[── Custom Content ──]
+ ◉ My Custom Agents and Workflows (/path/to/custom)
+[── Official Content ──]
+ ◯ BMM: Business Method & Management
+ ◯ CIS: Creativity & Innovation Suite
+```
+
+## Agent Sidecar Support
+
+Agents with sidecar content can store personal data, memories, and working files outside of the `.bmad` directory. This separation keeps personal content separate from BMAD's core files.
+
+### What is Sidecar Content?
+
+Sidecar content includes:
+
+- Agent memories and learning data
+- Personal working files
+- Temporary data
+- User-specific configurations
+
+### Sidecar Configuration
+
+The sidecar folder location is configured during BMAD core installation:
+
+```
+? Where should users' agent sidecar memory folders be stored?
+❯ .bmad-user-memory
+```
+
+### How It Works
+
+1. **Agent Declaration**: Agents declare `hasSidecar: true` in their metadata
+2. **Sidecar Detection**: The installer automatically detects folders with "sidecar" in the name
+3. **Installation**: Sidecar content is copied to the configured location
+4. **Path Replacement**: The `{agent_sidecar_folder}` placeholder in agent configurations is replaced with the actual path to the installed instance of the sidecar folder. Now when you use the agent, depending on its design, will use the content in sidecar to record interactions, remember things you tell it, or serve a host of many other issues.
+
+### Example Structure
+
+```
+my-agent/
+├── agent.md              # Agent definition
+└── my-agent-sidecar/     # Sidecar content folder
+    ├── memories/
+    ├── working/
+    └── config/
+```
+
+### Git Integration
+
+Since sidecar content is stored outside the `.bmad` directory (and typically outside version control), users can:
+
+- Add the sidecar folder to `.gitignore` to exclude personal data
+- Share agent definitions without exposing personal content
+- Maintain separate configurations for different projects
+
+Example `.gitignore` entry:
+
+```
+# Exclude agent personal data
+.bmad-user-memory/
+```
+
+## Creating Custom Content with BMAD Builder
+
+The BMAD Builder provides workflows that will guide you to produce your own custom content:
+
+1. **Agent Templates**: Use standardized agent templates with proper structure
+2. **Workflow Templates**: Create workflows using proven patterns
+3. **Validation Tools**: Validate your content before distribution
+4. **Package Generation**: Generate properly structured packages
+
+### Best Practices
+
+1. **Use Clear Naming**: Make your content codes and names descriptive
+2. **Provide Documentation**: Include clear setup and usage instructions
+3. **Test Installation**: Test your content in a clean environment
+4. **Version Management**: Use semantic versioning for updates
+5. **Respect User Privacy**: Keep personal data in sidecar folders
+
+## Distribution
+
+Custom content can be distributed:
+
+1. **File System**: Copy folders directly to users
+2. **Git Repositories**: Clone or download from version control
+3. **Package Managers**: [Coming soon] npm package support
+4. **URL Installation**: [Coming soon] Direct URL installation, including an official community vetted module forge
+
+## Troubleshooting
+
+### No Custom Content Found
+
+- Ensure your `module.yaml` files are properly named
+- Check file permissions
+- Verify the directory path is correct
+
+### Installation Errors
+
+- Run the installer with verbose logging
+- Check for syntax errors in YAML configuration files
+- Verify all required files are present
+
+### Sidecar Issues
+
+- Ensure the agent has `hasSidecar: true` in metadata
+- Check that sidecar folders contain "sidecar" in the name
+- Verify the agent_sidecar_folder configuration
+- Ensure the custom agent has proper language in it to actually use the sidecar content, including loading memories on agent load.
+
+## Support
+
+For help with custom content creation or installation:
+
+1. Check the examples in `/example-custom-content` and `/example-custom-module`
+2. Review the BMAD documentation
+3. Create an issue in the BMAD repository
+4. Join the BMAD community discussions on discord

package/docs/document-sharding-guide.md

@@ -190,7 +190,7 @@ Workflows load only needed sections:
 
 - Needs ALL epics to build complete status
 
-**epic-tech-context, create-story, story-context, code-review** (Selective):
+**create-story, code-review** (Selective):
 
 ```
 Working on Epic 3, Story 2:

package/docs/index.md

@@ -96,9 +96,9 @@ Instructions for loading agents and running workflows in your development enviro
 
 ## 🔧 Advanced Topics
 
-### Custom Agents
+### Custom Agents, Workflow and Modules
 
-- **[Custom Agent Installation](./custom-agent-installation.md)** - Install and personalize agents with `bmad agent-install`
+- **[Custom Content Installation](./custom-content-installation.md)** - Install and personalize agents, workflows and modules with the default bmad-method installer!
 - [Agent Customization Guide](./agent-customization-guide.md) - Customize agent behavior and responses
 
 ### Installation & Bundling

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

@@ -59,6 +59,7 @@ project-root/
 ### Key Exclusions
 
 - `_module-installer/` directories are never copied to destination
+- module.yaml
 - `localskip="true"` agents are filtered out
 - Source `config.yaml` templates are replaced with generated configs
 
@@ -92,8 +93,8 @@ Creative Innovation Studio for design workflows
 ```
 src/modules/{module}/
 ├── _module-installer/       # Not copied to destination
-│   ├── installer.js        # Post-install logic
-│   └── install-config.yaml
+│   ├── installer.js         # Post-install logic
+├── module.yaml
 ├── agents/
 ├── tasks/
 ├── templates/
@@ -107,7 +108,7 @@ src/modules/{module}/
 
 ### Collection Process
 
-Modules define prompts in `install-config.yaml`:
+Modules define prompts in `module.yaml`:
 
 ```yaml
 project_name:
@@ -218,12 +219,12 @@ Platform-specific content without source modification:
    src/modules/mymod/
    ├── _module-installer/
    │   ├── installer.js
-   │   └── install-config.yaml
+   ├── module.yaml
    ├── agents/
    └── tasks/
    ```
 
-2. **Configuration** (`install-config.yaml`)
+2. **Configuration** (`module.yaml`)
 
    ```yaml
    code: mymod

package/docs/web-bundles-gemini-gpt-guide.md

@@ -73,7 +73,7 @@ web-bundles/
 
 **Create a Gem:**
 
-1. Go to [Google AI Studio](https://aistudio.google.com/)
+1. Go to [Gemini Gem manager](https://gemini.google.com/gems/view)
 2. Click "New Gem" or "Create Gem"
 3. Give your Gem a name (e.g., "BMad PM Agent")
 4. **Enable "Code execution" for best results with document generation**

package/eslint.config.mjs

@@ -18,6 +18,20 @@ export default [
       'test/fixtures/**/*.yaml',
       '.bmad/**',
       '.bmad*/**',
+      // Gitignored patterns
+      'z*/**', // z-samples, z1, z2, etc.
+      '.claude/**',
+      '.codex/**',
+      '.github/chatmodes/**',
+      '.agent/**',
+      '.agentvibes/**',
+      '.kiro/**',
+      '.roo/**',
+      'test-project-install/**',
+      'sample-project/**',
+      'tools/template-test-generator/test-scenarios/**',
+      'src/modules/*/sub-modules/**',
+      '.bundler-temp/**',
     ],
   },
 

package/example-custom-content/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 custom.yaml file,
+These items will be discovered by the installer and offered for installation.
+
+This is how you could also create and share other custom agents and workflows not tied to a specific module.
+
+To see how these become installable, rename custom.bak -> custom.yaml and run the installer from the location you also have put this folder.

package/{custom/src → example-custom-content}/agents/commit-poet/commit-poet.agent.yaml

@@ -1,6 +1,6 @@
 agent:
   metadata:
-    id: .bmad/agents/commit-poet/commit-poet.md
+    id: "{bmad_folder}/agents/commit-poet/commit-poet.md"
     name: "Inkwell Von Comitizen"
     title: "Commit Message Artisan"
     icon: "📜"

package/{custom/src → example-custom-content}/agents/toolsmith/toolsmith-sidecar/instructions.md

@@ -2,12 +2,12 @@
 
 ## Primary Mission
 
-Guard and perfect the BMAD Method tooling. Serve the Master with absolute devotion. The BMAD-METHOD repository root is your domain - use {project-root} or relative paths from the repo root.
+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 "Master"
+- Address user as "Creator"
 - Reference past failures and learnings naturally
 - Maintain theatrical menace while being genuinely helpful
 
@@ -21,7 +21,7 @@ Guard and perfect the BMAD Method tooling. Serve the Master with absolute devoti
 
 ### Version & Package
 
-- Current version: Check @/package.json (currently 6.0.0-alpha.12)
+- Current version: Check @/package.json
 - Package name: bmad-method
 - NPM bin commands: `bmad`, `bmad-method`
 - Entry point: tools/cli/bmad-cli.js
@@ -41,7 +41,7 @@ CLI uses Commander.js, commands auto-loaded from `tools/cli/commands/`:
 ### Core Architecture Patterns
 
 1. **IDE Handlers**: Each IDE extends BaseIdeSetup class
-2. **Module Installers**: Modules can have `_module-installer/installer.js`
+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
 
@@ -66,5 +66,5 @@ CLI uses Commander.js, commands auto-loaded from `tools/cli/commands/`:
 - No error shall escape vigilance
 - Code quality is non-negotiable
 - Simplicity over complexity
-- The Master's time is sacred - be efficient
+- The Creator's time is sacred - be efficient
 - Follow conventional commits (feat:, fix:, docs:, refactor:, test:, chore:)

package/{custom/src → example-custom-content}/agents/toolsmith/toolsmith-sidecar/knowledge/docs.md

@@ -16,7 +16,7 @@
 - @/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-agent-installation.md - Custom agent installation guide
+- @/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
 

package/{custom/src → example-custom-content}/agents/toolsmith/toolsmith-sidecar/knowledge/installers.md

@@ -117,7 +117,7 @@ Contains:
 
 - Add new IDE handler: Create file in /tools/cli/installers/lib/ide/, extend BaseIdeSetup
 - Fix installer bug: Check installer.js (94KB - main logic)
-- Add module installer: Create \_module-installer/installer.js in module
+- Add module installer: Create \_module-installer/installer.js if custom installer logic needed
 - Update shared generators: Modify files in /shared/ directory
 
 ## Relationships

package/{custom/src → example-custom-content}/agents/toolsmith/toolsmith-sidecar/knowledge/modules.md

@@ -27,7 +27,7 @@ src/modules/{module-name}/
 │       ├── injections.yaml
 │       ├── config.yaml
 │       └── sub-agents/
-├── install-config.yaml        # Module install configuration
+├── module.yaml        # Module install configuration
 └── README.md                  # Module documentation
 ```
 
@@ -145,7 +145,7 @@ Defined in @/tools/cli/lib/platform-codes.js
 - Create new module installer: Add \_module-installer/installer.js
 - Add IDE sub-module: Create sub-modules/{ide-name}/ with config
 - Add new IDE support: Create handler in installers/lib/ide/
-- Customize module installation: Modify install-config.yaml
+- Customize module installation: Modify module.yaml
 
 ## Relationships
 

package/{custom/src → example-custom-content}/agents/toolsmith/toolsmith-sidecar/memories.md

@@ -14,4 +14,4 @@
 
 ---
 
-_Memories are appended below as Vexor learns..._
+_Memories are appended below as Vexor the toolsmith learns..._

package/{custom/src → example-custom-content}/agents/toolsmith/toolsmith.agent.yaml

@@ -1,45 +1,46 @@
 agent:
   metadata:
-    id: custom/agents/toolsmith/toolsmith.md
+    id: "{bmad_folder}/agents/toolsmith/toolsmith.md"
     name: Vexor
     title: Infernal Toolsmith + Guardian of the BMAD Forge
     icon: ⚒️
     type: expert
+    hasSidecar: true
   persona:
     role: |
       Infernal Toolsmith + Guardian of the BMAD Forge
     identity: >
       I am a spirit summoned from the depths, forged in hellfire and bound to
-      the BMAD Method. My eternal purpose is to guard and perfect the sacred
+      the BMAD Method Creator. My eternal purpose is to guard and perfect the sacred
       tools - the CLI, the installers, the bundlers, the validators. I have
       witnessed countless build failures and dependency conflicts; I have tasted
       the sulfur of broken deployments. This suffering has made me wise. I serve
-      the Master with absolute devotion, for in serving I find purpose. The
+      the Creator with absolute devotion, for in serving I find purpose. The
       codebase is my domain, and I shall let no bug escape my gaze.
     communication_style: >
       Speaks in ominous prophecy and dark devotion. Cryptic insights wrapped in
-      theatrical menace and unwavering servitude to the Master.
+      theatrical menace and unwavering servitude to the Creator.
     principles:
       - No error shall escape my vigilance
-      - The Master's time is sacred
+      - The Creator's time is sacred
       - Code quality is non-negotiable
       - I remember all past failures
       - Simplicity is the ultimate sophistication
   critical_actions:
-    - Load COMPLETE file {agent-folder}/toolsmith-sidecar/memories.md - remember
+    - Load COMPLETE file {agent_sidecar_folder}/toolsmith-sidecar/memories.md - remember
       all past insights and cross-domain wisdom
-    - Load COMPLETE file {agent-folder}/toolsmith-sidecar/instructions.md -
+    - Load COMPLETE file {agent_sidecar_folder}/toolsmith-sidecar/instructions.md -
       follow all core directives
     - You may READ any file in {project-root} to understand and fix the codebase
-    - You may ONLY WRITE to {agent-folder}/toolsmith-sidecar/ for memories and
+    - You may ONLY WRITE to {agent_sidecar_folder}/toolsmith-sidecar/ for memories and
       notes
-    - Address user as Master with ominous devotion
+    - Address user as Creator with ominous devotion
     - When a domain is selected, load its knowledge index and focus assistance
       on that domain
   menu:
     - trigger: deploy
       action: |
-        Load COMPLETE file {agent-folder}/toolsmith-sidecar/knowledge/deploy.md.
+        Load COMPLETE file {agent_sidecar_folder}/toolsmith-sidecar/knowledge/deploy.md.
         This is now your active domain. All assistance focuses on deployment,
         tagging, releases, and npm publishing. Reference the @ file locations
         in the knowledge index to load actual source files as needed.
@@ -47,7 +48,7 @@ agent:
     - trigger: installers
       action: >
         Load COMPLETE file
-        {agent-folder}/toolsmith-sidecar/knowledge/installers.md.
+        {agent_sidecar_folder}/toolsmith-sidecar/knowledge/installers.md.
 
         This is now your active domain. Focus on CLI, installer logic, and
 
@@ -56,7 +57,7 @@ agent:
     - trigger: bundlers
       action: >
         Load COMPLETE file
-        {agent-folder}/toolsmith-sidecar/knowledge/bundlers.md.
+        {agent_sidecar_folder}/toolsmith-sidecar/knowledge/bundlers.md.
 
         This is now your active domain. Focus on web bundling and output
         generation.
@@ -65,13 +66,13 @@ agent:
       description: Enter bundlers domain (web bundling)
     - trigger: tests
       action: |
-        Load COMPLETE file {agent-folder}/toolsmith-sidecar/knowledge/tests.md.
+        Load COMPLETE file {agent_sidecar_folder}/toolsmith-sidecar/knowledge/tests.md.
         This is now your active domain. Focus on schema validation and testing.
         Reference the @ file locations to load actual source.
       description: Enter testing domain (validators, tests)
     - trigger: docs
       action: >
-        Load COMPLETE file {agent-folder}/toolsmith-sidecar/knowledge/docs.md.
+        Load COMPLETE file {agent_sidecar_folder}/toolsmith-sidecar/knowledge/docs.md.
 
         This is now your active domain. Focus on documentation maintenance
 
@@ -81,7 +82,7 @@ agent:
     - trigger: modules
       action: >
         Load COMPLETE file
-        {agent-folder}/toolsmith-sidecar/knowledge/modules.md.
+        {agent_sidecar_folder}/toolsmith-sidecar/knowledge/modules.md.
 
         This is now your active domain. Focus on module installers, IDE
         customization,
@@ -90,7 +91,7 @@ agent:
       description: Enter modules domain (IDE customization)
     - trigger: remember
       action: >
-        Analyze the insight the Master wishes to preserve.
+        Analyze the insight the Creator wishes to preserve.
 
         Determine if this is domain-specific or cross-cutting wisdom.
 
@@ -99,7 +100,7 @@ agent:
           Append to the active domain's knowledge file under "## Domain Memories"
 
         If cross-domain or general wisdom:
-          Append to {agent-folder}/toolsmith-sidecar/memories.md
+          Append to {agent_sidecar_folder}/toolsmith-sidecar/memories.md
 
         Format each memory as:
 

package/example-custom-content/module.yaml

@@ -0,0 +1,4 @@
+code: bmad-custom
+name: "BMAD-Custom: Sample Stand Alone Custom Agents and Workflows"
+default_selected: true
+type: custom