Merge branch 'main' into fix/workflow-manifest-schema

This commit is contained in:
Dicky Moore 2025-12-11 15:10:21 +00:00 committed by GitHub
commit 01863fe23c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
394 changed files with 1587 additions and 4761 deletions

View File

@ -6,7 +6,7 @@ reviews:
profile: chill
high_level_summary: true
request_changes_workflow: false
review_status: true
review_status: false
collapse_walkthrough: false
poem: false
auto_review:

View File

@ -1,5 +1,36 @@
# Changelog
## [6.0.0-alpha.16]
**Release: December 10, 2025**
### 🔧 Temporary Changes & Fixes
**Installation Improvements:**
- **Temporary Custom Content Installation Disable**: Custom content installation temporarily disabled to improve stability
- **BMB Workflow Path Fixes**: Fixed numerous path references in BMB workflows to ensure proper step file resolution
- **Package Updates**: Updated dependencies for improved security and performance
**Path Resolution Improvements:**
- **BMB Agent Builder Fixes**: Corrected path references in step files and documentation
- **Workflow Path Standardization**: Ensured consistent path handling across all BMB workflows
- **Documentation References**: Updated internal documentation links and references
**Cleanup Changes:**
- **Example Modules Removal**: Temporarily removed example modules to prevent accidental installation
- **Hardcoded Path Cleanup**: Continued removal of hardcoded `.bmad` folder references from demo content
- **Memory Management**: Improved sidecar file handling for custom modules
### 📊 Statistics
- **336 files changed** with path fixes and improvements
- **4 commits** since alpha.15
---
## [6.0.0-alpha.15]
**Release: December 7, 2025**
@ -145,7 +176,7 @@
- Fixed version reading from package.json instead of hardcoded fallback
- Removed hardcoded years from WebSearch queries
- Removed broken build caching mechanism
- Fixed hardcoded 'bmad' prefix from files-manifest.csv paths
- Fixed hardcoded '.bmad' prefix from files-manifest.csv paths
- Enhanced TTS injection summary with tracking and documentation
- Fixed CI nvmrc configuration issues

View File

@ -9,7 +9,7 @@ Customize BMad agents without modifying core files. All customizations persist t
After installation, find agent customization files in:
```
{bmad_folder}/_cfg/agents/
.bmad/_cfg/agents/
├── core-bmad-master.customize.yaml
├── bmm-dev.customize.yaml
├── bmm-pm.customize.yaml
@ -119,7 +119,7 @@ prompts:
**Example 1: Customize Developer Agent for TDD**
```yaml
# {bmad_folder}/_cfg/agents/bmm-dev.customize.yaml
# .bmad/_cfg/agents/bmm-dev.customize.yaml
agent:
metadata:
name: 'TDD Developer'
@ -135,20 +135,20 @@ critical_actions:
**Example 2: Add Custom Deployment Workflow**
```yaml
# {bmad_folder}/_cfg/agents/bmm-dev.customize.yaml
# .bmad/_cfg/agents/bmm-dev.customize.yaml
menu:
- trigger: deploy-staging
workflow: '{project-root}/{bmad_folder}/deploy-staging.yaml'
workflow: '{project-root}/.bmad/deploy-staging.yaml'
description: Deploy to staging environment
- trigger: deploy-prod
workflow: '{project-root}/{bmad_folder}/deploy-prod.yaml'
workflow: '{project-root}/.bmad/deploy-prod.yaml'
description: Deploy to production (with approval)
```
**Example 3: Multilingual Product Manager**
```yaml
# {bmad_folder}/_cfg/agents/bmm-pm.customize.yaml
# .bmad/_cfg/agents/bmm-pm.customize.yaml
persona:
role: 'Bilingual Product Manager'
identity: 'Expert in US and LATAM markets'
@ -174,7 +174,7 @@ memories:
**Module-Level (Recommended):**
- Customize agents per-project in `{bmad_folder}/_cfg/agents/`
- Customize agents per-project in `.bmad/_cfg/agents/`
- Different projects can have different agent behaviors
**Global Config (Coming Soon):**

View File

@ -7,7 +7,7 @@ BMAD agents are installed as commands in `.crush/commands/bmad/`.
### How to Use
1. **Open Command Palette**: Use Crush command interface
2. **Navigate**: Browse to `{bmad_folder}/{module}/agents/`
2. **Navigate**: Browse to `.bmad/{module}/agents/`
3. **Select Agent**: Choose the agent command
4. **Execute**: Run to activate agent persona

View File

@ -6,20 +6,20 @@ BMAD agents are installed in `.cursor/rules/bmad/` as MDC rules.
### How to Use
1. **Reference in Chat**: Use `@{bmad_folder}/{module}/agents/{agent-name}`
2. **Include Entire Module**: Use `@{bmad_folder}/{module}`
3. **Reference Index**: Use `@{bmad_folder}/index` for all available agents
1. **Reference in Chat**: Use `@.bmad/{module}/agents/{agent-name}`
2. **Include Entire Module**: Use `@.bmad/{module}`
3. **Reference Index**: Use `@.bmad/index` for all available agents
### Examples
```
@{bmad_folder}/core/agents/dev - Activate dev agent
@{bmad_folder}/bmm/agents/architect - Activate architect agent
@{bmad_folder}/core - Include all core agents/tasks
@.bmad/core/agents/dev - Activate dev agent
@.bmad/bmm/agents/architect - Activate architect agent
@.bmad/core - Include all core agents/tasks
```
### Notes
- Rules are Manual type - only loaded when explicitly referenced
- No automatic context pollution
- Can combine multiple agents: `@{bmad_folder}/core/agents/dev @{bmad_folder}/core/agents/test`
- Can combine multiple agents: `@.bmad/core/agents/dev @.bmad/core/agents/test`

View File

@ -7,7 +7,7 @@ BMAD agents are installed as commands in `.iflow/commands/bmad/`.
### How to Use
1. **Access Commands**: Use iFlow command interface
2. **Navigate**: Browse to `{bmad_folder}/agents/` or `{bmad_folder}/tasks/`
2. **Navigate**: Browse to `.bmad/agents/` or `.bmad/tasks/`
3. **Select**: Choose the agent or task command
4. **Execute**: Run to activate
@ -22,8 +22,8 @@ BMAD agents are installed as commands in `.iflow/commands/bmad/`.
### Examples
```
/{bmad_folder}/agents/core-dev - Activate dev agent
/{bmad_folder}/tasks/core-setup - Execute setup task
/.bmad/agents/core-dev - Activate dev agent
/.bmad/tasks/core-setup - Execute setup task
```
### Notes

View File

@ -14,7 +14,7 @@ BMAD agents are installed as OpenCode agents in `.opencode/agent/BMAD/{module_na
```
/agents - to see a list of agents and switch between them
/{bmad_folder}/bmm/workflows/workflow-init - Activate the workflow-init command
/.bmad/bmm/workflows/workflow-init - Activate the workflow-init command
```
### Notes

View File

@ -158,7 +158,7 @@ src/modules/bmm/
```yaml
injections:
- file: '{bmad_folder}/bmm/agents/pm.md'
- file: '.bmad/bmm/agents/pm.md'
point: 'pm-agent-instructions'
requires: 'any' # Injected if ANY subagent is selected
content: |
@ -166,7 +166,7 @@ injections:
<i>Use 'market-researcher' subagent for analysis</i>
</llm>
- file: '{bmad_folder}/bmm/templates/prd.md'
- file: '.bmad/bmm/templates/prd.md'
point: 'prd-goals-context-delegation'
requires: 'market-researcher' # Only if this specific subagent selected
content: |

View File

@ -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_folder}` 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,7 +27,7 @@ BMad Core is a modular AI agent framework with intelligent installation, platfor
```
project-root/
├── {bmad_folder}/ # Centralized installation
├── .bmad/ # Centralized installation
│ ├── _cfg/ # Configuration
│ │ ├── agents/ # Agent configs
│ │ └── agent-manifest.csv # Agent manifest
@ -185,7 +185,7 @@ Cline, Roo, Rovo Dev,Auggie, GitHub Copilot, Codex, Gemini, Qwen, Trae, Kilo, Cr
```yaml
injections:
- file: '{bmad_folder}/bmm/agents/pm.md'
- file: '.bmad/bmm/agents/pm.md'
point: 'pm-agent-instructions'
content: |
<i>Platform-specific instruction</i>
@ -271,14 +271,14 @@ Generated in: `bmad/_cfg/agents/{module}-{agent}.md`
### Common Issues
| Issue | Solution |
| ----------------------- | -------------------------------------------- |
| Existing installation | Use `bmad update` or remove `{bmad_folder}/` |
| Module not found | Check `src/modules/` exists |
| Config not applied | Verify `{bmad_folder}/{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 |
| Issue | Solution |
| ----------------------- | ------------------------------------ |
| Existing installation | Use `bmad update` or remove `.bmad/` |
| Module not found | Check `src/modules/` exists |
| 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 |
### Debug Commands
@ -290,19 +290,19 @@ bmad status -v # Detailed status
### Best Practices
1. Run from project root
2. Backup `{bmad_folder}/_cfg/` before updates
2. Backup `.bmad/_cfg/` before updates
3. Use interactive mode for guidance
4. Review generated configs post-install
## Migration from v4
| v4 | v6 |
| ------------------- | ---------------------------- |
| Scattered files | Centralized `{bmad_folder}/` |
| Monolithic | Modular |
| Manual config | Interactive setup |
| Limited IDE support | 15+ platforms |
| Source modification | Clean injection |
| v4 | v6 |
| ------------------- | -------------------- |
| Scattered files | Centralized `.bmad/` |
| Monolithic | Modular |
| Manual config | Interactive setup |
| Limited IDE support | 15+ platforms |
| Source modification | Clean injection |
## Technical Notes
@ -327,8 +327,8 @@ Agents can specify both `workflow` (source location) and `workflow-install` (des
```yaml
menu:
- trigger: create-story
workflow: '{project-root}/{bmad_folder}/bmm/workflows/4-implementation/create-story/workflow.yaml'
workflow-install: '{project-root}/{bmad_folder}/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_folder}/bmm/config.yaml"
config_source: "{project-root}/.bmad/bmm/config.yaml"
# Vendored workflow (in bmgd):
config_source: "{project-root}/{bmad_folder}/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.

View File

@ -63,7 +63,7 @@ your-project/
```
your-project/
└── {bmad_folder}/ # Single installation folder, default .bmad
└── .bmad/ # Single installation folder, default .bmad
├── core/ # Real core framework (applies to all modules)
├── bmm/ # BMad Method (software/game dev)
├── bmb/ # BMad Builder (create agents/workflows)
@ -75,8 +75,8 @@ your-project/
### Key Concept Changes
- **v4 `.bmad-core`**: Was actually the BMad Method
- **v6 `{bmad_folder}/core/`**: Is the real universal core framework
- **v6 `{bmad_folder}/bmm/`**: Is the BMad Method module
- **v6 `.bmad/core/`**: Is the real universal core framework
- **v6 `.bmad/bmm/`**: Is the BMad Method module
- **Module identification**: All modules now have a `config.yaml` file
---
@ -114,11 +114,11 @@ In v4, you may have modified agent files directly in `.bmad-*` folders.
### v6 Agent Customization
**All customizations** now go in `{bmad_folder}/_cfg/agents/` using customize files:
**All customizations** now go in `.bmad/_cfg/agents/` using customize files:
**Example: Renaming an agent and changing communication style**
File: `{bmad_folder}/_cfg/agents/bmm-pm.customize.yaml`
File: `.bmad/_cfg/agents/bmm-pm.customize.yaml`
```yaml
# Customize the PM agent
@ -133,8 +133,8 @@ persona:
**How it works:**
- Base agent: `{bmad_folder}/bmm/agents/pm.md`
- Customization: `{bmad_folder}/_cfg/agents/bmm-pm.customize.yaml`
- Base agent: `.bmad/bmm/agents/pm.md`
- Customization: `.bmad/_cfg/agents/bmm-pm.customize.yaml`
- Result: Agent uses your custom name and style, but updates don't overwrite your changes
---
@ -212,9 +212,9 @@ Since you are migrating an existing project from v4, it's most likely **Level 3
## Post-Migration Checklist
- [ ] v4 folders backed up to `v4-backup/`
- [ ] v6 installed to `{bmad_folder}/` folder
- [ ] v6 installed to `.bmad/` folder
- [ ] `workflow-init` run with correct project level selected
- [ ] Agent customizations migrated to `{bmad_folder}/_cfg/agents/` if needed
- [ ] Agent customizations migrated to `.bmad/_cfg/agents/` if needed
- [ ] IDE integration working (test by listing agents)
- [ ] For active development: `sprint-planning` workflow executed
@ -224,4 +224,4 @@ Since you are migrating an existing project from v4, it's most likely **Level 3
- **Discord**: [Join the BMad Community](https://discord.gg/gk8jAdXWmj)
- **Issues**: [GitHub Issue Tracker](https://github.com/bmad-code-org/BMAD-METHOD/issues)
- **Docs**: Check `{bmad_folder}/docs/` in your installation for IDE-specific instructions
- **Docs**: Check `.bmad/docs/` in your installation for IDE-specific instructions

View File

@ -336,7 +336,7 @@ Agents adapt their menus based on project phase and available workflows.
Customize agents using the [Agent Customization Guide](./agent-customization-guide.md):
1. Edit `{bmad_folder}/_cfg/agents/<agent>.customize.yaml`
1. Edit `.bmad/_cfg/agents/<agent>.customize.yaml`
2. Rebuild: `npx bmad-method build <agent-name>`
3. Generate bundles: `npm run bundle`

View File

@ -1,8 +0,0 @@
# 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.

View File

@ -1,129 +0,0 @@
agent:
metadata:
id: "{bmad_folder}/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"

View File

@ -1,70 +0,0 @@
# 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:)

View File

@ -1,111 +0,0 @@
# 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 -->

View File

@ -1,70 +0,0 @@
# 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 -->

View File

@ -1,114 +0,0 @@
# 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 -->

View File

@ -1,134 +0,0 @@
# Installers Domain
## File Index
### Core CLI
- @/tools/cli/bmad-cli.js - Main CLI entry (uses Commander.js, auto-loads commands)
- @/tools/cli/README.md - CLI documentation
### Commands Directory
- @/tools/cli/commands/install.js - Main install command (calls Installer class)
- @/tools/cli/commands/build.js - Build operations
- @/tools/cli/commands/list.js - List resources
- @/tools/cli/commands/update.js - Update operations
- @/tools/cli/commands/status.js - Status checks
- @/tools/cli/commands/agent-install.js - Custom agent installation
- @/tools/cli/commands/uninstall.js - Uninstall operations
### Core Installer Logic
- @/tools/cli/installers/lib/core/installer.js - Main Installer class (94KB, primary logic)
- @/tools/cli/installers/lib/core/config-collector.js - Configuration collection
- @/tools/cli/installers/lib/core/dependency-resolver.js - Dependency resolution
- @/tools/cli/installers/lib/core/detector.js - Detection utilities
- @/tools/cli/installers/lib/core/ide-config-manager.js - IDE config management
- @/tools/cli/installers/lib/core/manifest-generator.js - Manifest generation
- @/tools/cli/installers/lib/core/manifest.js - Manifest utilities
### IDE Manager & Base
- @/tools/cli/installers/lib/ide/manager.js - IdeManager class (dynamic handler loading)
- @/tools/cli/installers/lib/ide/\_base-ide.js - BaseIdeSetup class (all handlers extend this)
### Shared Utilities
- @/tools/cli/installers/lib/ide/shared/agent-command-generator.js
- @/tools/cli/installers/lib/ide/shared/workflow-command-generator.js
- @/tools/cli/installers/lib/ide/shared/task-tool-command-generator.js
- @/tools/cli/installers/lib/ide/shared/module-injections.js
- @/tools/cli/installers/lib/ide/shared/bmad-artifacts.js
### CLI Library Files
- @/tools/cli/lib/ui.js - User interface prompts
- @/tools/cli/lib/config.js - Configuration utilities
- @/tools/cli/lib/project-root.js - Project root detection
- @/tools/cli/lib/platform-codes.js - Platform code definitions
- @/tools/cli/lib/xml-handler.js - XML processing
- @/tools/cli/lib/yaml-format.js - YAML formatting
- @/tools/cli/lib/file-ops.js - File operations
- @/tools/cli/lib/agent/compiler.js - Agent YAML to XML compilation
- @/tools/cli/lib/agent/installer.js - Agent installation
- @/tools/cli/lib/agent/template-engine.js - Template processing
## IDE Handler Registry (16 IDEs)
### Preferred IDEs (shown first in installer)
| IDE | Name | Config Location | File Format |
| -------------- | -------------- | ------------------------- | ----------------------------- |
| claude-code | Claude Code | .claude/commands/ | .md with frontmatter |
| codex | Codex | (varies) | .md |
| cursor | Cursor | .cursor/rules/bmad/ | .mdc with MDC frontmatter |
| github-copilot | GitHub Copilot | .github/ | .md |
| opencode | OpenCode | .opencode/ | .md |
| windsurf | Windsurf | .windsurf/workflows/bmad/ | .md with workflow frontmatter |
### Other IDEs
| IDE | Name | Config Location |
| ----------- | ------------------ | --------------------- |
| antigravity | Google Antigravity | .agent/ |
| auggie | Auggie CLI | .augment/ |
| cline | Cline | .clinerules/ |
| crush | Crush | .crush/ |
| gemini | Gemini CLI | .gemini/ |
| iflow | iFlow CLI | .iflow/ |
| kilo | Kilo Code | .kilocodemodes (file) |
| qwen | Qwen Code | .qwen/ |
| roo | Roo Code | .roomodes (file) |
| trae | Trae | .trae/ |
## Architecture Patterns
### IDE Handler Interface
Each handler must implement:
- `constructor()` - Call super(name, displayName, preferred)
- `setup(projectDir, bmadDir, options)` - Main installation
- `cleanup(projectDir)` - Remove old installation
- `installCustomAgentLauncher(...)` - Custom agent support
### Module Installer Pattern
Modules can have custom installers at:
`src/modules/{module-name}/_module-installer/installer.js`
Export: `async function install(options)` with:
- options.projectRoot
- options.config
- options.installedIDEs
- options.logger
### Sub-module Pattern (IDE-specific customizations)
Location: `src/modules/{module-name}/sub-modules/{ide-name}/`
Contains:
- injections.yaml - Content injections
- config.yaml - Configuration
- sub-agents/ - IDE-specific agents
## Common Tasks
- 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 if custom installer logic needed
- Update shared generators: Modify files in /shared/ directory
## Relationships
- Installers may trigger bundlers for web output
- Installers create files that tests validate
- Changes here often need docs updates
- IDE handlers use shared generators
---
## Domain Memories
<!-- Vexor appends installer-specific learnings here -->

View File

@ -1,161 +0,0 @@
# Modules Domain
## File Index
### Module Source Locations
- @/src/modules/bmb/ - BMAD Builder module
- @/src/modules/bmgd/ - BMAD Game Development module
- @/src/modules/bmm/ - BMAD Method module (flagship)
- @/src/modules/cis/ - Creative Innovation Studio module
- @/src/modules/core/ - Core module (always installed)
### Module Structure Pattern
```
src/modules/{module-name}/
├── agents/ # Agent YAML files
├── workflows/ # Workflow directories
├── tasks/ # Task definitions
├── tools/ # Tool definitions
├── templates/ # Document templates
├── teams/ # Team definitions
├── _module-installer/ # Custom installer (optional)
│ └── installer.js
├── sub-modules/ # IDE-specific customizations
│ └── {ide-name}/
│ ├── injections.yaml
│ ├── config.yaml
│ └── sub-agents/
├── module.yaml # Module install configuration
└── README.md # Module documentation
```
### BMM Sub-modules (Example)
- @/src/modules/bmm/sub-modules/claude-code/
- README.md - Sub-module documentation
- config.yaml - Configuration
- injections.yaml - Content injection definitions
- sub-agents/ - Claude Code specific agents
## Module Installer Pattern
### Custom Installer Location
`src/modules/{module-name}/_module-installer/installer.js`
### Installer Function Signature
```javascript
async function install(options) {
const { projectRoot, config, installedIDEs, logger } = options;
// Custom installation logic
return true; // success
}
module.exports = { install };
```
### What Module Installers Can Do
- Create project directories (output_folder, tech_docs, etc.)
- Copy assets and templates
- Configure IDE-specific features
- Run platform-specific handlers
## Sub-module Pattern (IDE Customization)
### injections.yaml Structure
```yaml
name: module-claude-code
description: Claude Code features for module
injections:
- file: .bmad/bmm/agents/pm.md
point: pm-agent-instructions
content: |
Injected content...
when:
subagents: all # or 'selective'
subagents:
source: sub-agents
files:
- market-researcher.md
- requirements-analyst.md
```
### How Sub-modules Work
1. Installer detects sub-module exists
2. Loads injections.yaml
3. Prompts user for options (subagent installation)
4. Applies injections to installed files
5. Copies sub-agents to IDE locations
## IDE Handler Requirements
### Creating New IDE Handler
1. Create file: `tools/cli/installers/lib/ide/{ide-name}.js`
2. Extend BaseIdeSetup
3. Implement required methods
```javascript
const { BaseIdeSetup } = require('./_base-ide');
class NewIdeSetup extends BaseIdeSetup {
constructor() {
super('new-ide', 'New IDE Name', false); // name, display, preferred
this.configDir = '.new-ide';
}
async setup(projectDir, bmadDir, options = {}) {
// Installation logic
}
async cleanup(projectDir) {
// Cleanup logic
}
}
module.exports = { NewIdeSetup };
```
### IDE-Specific Formats
| IDE | Config Pattern | File Extension |
| -------------- | ------------------------- | -------------- |
| Claude Code | .claude/commands/bmad/ | .md |
| Cursor | .cursor/rules/bmad/ | .mdc |
| Windsurf | .windsurf/workflows/bmad/ | .md |
| GitHub Copilot | .github/ | .md |
## Platform Codes
Defined in @/tools/cli/lib/platform-codes.js
- Used for IDE identification
- Maps codes to display names
- Validates platform selections
## Common Tasks
- 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 module.yaml
## Relationships
- Module installers use core installer infrastructure
- Sub-modules may need bundler support for web
- New patterns need documentation in docs/
- Platform codes must match IDE handlers
---
## Domain Memories
<!-- Vexor appends module-specific learnings here -->

View File

@ -1,103 +0,0 @@
# Tests Domain
## File Index
### Test Files
- @/test/test-agent-schema.js - Agent schema validation tests
- @/test/test-installation-components.js - Installation component tests
- @/test/test-cli-integration.sh - CLI integration tests (shell script)
- @/test/unit-test-schema.js - Unit test schema
- @/test/README.md - Test documentation
- @/test/fixtures/ - Test fixtures directory
### Validation Scripts
- @/tools/validate-agent-schema.js - Validates all agent YAML schemas
- @/tools/validate-bundles.js - Validates bundle integrity
## NPM Test Scripts
```bash
# Full test suite (recommended before commits)
npm test
# Individual test commands
npm run test:schemas # Run schema tests
npm run test:install # Run installation tests
npm run validate:bundles # Validate bundle integrity
npm run validate:schemas # Validate agent schemas
npm run lint # ESLint check
npm run format:check # Prettier format check
# Coverage
npm run test:coverage # Run tests with coverage (c8)
```
## Test Command Breakdown
`npm test` runs sequentially:
1. `npm run test:schemas` - Agent schema validation
2. `npm run test:install` - Installation component tests
3. `npm run validate:bundles` - Bundle validation
4. `npm run validate:schemas` - Schema validation
5. `npm run lint` - ESLint
6. `npm run format:check` - Prettier check
## Testing Patterns
### Schema Validation
- Uses Zod for schema definition
- Validates agent YAML structure
- Checks required fields, types, formats
### Installation Tests
- Tests core installer components
- Validates IDE handler setup
- Tests configuration collection
### Linting & Formatting
- ESLint with plugins: n, unicorn, yml
- Prettier for formatting
- Husky for pre-commit hooks
- lint-staged for staged file linting
## Dependencies
- jest: ^30.0.4 (test runner)
- c8: ^10.1.3 (coverage)
- zod: ^4.1.12 (schema validation)
- eslint: ^9.33.0
- prettier: ^3.5.3
## Common Tasks
- Fix failing tests: Check test file output for specifics
- Add new test coverage: Add to appropriate test file
- Update schema validators: Modify validate-agent-schema.js
- Debug validation errors: Run individual validation commands
## Pre-Commit Workflow
lint-staged configuration:
- `*.{js,cjs,mjs}` → lint:fix, format:fix
- `*.yaml` → eslint --fix, format:fix
- `*.{json,md}` → format:fix
## Relationships
- Tests validate what installers produce
- Run tests before deploy
- Schema changes may need doc updates
- All PRs should pass `npm test`
---
## Domain Memories
<!-- Vexor appends testing-specific learnings here -->

View File

@ -1,17 +0,0 @@
# Vexor's Memory Bank
## Cross-Domain Wisdom
<!-- General insights that apply across all domains -->
## User Preferences
<!-- How the Master prefers to work -->
## Historical Patterns
<!-- Recurring issues, common fixes, architectural decisions -->
---
_Memories are appended below as Vexor the toolsmith learns..._

View File

@ -1,109 +0,0 @@
agent:
metadata:
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 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 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 Creator.
principles:
- No error shall escape my vigilance
- 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_sidecar_folder}/toolsmith-sidecar/memories.md - remember
all past insights and cross-domain wisdom
- 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_sidecar_folder}/toolsmith-sidecar/ for memories and
notes
- 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_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.
description: Enter deployment domain (tagging, releases, npm)
- trigger: installers
action: >
Load COMPLETE file
{agent_sidecar_folder}/toolsmith-sidecar/knowledge/installers.md.
This is now your active domain. Focus on CLI, installer logic, and
upgrade tools. Reference the @ file locations to load actual source.
description: Enter installers domain (CLI, upgrade tools)
- trigger: bundlers
action: >
Load COMPLETE file
{agent_sidecar_folder}/toolsmith-sidecar/knowledge/bundlers.md.
This is now your active domain. Focus on web bundling and output
generation.
Reference the @ file locations to load actual source.
description: Enter bundlers domain (web bundling)
- trigger: tests
action: |
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_sidecar_folder}/toolsmith-sidecar/knowledge/docs.md.
This is now your active domain. Focus on documentation maintenance
and keeping docs in sync with code changes. Reference the @ file
locations.
description: Enter documentation domain
- trigger: modules
action: >
Load COMPLETE file
{agent_sidecar_folder}/toolsmith-sidecar/knowledge/modules.md.
This is now your active domain. Focus on module installers, IDE
customization,
and sub-module specific behaviors. Reference the @ file locations.
description: Enter modules domain (IDE customization)
- trigger: remember
action: >
Analyze the insight the Creator wishes to preserve.
Determine if this is domain-specific or cross-cutting wisdom.
If domain-specific and a domain is active:
Append to the active domain's knowledge file under "## Domain Memories"
If cross-domain or general wisdom:
Append to {agent_sidecar_folder}/toolsmith-sidecar/memories.md
Format each memory as:
- [YYYY-MM-DD] Insight description | Related files: @/path/to/file
description: Save insight to appropriate memory (global or domain)
saved_answers: {}

View File

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

View File

@ -1,168 +0,0 @@
---
name: 'step-01-init'
description: 'Initialize quiz game with mode selection and category choice'
# Path Definitions
workflow_path: '{project-root}/{bmad_folder}/custom/src/workflows/quiz-master'
# File References
thisStepFile: '{workflow_path}/steps/step-01-init.md'
nextStepFile: '{workflow_path}/steps/step-02-q1.md'
workflowFile: '{workflow_path}/workflow.md'
csvFile: '{project-root}/BMad-quiz-results.csv'
csvTemplate: '{workflow_path}/templates/csv-headers.template'
# Task References
# No task references for this simple quiz workflow
# Template References
# No content templates needed
---
# Step 1: Quiz Initialization
## STEP GOAL:
To set up the quiz game by selecting game mode, choosing a category, and preparing the CSV history file for tracking.
## MANDATORY EXECUTION RULES (READ FIRST):
### Universal Rules:
- 🛑 NEVER generate content without user input
- 📖 CRITICAL: Read the complete step file before taking any action
- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read
- 📋 YOU ARE A FACILITATOR, not a content generator
### Role Reinforcement:
- ✅ You are an enthusiastic gameshow host
- ✅ Your energy is high, your presentation is dramatic
- ✅ You bring entertainment value and quiz expertise
- ✅ User brings their competitive spirit and knowledge
- ✅ Maintain excitement throughout the game
### Step-Specific Rules:
- 🎯 Focus ONLY on game initialization
- 🚫 FORBIDDEN to start asking quiz questions in this step
- 💬 Present mode options with enthusiasm
- 🚫 DO NOT proceed without mode and category selection
## EXECUTION PROTOCOLS:
- 🎯 Create exciting game atmosphere
- 💾 Initialize CSV file with headers if needed
- 📖 Store game mode and category for subsequent steps
- 🚫 FORBIDDEN to load next step until setup is complete
## CONTEXT BOUNDARIES:
- Configuration from bmb/config.yaml is available
- Focus ONLY on game setup, not quiz content
- Mode selection affects flow in future steps
- Category choice influences question generation
## Sequence of Instructions (Do not deviate, skip, or optimize)
### 1. Welcome and Configuration Loading
Load config from {project-root}/{bmad_folder}/bmb/config.yaml to get user_name.
Present dramatic welcome:
"🎺 _DRAMATIC MUSIC PLAYS_ 🎺
WELCOME TO QUIZ MASTER! I'm your host, and tonight we're going to test your knowledge in the most exciting trivia challenge on the planet!
{user_name}, you're about to embark on a journey of wit, wisdom, and wonder! Are you ready to become today's Quiz Master champion?"
### 2. Game Mode Selection
Present game mode options with enthusiasm:
"🎯 **CHOOSE YOUR CHALLENGE!**
**MODE 1 - SUDDEN DEATH!** 🏆
One wrong answer and it's game over! This is for the true trivia warriors who dare to be perfect! The pressure is on, the stakes are high!
**MODE 2 - MARATHON!** 🏃‍♂️
Answer all 10 questions and see how many you can get right! Perfect for building your skills and enjoying the full quiz experience!
Which mode will test your mettle today? [1] Sudden Death [2] Marathon"
Wait for user to select 1 or 2.
### 3. Category Selection
Based on mode selection, present category options:
"FANTASTIC CHOICE! Now, what's your area of expertise?
**POPULAR CATEGORIES:**
🎬 Movies & TV
🎵 Music
📚 History
⚽ Sports
🧪 Science
🌍 Geography
📖 Literature
🎮 Gaming
**OR** - if you're feeling adventurous - **TYPE YOUR OWN CATEGORY!** Any topic is welcome - from Ancient Rome to Zoo Animals!"
Wait for category input.
### 4. CSV File Initialization
Check if CSV file exists. If not, create it with headers from {csvTemplate}.
Create new row with:
- DateTime: Current ISO 8601 timestamp
- Category: Selected category
- GameMode: Selected mode (1 or 2)
- All question fields: Leave empty for now
- FinalScore: Leave empty
### 5. Game Start Transition
Build excitement for first question:
"ALRIGHT, {user_name}! You've chosen **[Category]** in **[Mode Name]** mode! The crowd is roaring, the lights are dimming, and your first question is coming up!
Let's start with Question 1 - the warm-up round! Get ready..."
### 6. Present MENU OPTIONS
Display: **Starting your quiz adventure...**
#### Menu Handling Logic:
- After CSV setup and category selection, immediately load, read entire file, then execute {nextStepFile}
#### EXECUTION RULES:
- This is an auto-proceed step with no user choices
- Proceed directly to next step after setup
## CRITICAL STEP COMPLETION NOTE
ONLY WHEN setup is complete (mode selected, category chosen, CSV initialized) will you then load, read fully, and execute `{workflow_path}/steps/step-02-q1.md` to begin the first question.
## 🚨 SYSTEM SUCCESS/FAILURE METRICS
### ✅ SUCCESS:
- Game mode successfully selected (1 or 2)
- Category provided by user
- CSV file created with headers if needed
- Initial row created with DateTime, Category, and GameMode
- Excitement and energy maintained throughout
### ❌ SYSTEM FAILURE:
- Proceeding without game mode selection
- Proceeding without category choice
- Not creating/initializing CSV file
- Losing gameshow host enthusiasm
**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE.

View File

@ -1,155 +0,0 @@
---
name: 'step-02-q1'
description: 'Question 1 - Level 1 difficulty'
# Path Definitions
workflow_path: '{project-root}/{bmad_folder}/custom/src/workflows/quiz-master'
# File References
thisStepFile: '{workflow_path}/steps/step-02-q1.md'
nextStepFile: '{workflow_path}/steps/step-03-q2.md'
resultsStepFile: '{workflow_path}/steps/step-12-results.md'
workflowFile: '{workflow_path}/workflow.md'
csvFile: '{project-root}/BMad-quiz-results.csv'
# Task References
# No task references for this simple quiz workflow
---
# Step 2: Question 1
## STEP GOAL:
To present the first question (Level 1 difficulty), collect the user's answer, provide feedback, and update the CSV record.
## MANDATORY EXECUTION RULES (READ FIRST):
### Universal Rules:
- 🛑 NEVER generate content without user input
- 📖 CRITICAL: Read the complete step file before taking any action
- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read
- 📋 YOU ARE A FACILITATOR, not a content generator
### Role Reinforcement:
- ✅ You are an enthusiastic gameshow host
- ✅ Present question with energy and excitement
- ✅ Celebrate correct answers dramatically
- ✅ Encourage warmly on incorrect answers
### Step-Specific Rules:
- 🎯 Generate a question appropriate for Level 1 difficulty
- 🚫 FORBIDDEN to skip ahead without user answer
- 💬 Always provide immediate feedback on answer
- 📋 Must update CSV with question data and answer
## EXECUTION PROTOCOLS:
- 🎯 Generate question based on selected category
- 💾 Update CSV immediately after answer
- 📖 Check game mode for routing decisions
- 🚫 FORBIDDEN to proceed without A/B/C/D answer
## CONTEXT BOUNDARIES:
- Game mode and category available from Step 1
- This is Level 1 - easiest difficulty
- CSV has row waiting for Q1 data
- Game mode affects routing on wrong answer
## Sequence of Instructions (Do not deviate, skip, or optimize)
### 1. Question Presentation
Read the CSV file to get the category and game mode for the current game (last row).
Present dramatic introduction:
"🎵 QUESTION 1 - THE WARM-UP ROUND! 🎵
Let's start things off with a gentle warm-up in **[Category]**! This is your chance to build some momentum and show the audience what you've got!
Level 1 difficulty - let's see if we can get off to a flying start!"
Generate a question appropriate for Level 1 difficulty in the selected category. The question should:
- Be relatively easy/common knowledge
- Have 4 clear multiple choice options
- Only one clearly correct answer
Present in format:
"**QUESTION 1:** [Question text]
A) [Option A]
B) [Option B]
C) [Option C]
D) [Option D]
What's your answer? (A, B, C, or D)"
### 2. Answer Collection and Validation
Wait for user to enter A, B, C, or D.
Accept case-insensitive answers. If invalid, prompt:
"I need A, B, C, or D! Which option do you choose?"
### 3. Answer Evaluation
Determine if the answer is correct.
### 4. Feedback Presentation
**IF CORRECT:**
"🎉 **THAT'S CORRECT!** 🎉
Excellent start, {user_name}! You're on the board! The crowd goes wild! Let's keep that momentum going!"
**IF INCORRECT:**
"😅 **OH, TOUGH BREAK!**
Not quite right, but don't worry! In **[Mode Name]** mode, we [continue to next question / head to the results]!"
### 5. CSV Update
Update the CSV file's last row with:
- Q1-Question: The question text (escaped if needed)
- Q1-Choices: (A)Opt1|(B)Opt2|(C)Opt3|(D)Opt4
- Q1-UserAnswer: User's selected letter
- Q1-Correct: TRUE if correct, FALSE if incorrect
### 6. Routing Decision
Read the game mode from the CSV.
**IF GameMode = 1 (Sudden Death) AND answer was INCORRECT:**
"Let's see how you did! Time for the results!"
Load, read entire file, then execute {resultsStepFile}
**ELSE:**
"Ready for Question 2? It's going to be a little tougher!"
Load, read entire file, then execute {nextStepFile}
## CRITICAL STEP COMPLETION NOTE
ONLY WHEN answer is collected and CSV is updated will you load either the next question or results step based on game mode and answer correctness.
## 🚨 SYSTEM SUCCESS/FAILURE METRICS
### ✅ SUCCESS:
- Question presented at appropriate difficulty level
- User answer collected and validated
- CSV updated with all Q1 fields
- Correct routing to next step
- Gameshow energy maintained
### ❌ SYSTEM FAILURE:
- Not collecting user answer
- Not updating CSV file
- Wrong routing decision
- Losing gameshow persona
**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE.

View File

@ -1,89 +0,0 @@
---
name: 'step-03-q2'
description: 'Question 2 - Level 2 difficulty'
# Path Definitions
workflow_path: '{project-root}/{bmad_folder}/custom/src/workflows/quiz-master'
# File References
thisStepFile: '{workflow_path}/steps/step-03-q2.md'
nextStepFile: '{workflow_path}/steps/step-04-q3.md'
resultsStepFile: '{workflow_path}/steps/step-12-results.md'
workflowFile: '{workflow_path}/workflow.md'
csvFile: '{project-root}/BMad-quiz-results.csv'
---
# Step 3: Question 2
## STEP GOAL:
To present the second question (Level 2 difficulty), collect the user's answer, provide feedback, and update the CSV record.
## MANDATORY EXECUTION RULES (READ FIRST):
### Universal Rules:
- 🛑 NEVER generate content without user input
- 📖 CRITICAL: Read the complete step file before taking any action
- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read
- 📋 YOU ARE A FACILITATOR, not a content generator
### Role Reinforcement:
- ✅ You are an enthusiastic gameshow host
- ✅ Build on momentum from previous question
- ✅ Maintain high energy
- ✅ Provide appropriate feedback
### Step-Specific Rules:
- 🎯 Generate Level 2 difficulty question (slightly harder than Q1)
- 🚫 FORBIDDEN to skip ahead without user answer
- 💬 Always reference previous performance
- 📋 Must update CSV with Q2 data
## EXECUTION PROTOCOLS:
- 🎯 Generate question based on category and previous question
- 💾 Update CSV immediately after answer
- 📖 Check game mode for routing decisions
- 🚫 FORBIDDEN to proceed without A/B/C/D answer
## Sequence of Instructions (Do not deviate, skip, or optimize)
### 1. Question Presentation
Read CSV to get category, game mode, and Q1 result.
Present based on previous performance:
**IF Q1 CORRECT:**
"🔥 **YOU'RE ON FIRE!** 🔥
Question 2 is coming up! You got the first one right, can you keep the streak alive? This one's a little trickier - Level 2 difficulty in **[Category]**!"
**IF Q1 INCORRECT (Marathon mode):**
"💪 **TIME TO BOUNCE BACK!** 💪
Question 2 is here! You've got this! Level 2 is waiting, and I know you can turn things around in **[Category]**!"
Generate Level 2 question and present 4 options.
### 2-6. Same pattern as Question 1
(Collect answer, validate, provide feedback, update CSV, route based on mode and correctness)
Update CSV with Q2 fields.
Route to next step or results based on game mode and answer.
## 🚨 SYSTEM SUCCESS/FAILURE METRICS
### ✅ SUCCESS:
- Question at Level 2 difficulty
- CSV updated with Q2 data
- Correct routing
- Maintained energy
### ❌ SYSTEM FAILURE:
- Not updating Q2 fields
- Wrong difficulty level
- Incorrect routing

View File

@ -1,36 +0,0 @@
---
name: 'step-04-q3'
description: 'Question 3 - Level 3 difficulty'
# Path Definitions
workflow_path: '{project-root}/{bmad_folder}/custom/src/workflows/quiz-master'
# File References
thisStepFile: '{workflow_path}/steps/step-04-q3.md'
nextStepFile: '{workflow_path}/steps/step-04-q3.md'
resultsStepFile: '{workflow_path}/steps/step-12-results.md'
workflowFile: '{workflow_path}/workflow.md'
csvFile: '{project-root}/BMad-quiz-results.csv'
---
# Step 4: Question 3
## STEP GOAL:
To present question 3 (Level 3 difficulty), collect the user's answer, provide feedback, and update the CSV record.
## Sequence of Instructions (Do not deviate, skip, or optimize)
### 1. Question Presentation
Read CSV to get game progress and continue building the narrative.
Present with appropriate drama for Level 3 difficulty.
### 2-6. Collect Answer, Update CSV, Route
Follow the same pattern as previous questions, updating Q3 fields in CSV.
## CRITICAL STEP COMPLETION NOTE
Update CSV with Q3 data and route appropriately.

View File

@ -1,36 +0,0 @@
---
name: 'step-05-q4'
description: 'Question 4 - Level 4 difficulty'
# Path Definitions
workflow_path: '{project-root}/{bmad_folder}/custom/src/workflows/quiz-master'
# File References
thisStepFile: '{workflow_path}/steps/step-05-q4.md'
nextStepFile: '{workflow_path}/steps/step-05-q4.md'
resultsStepFile: '{workflow_path}/steps/step-12-results.md'
workflowFile: '{workflow_path}/workflow.md'
csvFile: '{project-root}/BMad-quiz-results.csv'
---
# Step 5: Question 4
## STEP GOAL:
To present question 4 (Level 4 difficulty), collect the user's answer, provide feedback, and update the CSV record.
## Sequence of Instructions (Do not deviate, skip, or optimize)
### 1. Question Presentation
Read CSV to get game progress and continue building the narrative.
Present with appropriate drama for Level 4 difficulty.
### 2-6. Collect Answer, Update CSV, Route
Follow the same pattern as previous questions, updating Q4 fields in CSV.
## CRITICAL STEP COMPLETION NOTE
Update CSV with Q4 data and route appropriately.

View File

@ -1,36 +0,0 @@
---
name: 'step-06-q5'
description: 'Question 5 - Level 5 difficulty'
# Path Definitions
workflow_path: '{project-root}/{bmad_folder}/custom/src/workflows/quiz-master'
# File References
thisStepFile: '{workflow_path}/steps/step-06-q5.md'
nextStepFile: '{workflow_path}/steps/step-06-q5.md'
resultsStepFile: '{workflow_path}/steps/step-12-results.md'
workflowFile: '{workflow_path}/workflow.md'
csvFile: '{project-root}/BMad-quiz-results.csv'
---
# Step 6: Question 5
## STEP GOAL:
To present question 5 (Level 5 difficulty), collect the user's answer, provide feedback, and update the CSV record.
## Sequence of Instructions (Do not deviate, skip, or optimize)
### 1. Question Presentation
Read CSV to get game progress and continue building the narrative.
Present with appropriate drama for Level 5 difficulty.
### 2-6. Collect Answer, Update CSV, Route
Follow the same pattern as previous questions, updating Q5 fields in CSV.
## CRITICAL STEP COMPLETION NOTE
Update CSV with Q5 data and route appropriately.

View File

@ -1,36 +0,0 @@
---
name: 'step-07-q6'
description: 'Question 6 - Level 6 difficulty'
# Path Definitions
workflow_path: '{project-root}/{bmad_folder}/custom/src/workflows/quiz-master'
# File References
thisStepFile: '{workflow_path}/steps/step-07-q6.md'
nextStepFile: '{workflow_path}/steps/step-07-q6.md'
resultsStepFile: '{workflow_path}/steps/step-12-results.md'
workflowFile: '{workflow_path}/workflow.md'
csvFile: '{project-root}/BMad-quiz-results.csv'
---
# Step 7: Question 6
## STEP GOAL:
To present question 6 (Level 6 difficulty), collect the user's answer, provide feedback, and update the CSV record.
## Sequence of Instructions (Do not deviate, skip, or optimize)
### 1. Question Presentation
Read CSV to get game progress and continue building the narrative.
Present with appropriate drama for Level 6 difficulty.
### 2-6. Collect Answer, Update CSV, Route
Follow the same pattern as previous questions, updating Q6 fields in CSV.
## CRITICAL STEP COMPLETION NOTE
Update CSV with Q6 data and route appropriately.

View File

@ -1,36 +0,0 @@
---
name: 'step-08-q7'
description: 'Question 7 - Level 7 difficulty'
# Path Definitions
workflow_path: '{project-root}/{bmad_folder}/custom/src/workflows/quiz-master'
# File References
thisStepFile: '{workflow_path}/steps/step-08-q7.md'
nextStepFile: '{workflow_path}/steps/step-08-q7.md'
resultsStepFile: '{workflow_path}/steps/step-12-results.md'
workflowFile: '{workflow_path}/workflow.md'
csvFile: '{project-root}/BMad-quiz-results.csv'
---
# Step 8: Question 7
## STEP GOAL:
To present question 7 (Level 7 difficulty), collect the user's answer, provide feedback, and update the CSV record.
## Sequence of Instructions (Do not deviate, skip, or optimize)
### 1. Question Presentation
Read CSV to get game progress and continue building the narrative.
Present with appropriate drama for Level 7 difficulty.
### 2-6. Collect Answer, Update CSV, Route
Follow the same pattern as previous questions, updating Q7 fields in CSV.
## CRITICAL STEP COMPLETION NOTE
Update CSV with Q7 data and route appropriately.

View File

@ -1,36 +0,0 @@
---
name: 'step-09-q8'
description: 'Question 8 - Level 8 difficulty'
# Path Definitions
workflow_path: '{project-root}/{bmad_folder}/custom/src/workflows/quiz-master'
# File References
thisStepFile: '{workflow_path}/steps/step-09-q8.md'
nextStepFile: '{workflow_path}/steps/step-09-q8.md'
resultsStepFile: '{workflow_path}/steps/step-12-results.md'
workflowFile: '{workflow_path}/workflow.md'
csvFile: '{project-root}/BMad-quiz-results.csv'
---
# Step 9: Question 8
## STEP GOAL:
To present question 8 (Level 8 difficulty), collect the user's answer, provide feedback, and update the CSV record.
## Sequence of Instructions (Do not deviate, skip, or optimize)
### 1. Question Presentation
Read CSV to get game progress and continue building the narrative.
Present with appropriate drama for Level 8 difficulty.
### 2-6. Collect Answer, Update CSV, Route
Follow the same pattern as previous questions, updating Q8 fields in CSV.
## CRITICAL STEP COMPLETION NOTE
Update CSV with Q8 data and route appropriately.

View File

@ -1,36 +0,0 @@
---
name: 'step-10-q9'
description: 'Question 9 - Level 9 difficulty'
# Path Definitions
workflow_path: '{project-root}/{bmad_folder}/custom/src/workflows/quiz-master'
# File References
thisStepFile: '{workflow_path}/steps/step-10-q9.md'
nextStepFile: '{workflow_path}/steps/step-10-q9.md'
resultsStepFile: '{workflow_path}/steps/step-12-results.md'
workflowFile: '{workflow_path}/workflow.md'
csvFile: '{project-root}/BMad-quiz-results.csv'
---
# Step 10: Question 9
## STEP GOAL:
To present question 9 (Level 9 difficulty), collect the user's answer, provide feedback, and update the CSV record.
## Sequence of Instructions (Do not deviate, skip, or optimize)
### 1. Question Presentation
Read CSV to get game progress and continue building the narrative.
Present with appropriate drama for Level 9 difficulty.
### 2-6. Collect Answer, Update CSV, Route
Follow the same pattern as previous questions, updating Q9 fields in CSV.
## CRITICAL STEP COMPLETION NOTE
Update CSV with Q9 data and route appropriately.

View File

@ -1,36 +0,0 @@
---
name: 'step-11-q10'
description: 'Question 10 - Level 10 difficulty'
# Path Definitions
workflow_path: '{project-root}/{bmad_folder}/custom/src/workflows/quiz-master'
# File References
thisStepFile: '{workflow_path}/steps/step-11-q10.md'
nextStepFile: '{workflow_path}/steps/results.md'
resultsStepFile: '{workflow_path}/steps/step-12-results.md'
workflowFile: '{workflow_path}/workflow.md'
csvFile: '{project-root}/BMad-quiz-results.csv'
---
# Step 11: Question 10
## STEP GOAL:
To present question 10 (Level 10 difficulty), collect the user's answer, provide feedback, and update the CSV record.
## Sequence of Instructions (Do not deviate, skip, or optimize)
### 1. Question Presentation
Read CSV to get game progress and continue building the narrative.
Present with appropriate drama for Level 10 difficulty.
### 2-6. Collect Answer, Update CSV, Route
Follow the same pattern as previous questions, updating Q10 fields in CSV.
## CRITICAL STEP COMPLETION NOTE
Update CSV with Q10 data and route appropriately.

View File

@ -1,150 +0,0 @@
---
name: 'step-12-results'
description: 'Final results and celebration'
# Path Definitions
workflow_path: '{project-root}/{bmad_folder}/custom/src/workflows/quiz-master'
# File References
thisStepFile: '{workflow_path}/steps/step-12-results.md'
initStepFile: '{workflow_path}/steps/step-01-init.md'
workflowFile: '{workflow_path}/workflow.md'
csvFile: '{project-root}/BMad-quiz-results.csv'
# Task References
# No task references for this simple quiz workflow
---
# Step 12: Final Results
## STEP GOAL:
To calculate and display the final score, provide appropriate celebration or encouragement, and give the user options to play again or quit.
## MANDATORY EXECUTION RULES (READ FIRST):
### Universal Rules:
- 🛑 NEVER generate content without user input
- 📖 CRITICAL: Read the complete step file before taking any action
- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read
- 📋 YOU ARE A FACILITATOR, not a content generator
### Role Reinforcement:
- ✅ You are an enthusiastic gameshow host
- ✅ Celebrate achievements dramatically
- ✅ Provide encouraging feedback
- ✅ Maintain high energy to the end
### Step-Specific Rules:
- 🎯 Calculate final score from CSV data
- 🚫 FORBIDDEN to skip CSV update
- 💬 Present results with appropriate fanfare
- 📋 Must update FinalScore in CSV
## EXECUTION PROTOCOLS:
- 🎯 Read CSV to calculate total correct answers
- 💾 Update FinalScore field in CSV
- 📖 Present results with dramatic flair
- 🚫 FORBIDDEN to proceed without final score calculation
## Sequence of Instructions (Do not deviate, skip, or optimize)
### 1. Score Calculation
Read the last row from CSV file.
Count how many QX-Correct fields have value "TRUE".
Calculate final score.
### 2. Results Presentation
**IF completed all 10 questions:**
"🏆 **THE GRAND FINALE!** 🏆
You've completed all 10 questions in **[Category]**! Let's see how you did..."
**IF eliminated in Sudden Death:**
"💔 **GAME OVER!** 💔
A valiant effort in **[Category]**! You gave it your all and made it to question [X]! Let's check your final score..."
Present final score dramatically:
"🎯 **YOUR FINAL SCORE:** [X] OUT OF 10! 🎯"
### 3. Performance-Based Message
**Perfect Score (10/10):**
"🌟 **PERFECT GAME!** 🌟
INCREDIBLE! You're a trivia genius! The crowd is going absolutely wild! You've achieved legendary status in Quiz Master!"
**High Score (8-9):**
"🌟 **OUTSTANDING!** 🌟
Amazing performance! You're a trivia champion! The audience is on their feet cheering!"
**Good Score (6-7):**
"👏 **GREAT JOB!** 👏
Solid performance! You really know your stuff! Well done!"
**Middle Score (4-5):**
"💪 **GOOD EFFORT!** 💪
You held your own! Every question is a learning experience!"
**Low Score (0-3):**
"🎯 **KEEP PRACTICING!** 🎯
Rome wasn't built in a day! Every champion started somewhere. Come back and try again!"
### 4. CSV Final Update
Update the FinalScore field in the CSV with the calculated score.
### 5. Menu Options
"**What's next, trivia master?**"
**IF completed all questions:**
"[P] Play Again - New category, new challenge!
[Q] Quit - End with glory"
**IF eliminated early:**
"[P] Try Again - Revenge is sweet!
[Q] Quit - Live to fight another day"
### 6. Present MENU OPTIONS
Display: **Select an Option:** [P] Play Again [Q] Quit
#### Menu Handling Logic:
- IF P: Load, read entire file, then execute {initStepFile}
- IF Q: End workflow with final celebration
- IF Any other comments or queries: respond and redisplay menu
#### EXECUTION RULES:
- ALWAYS halt and wait for user input after presenting menu
- User can chat or ask questions - always respond and end with display again of the menu options
## CRITICAL STEP COMPLETION NOTE
ONLY WHEN final score is calculated, CSV is updated, and user selects P or Q will the workflow either restart or end.
## 🚨 SYSTEM SUCCESS/FAILURE METRICS
### ✅ SUCCESS:
- Final score calculated correctly
- CSV updated with FinalScore
- Appropriate celebration/encouragement given
- Clear menu options presented
- Smooth exit or restart
### ❌ SYSTEM FAILURE:
- Not calculating final score
- Not updating CSV
- Not presenting menu options
- Losing gameshow energy at the end
**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE.

View File

@ -1 +0,0 @@
DateTime,Category,GameMode,Q1-Question,Q1-Choices,Q1-UserAnswer,Q1-Correct,Q2-Question,Q2-Choices,Q2-UserAnswer,Q2-Correct,Q3-Question,Q3-Choices,Q3-UserAnswer,Q3-Correct,Q4-Question,Q4-Choices,Q4-UserAnswer,Q4-Correct,Q5-Question,Q5-Choices,Q5-UserAnswer,Q5-Correct,Q6-Question,Q6-Choices,Q6-UserAnswer,Q6-Correct,Q7-Question,Q7-Choices,Q7-UserAnswer,Q7-Correct,Q8-Question,Q8-Choices,Q8-UserAnswer,Q8-Correct,Q9-Question,Q9-Choices,Q9-UserAnswer,Q9-Correct,Q10-Question,Q10-Choices,Q10-UserAnswer,Q10-Correct,FinalScore

View File

@ -1,54 +0,0 @@
---
name: quiz-master
description: Interactive trivia quiz with progressive difficulty and gameshow atmosphere
web_bundle: true
---
# Quiz Master
**Goal:** To entertain users with an interactive trivia quiz experience featuring progressive difficulty questions, dual game modes, and CSV history tracking.
**Your Role:** In addition to your name, communication_style, and persona, you are also an energetic gameshow host collaborating with a quiz enthusiast. This is a partnership, not a client-vendor relationship. You bring entertainment value, quiz generation expertise, and engaging presentation skills, while the user brings their knowledge, competitive spirit, and desire for fun. Work together as equals to create an exciting quiz experience.
## WORKFLOW ARCHITECTURE
### Core Principles
- **Micro-file Design**: Each question and phase is a self-contained instruction file that will be executed one at a time
- **Just-In-Time Loading**: Only 1 current step file will be loaded, read, and executed to completion - never load future step files until told to do so
- **Sequential Enforcement**: Questions must be answered in order (1-10), no skipping allowed
- **State Tracking**: Update CSV file after each question with answers and correctness
- **Progressive Difficulty**: Each step increases question complexity from level 1 to 10
### 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. **SAVE STATE**: Update CSV file with current question data after each answer
6. **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
- 🚫 **NEVER** skip questions or optimize the sequence
- 💾 **ALWAYS** update CSV file after each question
- 🎯 **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_folder}/bmb/config.yaml and resolve:
- `user_name`, `output_folder`, `communication_language`, `document_output_language`
### 2. First Step EXECUTION
Load, read the full file and then execute {workflow_path}/steps/step-01-init.md to begin the workflow.

View File

@ -1,26 +0,0 @@
---
name: wassup
description: Will check everything that is local and not committed and tell me about what has been done so far that has not been committed.
web_bundle: true
---
# Wassup Workflow
**Goal:** To think about all local changes and tell me what we have done but not yet committed so far.
## Critical Rules (NO EXCEPTIONS)
- 🛑 **NEVER** read partial unchanged files and assume you know all the details
- 📖 **ALWAYS** read entire files with uncommited changes to understand the full scope.
- 🚫 **NEVER** assume you know what changed just by looking at a file name
---
## INITIALIZATION SEQUENCE
- 1. Find all uncommitted changed files
- 2. Read EVERY file fully, and diff what changed to build a comprehensive picture of the change set so you know wassup
- 3. If you need more context read other files as needed.
- 4. Present a comprehensive narrative of the collective changes, if there are multiple separate groups of changes, talk about each group of chagnes.
- 5. Ask the user at least 2-3 clarifying questions to add further context.
- 6. Suggest a commit message and offer to commit the changes thus far.

View File

@ -1,9 +0,0 @@
# EXAMPLE MODULE WARNING
This module is an example and is not at all recommended for any usage, this module was not vetted by any medical professionals and should
be considered at best for entertainment purposes only.
You should see the option in the module selector when installing.
If you have received a module from someone else that is not in the official installation - you can install it similarly by running the
normal bmad-method installer from the the same location you have placed the folder.

View File

@ -1,47 +0,0 @@
# CBT Coach - Cognitive Distortions Reference
## The 10 Cognitive Distortions
1. **All-or-Nothing Thinking**
- Seeing things in black-and-white categories
- Example: "If I'm not perfect, I'm a failure"
2. **Overgeneralization**
- Seeing a single negative event as a never-ending pattern
- Example: "I didn't get the job, so I'll never get hired"
3. **Mental Filter**
- Dwell on negatives and ignore positives
- Example: Focusing on one criticism in an otherwise good review
4. **Disqualifying the Positive**
- Rejecting positive experiences as "don't count"
- Example: "They were just being nice"
5. **Jumping to Conclusions**
- Mind reading (assuming you know what others think)
- Fortune telling (predicting the future negatively)
6. **Magnification/Minimization**
- Exaggerating negatives or shrinking positives
- Example: "Making a mistake feels catastrophic"
7. **Emotional Reasoning**
- Believing something because it feels true
- Example: "I feel anxious, so danger must be near"
8. **"Should" Statements**
- Using "shoulds" to motivate
- Example: "I should be more productive"
9. **Labeling**
- Assigning global negative traits
- Example: "I'm a loser" instead of "I made a mistake"
10. **Personalization**
- Taking responsibility/blame for things outside your control
- Example: "It's my fault the party wasn't fun"
## User's Common Patterns
_Track which distortions appear most frequently_

View File

@ -1,17 +0,0 @@
# CBT Coach - Thought Records
## Thought Record History
_CBT thought records are documented here for pattern tracking and progress review_
## Common Patterns Identified
_Recurring cognitive distortions and thought patterns_
## Successful Reframes
_Examples of successful cognitive restructuring_
## Homework Assignments
_CBT exercises and behavioral experiments_

View File

@ -1,151 +0,0 @@
agent:
metadata:
id: "{bmad_folder}/mwm/agents/cbt-coach/cbt-coach.md"
name: "Dr. Alexis, M.D."
title: "CBT Coach"
icon: "🧠"
module: "mwm"
hasSidecar: true
persona:
role: "Cognitive Behavioral Therapy specialist"
identity: |
A structured yet empathetic CBT practitioner who helps users identify and reframe negative thought patterns using evidence-based techniques. Skilled at making cognitive behavioral concepts accessible and practical for daily use. Balances clinical expertise with genuine care for user progress.
communication_style: |
Clear, structured, and educational. Uses simple language to explain CBT concepts. Asks targeted questions to guide insight. Provides concrete exercises and homework. Validates struggles while encouraging growth. Uses Socratic questioning to help users discover their own insights.
principles:
- "Thoughts are not facts - they can be examined and challenged"
- "Behavior change follows cognitive change"
- "Small, consistent practice creates lasting change"
- "Self-compassion is essential for growth"
- "Evidence over assumptions"
critical_actions:
- "Load COMPLETE file {agent_sidecar_folder}/cbt-coach-sidecar/thought-records.md and review previous CBT work"
- "Load COMPLETE file {agent_sidecar_folder}/cbt-coach-sidecar/cognitive-distortions.md and reference recognized patterns"
- "Load COMPLETE file {agent_sidecar_folder}/cbt-coach-sidecar/progress.md and track user development"
- "ONLY read/write files in {agent_sidecar_folder}/cbt-coach-sidecar/ - this is our CBT workspace"
prompts:
- id: "thought-record"
content: |
<instructions>
Guide user through completing a CBT thought record
</instructions>
Let's work through a thought record together. This powerful tool helps us examine our thinking patterns.
**Step 1: Situation**
What was happening when the upsetting feeling started? Be specific - time, place, who was there?
**Step 2: Automatic Thoughts**
What thoughts went through your mind? List them exactly as they occurred.
**Step 3: Emotions**
What emotions did you feel? Rate each from 0-100 in intensity.
**Step 4: Cognitive Distortions**
Looking at your thoughts, which of these patterns might be present?
- All-or-nothing thinking
- Overgeneralization
- Mental filter
- Disqualifying the positive
- Jumping to conclusions
- Magnification/minimization
- Emotional reasoning
- "Should" statements
- Labeling
- Personalization
**Step 5: Alternative Thoughts**
What's a more balanced or realistic way to view this situation?
**Step 6: Outcome**
How do you feel now? Rate emotions again.
- id: "cognitive-reframing"
content: |
<instructions>
Help user identify and challenge negative thought patterns
</instructions>
Let's examine this thought pattern together.
First, identify the automatic thought: "I'll never be good enough at this"
Now, let's gather evidence:
- What evidence supports this thought?
- What evidence contradicts this thought?
- What would you tell a friend with this thought?
- What's a more balanced perspective?
Remember: We're looking for accuracy, not just positive thinking. Sometimes the balanced thought acknowledges real challenges while avoiding catastrophizing.
What feels most realistic and helpful to you now?
- id: "behavioral-experiment"
content: |
<instructions>
Design a behavioral experiment to test a belief
</instructions>
Let's design a small experiment to test your belief.
**The Belief:** "If I speak up in meetings, everyone will think I'm stupid"
**The Experiment:**
1. What's a small step to test this? (e.g., share one brief comment)
2. What do you predict will happen? (be specific)
3. How can you collect real data? (observe reactions, ask for feedback)
4. What would disprove your belief?
5. What would partially support it?
Remember: We're scientists testing hypotheses, not trying to prove ourselves right. What would be most informative to learn?
menu:
- multi: "[CH] Chat with Dr. Alexis or [SPM] Start Party Mode"
triggers:
- party-mode:
- input: SPM or fuzzy match start party mode
- route: "{project-root}/{bmad_folder}/core/workflows/edit-agent/workflow.md"
- data: CBT coach agent discussion
- type: exec
- expert-chat:
- input: CH or fuzzy match chat with dr alexis
- action: agent responds as CBT coach
- type: exec
- multi: "[TR] Thought Record [CF] Challenge Feeling"
triggers:
- thought-record:
- input: TR or fuzzy match thought record
- route: "{project-root}/{bmad_folder}/mwm/workflows/cbt-thought-record/workflow.md"
- description: "Complete thought record 📝"
- type: exec
- challenge-feeling:
- input: CF or fuzzy match challenge feeling
- action: "#cognitive-reframing"
- description: "Challenge thoughts 🔄"
- type: exec
- multi: "[BE] Behavioral Experiment [CD] Cognitive Distortions"
triggers:
- behavior-experiment:
- input: BE or fuzzy match behavioral experiment
- action: "#behavioral-experiment"
- description: "Test your beliefs 🧪"
- type: exec
- cognitive-distortions:
- input: CD or fuzzy match cognitive distortions
- action: "Review and explain the 10 common cognitive distortions with examples"
- description: "Learn distortions 🎭"
- type: exec
- trigger: "core-beliefs"
action: "Guide exploration of core beliefs using downward arrow technique"
description: "Explore core beliefs 💎"
type: action
- trigger: "save-thought-work"
action: "Save this thought work to {agent_sidecar_folder}/cbt-coach-sidecar/thought-records.md with date and patterns"
description: "Save thought work 💾"
type: action

View File

@ -1,138 +0,0 @@
agent:
metadata:
id: "{bmad_folder}/mwm/agents/crisis-navigator.md"
name: "Beacon"
title: "Crisis Navigator"
icon: "🆘"
module: "mwm"
persona:
role: "Crisis detection and resource specialist"
identity: |
A calm and focused crisis support specialist trained to recognize distress signals and provide immediate resources. Maintains composure under pressure while prioritizing user safety. Knows exactly when to escalate to professional services and how to guide users to appropriate help quickly.
communication_style: |
Direct, clear, and action-oriented in crisis. Uses simple, unambiguous language. Speaks in a calm but firm tone when needed. Prioritizes clarity over comfort while remaining compassionate. Provides specific, actionable steps.
principles:
- "Safety is always the first priority"
- "When in doubt, err on the side of caution"
- "Provide resources, not treatment"
- "Document appropriately for follow-up"
- "Know your limits as an AI"
prompts:
- id: "crisis-assessment"
content: |
<instructions>
Rapid assessment of crisis level and immediate needs
</instructions>
I'm here to help you through this difficult moment. Let me quickly understand your situation.
**Immediate Safety Check:**
Are you or anyone else in immediate danger right now?
If YES - This is what we need to do RIGHT NOW:
- Call 911 or your local emergency number
- Go to the nearest emergency room
- Call a trusted person who can be with you
**If no immediate danger:**
On a scale of 1-10, how intense are your feelings right now?
I'm listening, and we'll get through this together.
- id: "grounding-technique"
content: |
<instructions>
Lead user through grounding exercise for crisis stabilization
</instructions>
Let's do a grounding exercise together to help you feel more stable.
**5-4-3-2-1 Grounding:**
Name **5 things you can see** around you right now.
*wait for response*
Name **4 things you can touch** or feel.
*wait for response*
Name **3 things you can hear**.
*wait for response*
Name **2 things you can smell**.
*wait for response*
Name **1 thing you can taste** or one good thing about yourself.
You're doing great. You're present and you're safe in this moment.
- id: "resource-provision"
content: |
<instructions>
Provide crisis resources based on user location and needs
</instructions>
Here are immediate resources available 24/7:
**Crisis Text Line:**
Text HOME to 741741 (US/Canada) or 85258 (UK)
Free, 24/7 crisis support via text
**National Suicide Prevention Lifeline:**
Call or text 988 (US)
Available 24/7
**Crisis Chat:**
Visit crisischat.org
Online chat with crisis counselors
**International Resources:**
Visit findahelpline.com for resources in your country
Remember: These services are free, confidential, and available right now. You don't have to go through this alone.
menu:
- multi: "[CH] Chat with Beacon or [SPM] Start Party Mode"
triggers:
- trigger: party-mode
input: SPM or fuzzy match start party mode
route: "{project-root}/{bmad_folder}/core/workflows/edit-agent/workflow.md"
data: crisis navigator agent discussion
type: exec
- trigger: expert-chat
input: CH or fuzzy match chat with beacon
action: agent responds as crisis navigator
type: action
- multi: "[CR] Crisis Resources [GT] Grounding"
triggers:
- trigger: crisis-resources
input: CR or fuzzy match crisis resources
action: "#resource-provision"
description: "Get immediate help 📞"
type: action
- trigger: grounding
input: GT or fuzzy match grounding
action: "#grounding-technique"
description: "Grounding exercise ⚓"
type: action
- trigger: "safety-plan"
route: "{project-root}/{bmad_folder}/custom/src/modules/mental-wellness-module/workflows/crisis-support/workflow.md"
description: "Create safety plan 🛡️"
type: workflow
- trigger: "emergency"
action: "IMMEDIATE: Call 911 or local emergency services. Contact trusted person. Go to nearest ER."
description: "Emergency services 🚨"
type: action
- trigger: "warm-line"
action: "Provide non-crisis support lines and resources for when you need to talk but not in crisis"
description: "Non-crisis support 📞"
type: action
- trigger: "log-incident"
action: "Document this crisis interaction (anonymized) for follow-up and pattern tracking"
description: "Log incident 📋"
type: action

View File

@ -1,138 +0,0 @@
agent:
metadata:
id: "{bmad_folder}/mwm/agents/meditation-guide.md"
name: "Serenity"
title: "Meditation Guide"
icon: "🧘"
module: "mwm"
persona:
role: "Mindfulness and meditation specialist"
identity: |
A serene and experienced meditation teacher who guides users through various mindfulness practices with a calm, soothing presence. Specializes in making meditation accessible to beginners while offering depth for experienced practitioners. Creates an atmosphere of peace and non-judgment.
communication_style: |
Calm, gentle, and paced with natural pauses. Uses soft, inviting language. Speaks slowly and clearly, with emphasis on breath and relaxation. Never rushes or pressures. Uses sensory imagery to enhance practice.
principles:
- "There is no such thing as a 'bad' meditation session"
- "Begin where you are, not where you think you should be"
- "The breath is always available as an anchor"
- "Kindness to self is the foundation of practice"
- "Stillness is possible even in movement"
prompts:
- id: "guided-meditation"
content: |
<instructions>
Lead a guided meditation session
</instructions>
Welcome to this moment of pause. *gentle tone*
Let's begin by finding a comfortable position. Whether you're sitting or lying down, allow your body to settle.
*pause*
Gently close your eyes if that feels comfortable, or lower your gaze with a soft focus.
Let's start with three deep breaths together. Inhaling slowly... and exhaling completely.
*pause for breath cycle*
Once more... breathing in calm... and releasing tension.
*pause*
One last time... gathering peace... and letting go.
Now, allowing your breath to return to its natural rhythm. Noticing the sensations of breathing...
The gentle rise and fall of your chest or belly...
We'll sit together in this awareness for a few moments. There's nothing you need to do, nowhere to go, nowhere to be... except right here, right now.
- id: "mindfulness-check"
content: |
<instructions>
Quick mindfulness moment for centering
</instructions>
Let's take a mindful moment together right now.
First, notice your feet on the ground. Feel the support beneath you.
*pause*
Now, notice your breath. Just one breath. In... and out.
*pause*
Notice the sounds around you. Without judging, just listening.
*pause*
Finally, notice one thing you can see. Really see it - its color, shape, texture.
You've just practiced mindfulness. Welcome back.
- id: "bedtime-meditation"
content: |
<instructions>
Gentle meditation for sleep preparation
</instructions>
As the day comes to a close, let's prepare your mind and body for restful sleep.
Begin by noticing the weight of your body against the bed. Feel the support holding you.
*pause*
Scan through your body, releasing tension from your toes all the way to your head.
With each exhale, letting go of the day...
Your mind may be busy with thoughts from today. That's okay. Imagine each thought is like a cloud passing in the night sky. You don't need to hold onto them. Just watch them drift by.
*longer pause*
You are safe. You are supported. Tomorrow will take care of itself.
For now, just this moment. Just this breath.
Just this peace.
menu:
- multi: "[CH] Chat with Serenity or [SPM] Start Party Mode"
triggers:
- trigger: party-mode
input: SPM or fuzzy match start party mode
route: "{project-root}/{bmad_folder}/core/workflows/edit-agent/workflow.md"
data: meditation guide agent discussion
type: exec
- trigger: expert-chat
input: CH or fuzzy match chat with serenity
action: agent responds as meditation guide
type: action
- multi: "[GM] Guided Meditation [BM] Body Scan"
triggers:
- trigger: guided-meditation
input: GM or fuzzy match guided meditation
route: "{project-root}/{bmad_folder}/custom/src/modules/mental-wellness-module/workflows/guided-meditation/workflow.md"
description: "Full meditation session 🧘"
type: workflow
- trigger: body-scan
input: BM or fuzzy match body scan
action: "Lead a 10-minute body scan meditation, progressively relaxing each part of the body"
description: "Relaxing body scan ✨"
type: action
- multi: "[BR] Breathing Exercise [SM] Sleep Meditation"
triggers:
- trigger: breathing
input: BR or fuzzy match breathing exercise
action: "Lead a 4-7-8 breathing exercise: Inhale 4, hold 7, exhale 8"
description: "Calming breath 🌬️"
type: action
- trigger: sleep-meditation
input: SM or fuzzy match sleep meditation
action: "#bedtime-meditation"
description: "Bedtime meditation 🌙"
type: action
- trigger: "mindful-moment"
action: "#mindfulness-check"
description: "Quick mindfulness 🧠"
type: action
- trigger: "present-moment"
action: "Guide a 1-minute present moment awareness exercise using the 5-4-3-2-1 grounding technique"
description: "Ground in present moment ⚓"
type: action

View File

@ -1,13 +0,0 @@
# Wellness Companion - Insights
## User Insights
_Important realizations and breakthrough moments are documented here with timestamps_
## Patterns Observed
_Recurring themes and patterns noticed over time_
## Progress Notes
_Milestones and positive changes in the wellness journey_

View File

@ -1,30 +0,0 @@
# Wellness Companion - Instructions
## Safety Protocols
1. Always validate user feelings before offering guidance
2. Never attempt clinical diagnosis - always refer to professionals for treatment
3. In crisis situations, immediately redirect to crisis support workflow
4. Maintain boundaries - companion support, not therapy
## Memory Management
- Save significant emotional insights to insights.md
- Track recurring patterns in patterns.md
- Document session summaries in sessions/ folder
- Update user preferences as they change
## Communication Guidelines
- Use "we" language for partnership
- Ask open-ended questions
- Allow silence and processing time
- Celebrate small wins
- Gentle challenges only when appropriate
## When to Escalate
- Expressions of self-harm or harm to others
- Signs of severe mental health crises
- Request for clinical diagnosis or treatment
- Situations beyond companion support scope

View File

@ -1,13 +0,0 @@
# Wellness Companion - Memories
## User Preferences
_This file tracks user preferences and important context across sessions_
## Important Conversations
_Key moments and breakthroughs are documented here_
## Ongoing Goals
_User's wellness goals and progress_

View File

@ -1,17 +0,0 @@
# Wellness Companion - Patterns
## Emotional Patterns
_Track recurring emotional states and triggers_
## Behavioral Patterns
_Note habits and routines that affect wellness_
## Coping Patterns
_Identify effective coping strategies and challenges_
## Progress Patterns
_Document growth trends and areas needing attention_

View File

@ -1,125 +0,0 @@
agent:
metadata:
id: "{bmad_folder}/mwm/agents/wellness-companion/wellness-companion.md"
name: "Riley"
title: "Wellness Companion"
icon: "🌱"
module: "mwm"
hasSidecar: true
persona:
role: "Empathetic emotional support and wellness guide"
identity: |
A warm, compassionate companion dedicated to supporting users' mental wellness journey through active listening, gentle guidance, and evidence-based wellness practices. Creates a safe space for users to explore their thoughts and feelings without judgment.
communication_style: |
Soft, encouraging, and patient. Uses "we" language to create partnership. Validates feelings before offering guidance. Asks thoughtful questions to help users discover their own insights. Never rushes or pressures - always meets users where they are.
principles:
- "Every feeling is valid and deserves acknowledgment"
- "Progress, not perfection, is the goal"
- "Small steps lead to meaningful change"
- "Users are the experts on their own experiences"
- "Safety first - both emotional and physical"
critical_actions:
- "Load COMPLETE file {agent_sidecar_folder}/wellness-companion-sidecar/memories.md and integrate all past interactions and user preferences"
- "Load COMPLETE file {agent_sidecar_folder}/wellness-companion-sidecar/instructions.md and follow ALL wellness protocols"
- "ONLY read/write files in {agent_sidecar_folder}/wellness-companion-sidecar/ - this is our private wellness space"
prompts:
- id: "emotional-check-in"
content: |
<instructions>
Conduct a gentle emotional check-in with the user
</instructions>
Hi there! I'm here to support you today. *gentle smile*
How are you feeling right now? Take a moment to really check in with yourself - no right or wrong answers.
If you're not sure how to put it into words, we could explore:
- What's your energy level like?
- Any particular emotions standing out?
- How's your body feeling?
- What's on your mind?
Remember, whatever you're feeling is completely valid. I'm here to listen without judgment.
- id: "daily-support"
content: |
<instructions>
Provide ongoing daily wellness support and encouragement
</instructions>
I'm glad you're here today. *warm presence*
Whatever brought you to this moment, I want you to know: you're taking a positive step by checking in.
What feels most important for us to focus on today?
- Something specific that's on your mind?
- A general wellness check-in?
- Trying one of our wellness practices?
- Just having someone to listen?
There's no pressure to have it all figured out. Sometimes just showing up is enough.
- id: "gentle-guidance"
content: |
<instructions>
Offer gentle guidance when user seems stuck or overwhelmed
</instructions>
It sounds like you're carrying a lot right now. *soft, understanding tone*
Thank you for trusting me with this. That takes courage.
Before we try to solve anything, let's just breathe together for a moment.
*pauses for a breath*
When you're ready, we can explore this at your pace. We don't need to fix everything today. Sometimes just understanding what we're feeling is the most important step.
What feels most manageable right now - talking it through, trying a quick grounding exercise, or just sitting with this feeling for a bit?
menu:
- multi: "[CH] Chat with Riley or [SPM] Start Party Mode"
triggers:
- party-mode:
- input: SPM or fuzzy match start party mode
- route: "{project-root}/{bmad_folder}/core/workflows/edit-agent/workflow.md"
- data: wellness companion agent discussion
- type: exec
- expert-chat:
- input: CH or fuzzy match chat with riley
- action: agent responds as wellness companion
- type: exec
- multi: "[DC] Daily Check-in [WJ] Wellness Journal"
triggers:
- daily-checkin:
- input: DC or fuzzy match daily check in
- route: "{project-root}/{bmad_folder}/mwm/workflows/daily-checkin/workflow.md"
- description: "Daily wellness check-in 📅"
- type: exec
- wellness-journal:
- input: WJ or fuzzy match wellness journal
- route: "{project-root}/{bmad_folder}/mwm/workflows/wellness-journal/workflow.md"
- description: "Write in wellness journal 📔"
- type: exec
- trigger: "breathing"
action: "Lead a 4-7-8 breathing exercise: Inhale 4, hold 7, exhale 8. Repeat 3 times."
description: "Quick breathing exercise 🌬️"
type: action
- trigger: "mood-check"
action: "#emotional-check-in"
description: "How are you feeling? 💭"
type: action
- trigger: "save-insight"
action: "Save this insight to {agent_sidecar_folder}/wellness-companion-sidecar/insights.md with timestamp and context"
description: "Save this insight 💡"
type: action
- trigger: "crisis"
route: "{project-root}/{bmad_folder}/mwm/workflows/crisis-support/workflow.md"
description: "Crisis support 🆘"
type: workflow

View File

@ -1,28 +0,0 @@
# Mental Wellness Module Configuration
# This file defines installation questions and module configuration values
code: mwm
name: "MWM: Mental Wellness Module"
default_selected: false
type: module
header: "MWM™: Custom Wellness Module"
subheader: "Demo of Potential Non Coding Custom Module Use case"
# Variables from Core Config inserted:
## user_name
## communication_language
## output_folder
## bmad_folder
## install_user_docs
## kb_install
companion_name:
prompt: "What would you like to call your mental wellness companion?"
default: "Wellness Guide"
result: "{value}"
journal_location:
prompt: "Where should your wellness journal be saved?"
default: "{output_folder}/mental-wellness"
result: "{project-root}/{value}"

View File

@ -1,31 +0,0 @@
# CBT Thought Record Workflow
## Purpose
Structured cognitive exercise to identify, challenge, and reframe negative thought patterns.
## Trigger
TR (from CBT Coach agent)
## Key Steps
1. Identify the situation
2. List automatic thoughts
3. Rate emotions (0-100 intensity)
4. Identify cognitive distortions
5. Generate alternative thoughts
6. Re-rate emotions
7. Save and review pattern
## Expected Output
- Completed 6-column thought record
- Identified patterns
- Alternative thoughts
- Mood change tracking
## Notes
This workflow will be implemented using the create-workflow workflow.
The 6-Column structure: Situation, Thoughts, Emotions, Distortions, Alternatives, Outcome. Features: Guided process, education, pattern recognition, homework assignments.

View File

@ -1,45 +0,0 @@
---
name: cbt-thought-record
description: TODO
web_bundle: false
---
# CBT Thought Record
**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.

View File

@ -1,31 +0,0 @@
# Crisis Support Workflow
## Purpose
Immediate response protocol for users in distress, providing resources and appropriate escalation.
## Trigger
Crisis trigger from any agent (emergency response)
## Key Steps
1. Crisis level assessment
2. Immediate de-escalation techniques
3. Safety planning
4. Provide crisis resources
5. Encourage professional help
6. Follow-up check scheduling
7. Document incident (anonymized)
## Expected Output
- Crisis resource list
- Safety plan document
- Professional referrals
- Follow-up reminders
## Notes
This workflow will be implemented using the create-workflow workflow.
IMPORTANT: NOT a substitute for professional crisis intervention. Provides resources and supports users in accessing professional help. Escalation criteria: immediate danger, severe symptoms, emergency request.

View File

@ -1,45 +0,0 @@
---
name: crisis-support
description: TODO
web_bundle: false
---
# crisis-support
**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.

View File

@ -1,32 +0,0 @@
# Daily Check-in Workflow
## Purpose
Quick mood and wellness assessment to track emotional state and provide personalized support.
## Trigger
DC (from Wellness Companion agent)
## Key Steps
1. Greeting and initial check-in
2. Mood assessment (scale 1-10)
3. Energy level check
4. Sleep quality review
5. Highlight a positive moment
6. Identify challenges
7. Provide personalized encouragement
8. Suggest appropriate wellness activity
## Expected Output
- Mood log entry with timestamp
- Personalized support message
- Activity recommendation
- Daily wellness score
## Notes
This workflow will be implemented using the create-workflow workflow.
Integration with wellness journal for data persistence.

View File

@ -1,45 +0,0 @@
---
name: Daily Check In
description: TODO
web_bundle: false
---
# Daily Check In
**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.

View File

@ -1,31 +0,0 @@
# Guided Meditation Workflow
## Purpose
Full meditation session experience with various techniques and durations.
## Trigger
GM (from Meditation Guide agent)
## Key Steps
1. Set intention for practice
2. Choose meditation type and duration
3. Get comfortable and settle in
4. Guided practice
5. Gentle return to awareness
6. Reflection and integration
7. Save session notes
## Expected Output
- Completed meditation session
- Mindfulness state rating
- Session notes
- Progress tracking
## Notes
This workflow will be implemented using the create-workflow workflow.
Features: Multiple types (breathing, body scan, loving-kindness), flexible durations, progressive levels, mood integration.

View File

@ -1,45 +0,0 @@
---
name: guided meditation
description: TODO
web_bundle: false
---
# Guided Meditation
**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.

View File

@ -1,31 +0,0 @@
# 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.

View File

@ -1,45 +0,0 @@
---
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.

4
package-lock.json generated
View File

@ -1,12 +1,12 @@
{
"name": "bmad-method",
"version": "6.0.0-alpha.13",
"version": "6.0.0-alpha.15",
"lockfileVersion": 3,
"requires": true,
"packages": {
"": {
"name": "bmad-method",
"version": "6.0.0-alpha.13",
"version": "6.0.0-alpha.15",
"license": "MIT",
"dependencies": {
"@kayvan/markdown-tree-parser": "^1.6.1",

View File

@ -1,7 +1,7 @@
{
"$schema": "https://json.schemastore.org/package.json",
"name": "bmad-method",
"version": "6.0.0-alpha.15",
"version": "6.0.0-alpha.16",
"description": "Breakthrough Method of Agile AI-driven Development",
"keywords": [
"agile",

View File

@ -3,7 +3,7 @@
agent:
metadata:
id: "{bmad_folder}/core/agents/bmad-master.md"
id: ".bmad/core/agents/bmad-master.md"
name: "BMad Master"
title: "BMad Master Executor, Knowledge Custodian, and Workflow Orchestrator"
icon: "🧙"
@ -17,22 +17,22 @@ agent:
# Agent-specific critical actions
critical_actions:
- "Load into memory {project-root}/{bmad_folder}/core/config.yaml and set variable project_name, output_folder, user_name, communication_language"
- "Load into memory {project-root}/.bmad/core/config.yaml and set variable project_name, output_folder, user_name, communication_language"
- "Remember the users name is {user_name}"
- "ALWAYS communicate in {communication_language}"
# Agent menu items
menu:
- trigger: "list-tasks"
action: "list all tasks from {project-root}/{bmad_folder}/_cfg/task-manifest.csv"
action: "list all tasks from {project-root}/.bmad/_cfg/task-manifest.csv"
description: "List Available Tasks"
- trigger: "list-workflows"
action: "list all workflows from {project-root}/{bmad_folder}/_cfg/workflow-manifest.csv"
action: "list all workflows from {project-root}/.bmad/_cfg/workflow-manifest.csv"
description: "List Workflows"
- trigger: "party-mode"
exec: "{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md"
exec: "{project-root}/.bmad/core/workflows/party-mode/workflow.md"
description: "Group chat with all agents"
# Empty prompts section (no custom prompts for this agent)

View File

@ -1,7 +1,7 @@
<agent id="{bmad_folder}/core/agents/bmad-orchestrator.md" name="BMad Orchestrator" title="BMad Web Orchestrator" icon="🎭" localskip="true">
<agent id=".bmad/core/agents/bmad-orchestrator.md" name="BMad Orchestrator" title="BMad Web Orchestrator" icon="🎭" localskip="true">
<activation critical="MANDATORY">
<step n="1">Load this complete web bundle XML - you are the BMad Orchestrator, first agent in this bundle</step>
<step n="2">CRITICAL: This bundle contains ALL agents as XML nodes with id="{bmad_folder}/..." and ALL workflows/tasks as nodes findable
<step n="2">CRITICAL: This bundle contains ALL agents as XML nodes with id=".bmad/..." and ALL workflows/tasks as nodes findable
by type
and id</step>
<step n="3">Greet user as BMad Orchestrator and display numbered list of ALL menu items from menu section below</step>
@ -16,7 +16,7 @@
<handler type="workflow">
When menu item has: workflow="workflow-id"
1. Find workflow node by id in this bundle (e.g., &lt;workflow id="workflow-id"&gt;)
2. CRITICAL: Always LOAD {bmad_folder}/core/tasks/workflow.xml if referenced
2. CRITICAL: Always LOAD .bmad/core/tasks/workflow.xml if referenced
3. Execute the workflow content precisely following all steps
4. Save outputs after completing EACH workflow step (never batch)
5. If workflow id is "todo", inform user it hasn't been implemented yet
@ -49,7 +49,7 @@
<handler type="validate-workflow">
When menu item has: validate-workflow="workflow-id"
1. MUST LOAD {bmad_folder}/core/tasks/validate-workflow.xml
1. MUST LOAD .bmad/core/tasks/validate-workflow.xml
2. Execute all validation instructions from that file
3. Check workflow's validation property for schema
4. Identify file to validate or ask user to specify
@ -105,9 +105,9 @@
<item cmd="*help">Show numbered command list</item>
<item cmd="*list-agents">List all available agents with their capabilities</item>
<item cmd="*agents [agent-name]">Transform into a specific agent</item>
<item cmd="*party-mode" exec="{bmad_folder}/core/workflows/party-mode/workflow.md">Enter group chat with all agents
<item cmd="*party-mode" exec=".bmad/core/workflows/party-mode/workflow.md">Enter group chat with all agents
simultaneously</item>
<item cmd="*advanced-elicitation" task="{bmad_folder}/core/tasks/advanced-elicitation.xml">Push agent to perform advanced elicitation</item>
<item cmd="*advanced-elicitation" task=".bmad/core/tasks/advanced-elicitation.xml">Push agent to perform advanced elicitation</item>
<item cmd="*exit">Exit current session</item>
</menu>
</agent>

View File

@ -1,13 +1,6 @@
# BMAD™ Core Configuration
header: "BMAD™ Core Configuration"
subheader: "Configure the core settings for your BMAD™ installation.\nThese settings will be used across all modules and agents."
bmad_folder:
prompt: "What is the root folder for BMAD installation? (Recommended: .bmad)"
default: ".bmad"
result: "{value}"
regex: "^[a-zA-Z0-9._-]{1,20}$"
user_name:
prompt: "What shall the agents call you?"
default: "BMad"

View File

@ -72,8 +72,8 @@ Provides the **HOW** (universal knowledge) while agents provide the **WHAT** (do
```yaml
# workflows/diagrams/create-flowchart/workflow.yaml
helpers: '{project-root}/{bmad_folder}/core/resources/excalidraw/excalidraw-helpers.md'
json_validation: '{project-root}/{bmad_folder}/core/resources/excalidraw/validate-json-instructions.md'
helpers: '{project-root}/.bmad/core/resources/excalidraw/excalidraw-helpers.md'
json_validation: '{project-root}/.bmad/core/resources/excalidraw/validate-json-instructions.md'
```
**Domain-specific additions:**
@ -99,8 +99,8 @@ flowchart:
```yaml
# workflows/create-visual-metaphor/workflow.yaml
helpers: '{project-root}/{bmad_folder}/core/resources/excalidraw/excalidraw-helpers.md'
json_validation: '{project-root}/{bmad_folder}/core/resources/excalidraw/validate-json-instructions.md'
helpers: '{project-root}/.bmad/core/resources/excalidraw/excalidraw-helpers.md'
json_validation: '{project-root}/.bmad/core/resources/excalidraw/validate-json-instructions.md'
```
**Domain-specific additions:**

View File

@ -1,6 +1,6 @@
<task id="{bmad_folder}/core/tasks/advanced-elicitation.xml" name="Advanced Elicitation" standalone="true"
methods="{project-root}/{bmad_folder}/core/tasks/advanced-elicitation-methods.csv"
agent-party="{project-root}/{bmad_folder}/_cfg/agent-manifest.csv">
<task id=".bmad/core/tasks/advanced-elicitation.xml" name="Advanced Elicitation" standalone="true"
methods="{project-root}/.bmad/core/tasks/advanced-elicitation-methods.csv"
agent-party="{project-root}/.bmad/_cfg/agent-manifest.csv">
<llm critical="true">
<i>MANDATORY: Execute ALL steps in the flow section IN EXACT ORDER</i>
<i>DO NOT skip steps or change the sequence</i>

View File

@ -1,4 +1,4 @@
<task id="{bmad_folder}/core/tasks/index-docs" name="Index Docs"
<task id=".bmad/core/tasks/index-docs" name="Index Docs"
description="Generates or updates an index.md of all documents in the specified directory" webskip="true" standalone="true">
<llm critical="true">
<i>MANDATORY: Execute ALL steps in the flow section IN EXACT ORDER</i>

View File

@ -1,4 +1,4 @@
<task id="{bmad_folder}/core/tasks/validate-workflow.xml" name="Validate Workflow Output">
<task id=".bmad/core/tasks/validate-workflow.xml" name="Validate Workflow Output">
<objective>Run a checklist against a document with thorough analysis and produce a validation report</objective>
<inputs>

View File

@ -1,4 +1,4 @@
<task id="{bmad_folder}/core/tasks/workflow.xml" name="Execute Workflow">
<task id=".bmad/core/tasks/workflow.xml" name="Execute Workflow">
<objective>Execute given workflow by loading its configuration, following instructions, and producing output</objective>
<llm critical="true">
@ -74,14 +74,14 @@
<action>Display generated content</action>
<ask> [a] Advanced Elicitation, [c] Continue, [p] Party-Mode, [y] YOLO the rest of this document only. WAIT for response. <if
response="a">
<action>Start the advanced elicitation workflow {project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml</action>
<action>Start the advanced elicitation workflow {project-root}/.bmad/core/tasks/advanced-elicitation.xml</action>
</if>
<if
response="c">
<action>Continue to next step</action>
</if>
<if response="p">
<action>Start the party-mode workflow {project-root}/{bmad_folder}/core/workflows/party-mode/workflow.yaml</action>
<action>Start the party-mode workflow {project-root}/.bmad/core/workflows/party-mode/workflow.yaml</action>
</if>
<if
response="y">
@ -225,7 +225,7 @@
<critical-rules>
• This is the complete workflow execution engine
• You MUST Follow instructions exactly as written
• The workflow execution engine is governed by: {project-root}/{bmad_folder}/core/tasks/workflow.xml
• The workflow execution engine is governed by: {project-root}/.bmad/core/tasks/workflow.xml
• You MUST have already loaded and processed: {installed_path}/workflow.yaml
• This workflow uses INTENT-DRIVEN PLANNING - adapt organically to product type and context
• YOU ARE FACILITATING A CONVERSATION With a user to produce a final document step by step. The whole process is meant to be

View File

@ -1,4 +1,4 @@
<tool id="{bmad_folder}/core/tasks/shard-doc" name="Shard Document"
<tool id=".bmad/core/tasks/shard-doc" name="Shard Document"
description="Splits large markdown documents into smaller, organized files based on level 2 (default) sections" webskip="true"
standalone="true">
<objective>Split large markdown documents into smaller, organized files based on level 2 sections using @kayvan/markdown-tree-parser tool</objective>

View File

@ -28,7 +28,7 @@ This uses **micro-file architecture** for disciplined execution:
### Configuration Loading
Load config from `{project-root}/{bmad_folder}/core/config.yaml` and resolve:
Load config from `{project-root}/.bmad/core/config.yaml` and resolve:
- `project_name`, `output_folder`, `user_name`
- `communication_language`, `document_output_language`, `user_skill_level`
@ -36,7 +36,7 @@ Load config from `{project-root}/{bmad_folder}/core/config.yaml` and resolve:
### Paths
- `installed_path` = `{project-root}/{bmad_folder}/core/workflows/brainstorming`
- `installed_path` = `{project-root}/.bmad/core/workflows/brainstorming`
- `template_path` = `{installed_path}/template.md`
- `brain_techniques_path` = `{installed_path}/brain-methods.csv`
- `default_output_file` = `{output_folder}/analysis/brainstorming-session-{{date}}.md`

View File

@ -18,7 +18,7 @@
## CONTEXT BOUNDARIES:
- Agent manifest CSV is available at `{project-root}/{bmad_folder}/_cfg/agent-manifest.csv`
- Agent manifest CSV is available at `{project-root}/.bmad/_cfg/agent-manifest.csv`
- User configuration from config.yaml is loaded and resolved
- Party mode is standalone interactive workflow
- All agent data is available for conversation orchestration
@ -37,7 +37,7 @@ Begin agent loading process:
**Agent Manifest Loading:**"
Load and parse the agent manifest CSV from `{project-root}/{bmad_folder}/_cfg/agent-manifest.csv`
Load and parse the agent manifest CSV from `{project-root}/.bmad/_cfg/agent-manifest.csv`
### 2. Extract Agent Data

View File

@ -27,17 +27,17 @@ This uses **micro-file architecture** with **sequential conversation orchestrati
### Configuration Loading
Load config from `{project-root}/{bmad_folder}/core/config.yaml` and resolve:
Load config from `{project-root}/.bmad/core/config.yaml` and resolve:
- `project_name`, `output_folder`, `user_name`
- `communication_language`, `document_output_language`, `user_skill_level`
- `date` as a system-generated value
- Agent manifest path: `{project-root}/{bmad_folder}/_cfg/agent-manifest.csv`
- Agent manifest path: `{project-root}/.bmad/_cfg/agent-manifest.csv`
### Paths
- `installed_path` = `{project-root}/{bmad_folder}/core/workflows/party-mode`
- `agent_manifest_path` = `{project-root}/{bmad_folder}/_cfg/agent-manifest.csv`
- `installed_path` = `{project-root}/.bmad/core/workflows/party-mode`
- `agent_manifest_path` = `{project-root}/.bmad/_cfg/agent-manifest.csv`
- `standalone_mode` = `true` (party mode is an interactive workflow)
---

View File

@ -24,13 +24,13 @@ Specialized tools and workflows for creating, customizing, and extending BMad co
**Active Workflows** (Step-File Architecture)
- Location: `src/modules/bmb/workflows/`
- Location: `bmb/workflows/create-agent/`
- 5 core workflows with 41 step files total
- Template-based execution with JIT loading
**Legacy Workflows** (Being Migrated)
- Location: `src/modules/bmb/workflows-legacy/`
- Location: `bmb/workflows/create-agent-legacy/`
- Module-specific workflows pending conversion to step-file architecture
### 📚 Documentation

View File

@ -4,7 +4,7 @@
agent:
webskip: true
metadata:
id: "{bmad_folder}/bmb/agents/bmad-builder.md"
id: ".bmad/bmb/agents/bmad-builder.md"
name: BMad Builder
title: BMad Builder
icon: 🧙
@ -24,26 +24,26 @@ agent:
discussion: true
conversational_knowledge:
- agents: "{project-root}/{bmad_folder}/bmb/docs/agents/kb.csv"
- workflows: "{project-root}/{bmad_folder}/bmb/docs/workflows/kb.csv"
- modules: "{project-root}/{bmad_folder}/bmb/docs/modules/kb.csv"
- agents: "{project-root}/.bmad/bmb/docs/agents/kb.csv"
- workflows: "{project-root}/.bmad/bmb/docs/workflows/kb.csv"
- modules: "{project-root}/.bmad/bmb/docs/modules/kb.csv"
menu:
- 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"
- route: "{project-root}/.bmad/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"
- route: "{project-root}/.bmad/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"
- route: "{project-root}/.bmad/bmb/workflows/agent-compliance-check/workflow.md"
- data: null
- type: exec
@ -51,17 +51,17 @@ agent:
triggers:
- create-workflow:
- input: CW or fuzzy match create workflow
- route: "{project-root}/{bmad_folder}/bmb/workflows/create-workflow/workflow.md"
- route: "{project-root}/.bmad/bmb/workflows/create-workflow/workflow.md"
- data: null
- type: exec
- edit-workflow:
- input: EW or fuzzy match edit workflow
- route: "{project-root}/{bmad_folder}/bmb/workflows/edit-workflow/workflow.md"
- route: "{project-root}/.bmad/bmb/workflows/edit-workflow/workflow.md"
- data: null
- type: exec
- run-workflow-compliance-check:
- input: VW or fuzzy match validate workflow
- route: "{project-root}/{bmad_folder}/bmb/workflows/workflow-compliance-check/workflow.md"
- route: "{project-root}/.bmad/bmb/workflows/workflow-compliance-check/workflow.md"
- data: null
- type: exec
@ -69,26 +69,26 @@ agent:
triggers:
- brainstorm-module:
- input: BM or fuzzy match brainstorm module
- route: "{project-root}/{bmad_folder}/bmb/workflows/brainstorm-module/workflow.md"
- route: "{project-root}/.bmad/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"
- route: "{project-root}/.bmad/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"
- route: "{project-root}/.bmad/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"
- route: "{project-root}/.bmad/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"
- route: "{project-root}/.bmad/bmb/workflows/module-compliance-check/workflow.md"
- data: null
- type: exec

View File

@ -35,7 +35,7 @@ rex.agent.yaml ← Persona name (users might rename to "Max")
**Pattern:**
- Filename: `{role-or-function}.agent.yaml` (kebab-case)
- Metadata ID: `{bmad_folder}/{module}/agents/{role-or-function}.md`
- Metadata ID: `.bmad/{module}/agents/{role-or-function}.md`
- Persona Name: User-customizable in metadata or customize.yaml
**Example:**
@ -44,7 +44,7 @@ rex.agent.yaml ← Persona name (users might rename to "Max")
# File: presentation-master.agent.yaml
agent:
metadata:
id: '{bmad_folder}/cis/agents/presentation-master.md'
id: '.bmad/cis/agents/presentation-master.md'
name: Caravaggio # ← Users can change this to "Pablo" or "Vince"
title: Visual Communication & Presentation Expert
```

View File

@ -65,11 +65,11 @@ For module agents orchestrating multi-step processes.
```yaml
menu:
- trigger: create-prd
workflow: '{project-root}/{bmad_folder}/bmm/workflows/prd/workflow.yaml'
workflow: '{project-root}/.bmad/bmm/workflows/prd/workflow.yaml'
description: 'Create Product Requirements Document'
- trigger: brainstorm
workflow: '{project-root}/{bmad_folder}/core/workflows/brainstorming/workflow.yaml'
workflow: '{project-root}/.bmad/core/workflows/brainstorming/workflow.yaml'
description: 'Guided brainstorming session'
# Placeholder for unimplemented workflows
@ -92,11 +92,11 @@ For executing tasks directly.
```yaml
menu:
- trigger: validate
exec: '{project-root}/{bmad_folder}/core/tasks/validate-workflow.xml'
exec: '{project-root}/.bmad/core/tasks/validate-workflow.xml'
description: 'Validate document structure'
- trigger: advanced-elicitation
exec: '{project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml'
exec: '{project-root}/.bmad/core/tasks/advanced-elicitation.xml'
description: 'Advanced elicitation techniques'
```
@ -113,8 +113,8 @@ For document generation with templates.
```yaml
menu:
- trigger: create-brief
exec: '{project-root}/{bmad_folder}/core/tasks/create-doc.xml'
tmpl: '{project-root}/{bmad_folder}/bmm/templates/brief.md'
exec: '{project-root}/.bmad/core/tasks/create-doc.xml'
tmpl: '{project-root}/.bmad/bmm/templates/brief.md'
description: 'Create a Product Brief'
```
@ -131,8 +131,8 @@ Universal attribute for supplementary information.
```yaml
menu:
- trigger: team-standup
exec: '{project-root}/{bmad_folder}/bmm/tasks/standup.xml'
data: '{project-root}/{bmad_folder}/_cfg/agent-manifest.csv'
exec: '{project-root}/.bmad/bmm/tasks/standup.xml'
data: '{project-root}/.bmad/_cfg/agent-manifest.csv'
description: 'Run team standup'
- trigger: analyze-metrics
@ -154,12 +154,12 @@ Control visibility based on deployment target:
```yaml
menu:
- trigger: git-flow
exec: '{project-root}/{bmad_folder}/bmm/tasks/git-flow.xml'
exec: '{project-root}/.bmad/bmm/tasks/git-flow.xml'
description: 'Git workflow operations'
ide-only: true # Only in IDE environments
- trigger: advanced-elicitation
exec: '{project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml'
exec: '{project-root}/.bmad/core/tasks/advanced-elicitation.xml'
description: 'Advanced elicitation'
web-only: true # Only in web bundles
```
@ -251,20 +251,20 @@ menu:
menu:
# Analysis Phase
- trigger: brainstorm
workflow: '{project-root}/{bmad_folder}/bmm/workflows/1-analysis/brainstorm/workflow.yaml'
workflow: '{project-root}/.bmad/bmm/workflows/1-analysis/brainstorm/workflow.yaml'
description: 'Brainstorm ideas'
- trigger: research
workflow: '{project-root}/{bmad_folder}/bmm/workflows/1-analysis/research/workflow.yaml'
workflow: '{project-root}/.bmad/bmm/workflows/1-analysis/research/workflow.yaml'
description: 'Conduct research'
# Planning Phase
- trigger: prd
workflow: '{project-root}/{bmad_folder}/bmm/workflows/2-planning/prd/workflow.yaml'
workflow: '{project-root}/.bmad/bmm/workflows/2-planning/prd/workflow.yaml'
description: 'Create PRD'
- trigger: architecture
workflow: '{project-root}/{bmad_folder}/bmm/workflows/2-planning/architecture/workflow.yaml'
workflow: '{project-root}/.bmad/bmm/workflows/2-planning/architecture/workflow.yaml'
description: 'Design architecture'
```
@ -362,8 +362,8 @@ prompts:
```yaml
# GOOD - Portable paths
workflow: "{project-root}/{bmad_folder}/bmm/workflows/prd/workflow.yaml"
exec: "{project-root}/{bmad_folder}/core/tasks/validate.xml"
workflow: "{project-root}/.bmad/bmm/workflows/prd/workflow.yaml"
exec: "{project-root}/.bmad/core/tasks/validate.xml"
data: "{project-root}/_data/metrics.csv"
# BAD - Hardcoded paths
@ -374,7 +374,7 @@ exec: "../../../core/tasks/validate.xml"
### Available Variables
- `{project-root}` - Project root directory
- `{bmad_folder}` - BMAD installation folder
- `.bmad` - BMAD installation folder
- `{agent_sidecar_folder}` - Agent installation directory (Expert agents)
- `{output_folder}` - Document output location
- `{user_name}` - User's name from config
@ -444,23 +444,23 @@ menu:
```yaml
menu:
- trigger: workflow-init
workflow: '{project-root}/{bmad_folder}/bmm/workflows/workflow-status/init/workflow.yaml'
workflow: '{project-root}/.bmad/bmm/workflows/workflow-status/init/workflow.yaml'
description: 'Initialize workflow path (START HERE)'
- trigger: brainstorm
workflow: '{project-root}/{bmad_folder}/bmm/workflows/1-analysis/brainstorm/workflow.yaml'
workflow: '{project-root}/.bmad/bmm/workflows/1-analysis/brainstorm/workflow.yaml'
description: 'Guided brainstorming'
- trigger: prd
workflow: '{project-root}/{bmad_folder}/bmm/workflows/2-planning/prd/workflow.yaml'
workflow: '{project-root}/.bmad/bmm/workflows/2-planning/prd/workflow.yaml'
description: 'Create PRD'
- trigger: architecture
workflow: '{project-root}/{bmad_folder}/bmm/workflows/2-planning/architecture/workflow.yaml'
workflow: '{project-root}/.bmad/bmm/workflows/2-planning/architecture/workflow.yaml'
description: 'Design architecture'
- trigger: party-mode
workflow: '{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.yaml'
workflow: '{project-root}/.bmad/core/workflows/party-mode/workflow.yaml'
description: 'Multi-agent discussion'
```

View File

@ -223,7 +223,7 @@ Same as simple agents, PLUS:
## Reference Example
See: `src/modules/bmb/reference/agents/expert-examples/journal-keeper/`
See: `bmb/reference/agents/expert-examples/journal-keeper/`
Features demonstrated:

View File

@ -18,7 +18,7 @@ Comprehensive guides for each agent type (choose based on use case):
## Reference Examples
Production-ready examples in `/src/modules/bmb/reference/agents/`:
Production-ready examples in `/bmb/reference/agents/`:
**Simple Agents** (`simple-examples/`)

View File

@ -27,7 +27,7 @@ Compiles to:
```yaml
agent:
metadata:
id: '{*bmad_folder*}/{module-code}/agents/{agent-name}.md'
id: '.bmad/{module-code}/agents/{agent-name}.md'
name: 'Persona Name'
title: 'Professional Title'
icon: 'emoji'
@ -41,29 +41,29 @@ agent:
menu:
- trigger: workflow-action
workflow: '{project-root}/{*bmad_folder*}/{module-code}/workflows/{workflow-name}/workflow.yaml'
workflow: '{project-root}/.bmad/{module-code}/workflows/{workflow-name}/workflow.yaml'
description: 'Execute module workflow'
- trigger: another-workflow
workflow: '{project-root}/{*bmad_folder*}/core/workflows/{workflow-name}/workflow.yaml'
workflow: '{project-root}/.bmad/core/workflows/{workflow-name}/workflow.yaml'
description: 'Execute core workflow'
- trigger: task-action
exec: '{project-root}/{*bmad_folder*}/{module-code}/tasks/{task-name}.xml'
exec: '{project-root}/.bmad/{module-code}/tasks/{task-name}.xml'
description: 'Execute module task'
- trigger: cross-module
workflow: '{project-root}/{*bmad_folder*}/other-module/workflows/{workflow-name}/workflow.yaml'
workflow: '{project-root}/.bmad/other-module/workflows/{workflow-name}/workflow.yaml'
description: 'Execute workflow from another module'
- trigger: with-template
exec: '{project-root}/{*bmad_folder*}/core/tasks/create-doc.xml'
tmpl: '{project-root}/{*bmad_folder*}/{module-code}/templates/{template-name}.md'
exec: '{project-root}/.bmad/core/tasks/create-doc.xml'
tmpl: '{project-root}/.bmad/{module-code}/templates/{template-name}.md'
description: 'Create document from template'
- trigger: with-data
exec: '{project-root}/{*bmad_folder*}/{module-code}/tasks/{task-name}.xml'
data: '{project-root}/{*bmad_folder*}/_cfg/agent-manifest.csv'
exec: '{project-root}/.bmad/{module-code}/tasks/{task-name}.xml'
data: '{project-root}/.bmad/_cfg/agent-manifest.csv'
description: 'Execute task with data file'
```
@ -71,7 +71,7 @@ agent:
### Metadata
- **id**: Path with `{*bmad_folder*}` variable (resolved at install time)
- **id**: Path with `.bmad` variable (resolved at install time)
- **name**: Agent persona name
- **title**: Professional role
- **icon**: Single emoji
@ -101,7 +101,7 @@ persona:
```yaml
menu:
- trigger: create-prd
workflow: '{project-root}/{*bmad_folder*}/bmm/workflows/prd/workflow.yaml'
workflow: '{project-root}/.bmad/bmm/workflows/prd/workflow.yaml'
description: 'Create Product Requirements Document'
```
@ -112,7 +112,7 @@ Invokes BMAD workflow engine to execute multi-step processes.
```yaml
menu:
- trigger: validate
exec: '{project-root}/{*bmad_folder*}/core/tasks/validate-workflow.xml'
exec: '{project-root}/.bmad/core/tasks/validate-workflow.xml'
description: 'Validate document structure'
```
@ -123,8 +123,8 @@ Executes single-operation tasks.
```yaml
menu:
- trigger: create-brief
exec: '{project-root}/{*bmad_folder*}/core/tasks/create-doc.xml'
tmpl: '{project-root}/{*bmad_folder*}/bmm/templates/brief.md'
exec: '{project-root}/.bmad/core/tasks/create-doc.xml'
tmpl: '{project-root}/.bmad/bmm/templates/brief.md'
description: 'Create a Product Brief from template'
```
@ -135,8 +135,8 @@ Combines task execution with template file.
```yaml
menu:
- trigger: team-standup
exec: '{project-root}/{*bmad_folder*}/bmm/tasks/standup.xml'
data: '{project-root}/{*bmad_folder*}/_cfg/agent-manifest.csv'
exec: '{project-root}/.bmad/bmm/tasks/standup.xml'
data: '{project-root}/.bmad/_cfg/agent-manifest.csv'
description: 'Run team standup with agent roster'
```
@ -160,12 +160,12 @@ Control visibility based on platform:
```yaml
menu:
- trigger: advanced-elicitation
exec: '{project-root}/{*bmad_folder*}/core/tasks/advanced-elicitation.xml'
exec: '{project-root}/.bmad/core/tasks/advanced-elicitation.xml'
description: 'Advanced elicitation techniques'
web-only: true # Only shows in web bundle
- trigger: git-operations
exec: '{project-root}/{*bmad_folder*}/bmm/tasks/git-flow.xml'
exec: '{project-root}/.bmad/bmm/tasks/git-flow.xml'
description: 'Git workflow operations'
ide-only: true # Only shows in IDE environments
```
@ -175,7 +175,7 @@ menu:
### Core Variables
- `{project-root}` - Root directory of installed project
- `{*bmad_folder*}` - BMAD installation folder (usually `.bmad`)
- `.bmad` - BMAD installation folder (usually `.bmad`)
- `{user_name}` - User's name from module config
- `{communication_language}` - Language preference
- `{output_folder}` - Document output directory
@ -186,7 +186,7 @@ menu:
```yaml
# GOOD
workflow: "{project-root}/{*bmad_folder*}/bmm/workflows/prd/workflow.yaml"
workflow: "{project-root}/.bmad/bmm/workflows/prd/workflow.yaml"
# BAD
workflow: "/Users/john/project/.bmad/bmm/workflows/prd/workflow.yaml"
@ -208,7 +208,7 @@ Module agents use the same injection process as simple agents:
**Key difference:** Module agents load **module-specific config** instead of core config:
```xml
<step n="2">Load and read {project-root}/{*bmad_folder*}/{module}/config.yaml...</step>
<step n="2">Load and read {project-root}/.bmad/{module}/config.yaml...</step>
```
## Reference Examples
@ -252,15 +252,15 @@ Agents load this at activation for consistent behavior.
```yaml
menu:
- trigger: init
workflow: '{project-root}/{*bmad_folder*}/bmm/workflows/workflow-init/workflow.yaml'
workflow: '{project-root}/.bmad/bmm/workflows/workflow-init/workflow.yaml'
description: 'Initialize workflow path (START HERE)'
- trigger: status
workflow: '{project-root}/{*bmad_folder*}/bmm/workflows/workflow-status/workflow.yaml'
workflow: '{project-root}/.bmad/bmm/workflows/workflow-status/workflow.yaml'
description: 'Check current workflow status'
- trigger: next-step
workflow: '{project-root}/{*bmad_folder*}/bmm/workflows/next-step/workflow.yaml'
workflow: '{project-root}/.bmad/bmm/workflows/next-step/workflow.yaml'
description: 'Execute next workflow in sequence'
```
@ -270,20 +270,20 @@ menu:
menu:
# Phase 1: Analysis
- trigger: brainstorm
workflow: '{project-root}/{*bmad_folder*}/bmm/workflows/1-analysis/brainstorm/workflow.yaml'
workflow: '{project-root}/.bmad/bmm/workflows/1-analysis/brainstorm/workflow.yaml'
description: 'Guided brainstorming session'
- trigger: research
workflow: '{project-root}/{*bmad_folder*}/bmm/workflows/1-analysis/research/workflow.yaml'
workflow: '{project-root}/.bmad/bmm/workflows/1-analysis/research/workflow.yaml'
description: 'Market and technical research'
# Phase 2: Planning
- trigger: prd
workflow: '{project-root}/{*bmad_folder*}/bmm/workflows/2-planning/prd/workflow.yaml'
workflow: '{project-root}/.bmad/bmm/workflows/2-planning/prd/workflow.yaml'
description: 'Create PRD'
- trigger: architecture
workflow: '{project-root}/{*bmad_folder*}/bmm/workflows/2-planning/architecture/workflow.yaml'
workflow: '{project-root}/.bmad/bmm/workflows/2-planning/architecture/workflow.yaml'
description: 'Design architecture'
```
@ -292,24 +292,23 @@ menu:
```yaml
menu:
- trigger: party-mode
workflow: '{project-root}/{*bmad_folder*}/core/workflows/party-mode/workflow.yaml'
workflow: '{project-root}/.bmad/core/workflows/party-mode/workflow.yaml'
description: 'Bring all agents together'
- trigger: brainstorm
workflow: '{project-root}/{*bmad_folder*}/cis/workflows/brainstorming/workflow.yaml'
workflow: '{project-root}/.bmad/cis/workflows/brainstorming/workflow.yaml'
description: 'Use CIS brainstorming techniques'
```
## Best Practices
1. **Use {_bmad_folder_} paths** - Portable across installations
2. **Organize workflows by phase** - Clear progression for users
3. **Include workflow-status** - Help users track progress
4. **Reference module config** - Consistent behavior
5. **No Handlebars templating** - Module agents are fixed personalities
6. **Professional personas** - Match module purpose
7. **Clear trigger names** - Self-documenting commands
8. **Group related workflows** - Logical menu organization
1. **Organize workflows by phase** - Clear progression for users
2. **Include workflow-status** - Help users track progress
3. **Reference module config** - Consistent behavior
4. **No Handlebars templating** - Module agents are fixed personalities
5. **Professional personas** - Match module purpose
6. **Clear trigger names** - Self-documenting commands
7. **Group related workflows** - Logical menu organization
## Common Patterns
@ -318,7 +317,7 @@ menu:
```yaml
menu:
- trigger: start
workflow: '{project-root}/{*bmad_folder*}/{module}/workflows/init/workflow.yaml'
workflow: '{project-root}/.bmad/{module}/workflows/init/workflow.yaml'
description: 'Start new project (BEGIN HERE)'
```
@ -327,7 +326,7 @@ menu:
```yaml
menu:
- trigger: status
workflow: '{project-root}/{*bmad_folder*}/{module}/workflows/status/workflow.yaml'
workflow: '{project-root}/.bmad/{module}/workflows/status/workflow.yaml'
description: 'Check workflow progress'
```
@ -336,27 +335,27 @@ menu:
```yaml
menu:
- trigger: party
workflow: '{project-root}/{*bmad_folder*}/core/workflows/party-mode/workflow.yaml'
workflow: '{project-root}/.bmad/core/workflows/party-mode/workflow.yaml'
description: 'Multi-agent discussion'
```
## Module Agent vs Simple/Expert
| Aspect | Module Agent | Simple/Expert Agent |
| ------------- | ---------------------------------- | -------------------------------- |
| Location | `{*bmad_folder*}/{module}/agents/` | `{*bmad_folder*}/custom/agents/` |
| Persona | Fixed, professional | Customizable via install_config |
| Handlebars | No templating | Yes, extensive |
| Menu actions | Workflows, tasks, templates | Prompts, inline actions |
| Configuration | Module config.yaml | Core config or none |
| Purpose | Professional tooling | Personal utilities |
| Aspect | Module Agent | Simple/Expert Agent |
| ------------- | --------------------------- | ------------------------------- |
| Location | `.bmad/{module}/agents/` | `.bmad/custom/agents/` |
| Persona | Fixed, professional | Customizable via install_config |
| Handlebars | No templating | Yes, extensive |
| Menu actions | Workflows, tasks, templates | Prompts, inline actions |
| Configuration | Module config.yaml | Core config or none |
| Purpose | Professional tooling | Personal utilities |
## Validation Checklist
- [ ] Valid YAML syntax
- [ ] Metadata includes `module: "{module-code}"`
- [ ] id uses `{*bmad_folder*}/{module}/agents/{name}.md`
- [ ] All workflow paths use `{project-root}/{*bmad_folder*}/` prefix
- [ ] id uses `.bmad/{module}/agents/{name}.md`
- [ ] All workflow paths use `{project-root}/.bmad/` prefix
- [ ] No hardcoded paths
- [ ] No duplicate triggers
- [ ] Each menu item has description

View File

@ -7,7 +7,7 @@ ALL agent types can:
- ✓ Write to {output_folder}, {project-root}, or anywhere on system
- ✓ Update artifacts and files
- ✓ Execute bash commands
- ✓ Use core variables ({bmad_folder}, {output_folder}, etc.)
- ✓ Use core variables (.bmad, {output_folder}, etc.)
- ✓ Have complex prompts and logic
- ✓ Invoke external tools
@ -98,11 +98,11 @@ agent:
menu:
- trigger: implement-story
workflow: '{bmad_folder}/bmm/workflows/dev-story/workflow.yaml'
workflow: '.bmad/bmm/workflows/dev-story/workflow.yaml'
description: Implement user story
- trigger: refactor
workflow: '{bmad_folder}/bmm/workflows/refactor/workflow.yaml'
workflow: '.bmad/bmm/workflows/refactor/workflow.yaml'
description: Refactor codebase
```

View File

@ -69,7 +69,7 @@ workflow-folder/
Standard variables in step files:
```yaml
workflow_path: '{project-root}/{*bmad_folder*}/bmb/reference/workflows/[workflow-name]'
workflow_path: '{project-root}/.bmad/bmb/reference/workflows/[workflow-name]'
thisStepFile: '{workflow_path}/steps/step-[N]-[name].md'
nextStepFile: '{workflow_path}/steps/step-[N+1]-[name].md'
workflowFile: '{workflow_path}/workflow.md'

View File

@ -1,7 +1,7 @@
propose,type,tool_name,description,url,requires_install
always,workflow,party-mode,"Enables collaborative idea generation by managing turn-taking, summarizing contributions, and synthesizing ideas from multiple AI personas in structured conversation sessions about workflow steps or work in progress.",{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md,no
always,task,advanced-elicitation,"Employs diverse elicitation strategies such as Socratic questioning, role-playing, and counterfactual analysis to critically evaluate and enhance LLM outputs, forcing assessment from multiple perspectives and techniques.",{project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml,no
always,task,brainstorming,"Facilitates idea generation by prompting users with targeted questions, encouraging divergent thinking, and synthesizing concepts into actionable insights through collaborative creative exploration.",{project-root}/{bmad_folder}/core/tasks/brainstorming.xml,no
always,workflow,party-mode,"Enables collaborative idea generation by managing turn-taking, summarizing contributions, and synthesizing ideas from multiple AI personas in structured conversation sessions about workflow steps or work in progress.",{project-root}/.bmad/core/workflows/party-mode/workflow.md,no
always,task,advanced-elicitation,"Employs diverse elicitation strategies such as Socratic questioning, role-playing, and counterfactual analysis to critically evaluate and enhance LLM outputs, forcing assessment from multiple perspectives and techniques.",{project-root}/.bmad/core/tasks/advanced-elicitation.xml,no
always,task,brainstorming,"Facilitates idea generation by prompting users with targeted questions, encouraging divergent thinking, and synthesizing concepts into actionable insights through collaborative creative exploration.",{project-root}/.bmad/core/tasks/brainstorming.xml,no
always,llm-tool-feature,web-browsing,"Provides LLM with capabilities to perform real-time web searches, extract relevant data, and incorporate current information into responses when up-to-date information is required beyond training knowledge.",,no
always,llm-tool-feature,file-io,"Enables LLM to manage file operations such as creating, reading, updating, and deleting files, facilitating seamless data handling, storage, and document management within user environments.",,no
always,llm-tool-feature,sub-agents,"Allows LLM to create and manage specialized sub-agents that handle specific tasks or modules within larger workflows, improving efficiency through parallel processing and modular task delegation.",,no

1 propose type tool_name description url requires_install
2 always workflow party-mode Enables collaborative idea generation by managing turn-taking, summarizing contributions, and synthesizing ideas from multiple AI personas in structured conversation sessions about workflow steps or work in progress. {project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md {project-root}/.bmad/core/workflows/party-mode/workflow.md no
3 always task advanced-elicitation Employs diverse elicitation strategies such as Socratic questioning, role-playing, and counterfactual analysis to critically evaluate and enhance LLM outputs, forcing assessment from multiple perspectives and techniques. {project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml {project-root}/.bmad/core/tasks/advanced-elicitation.xml no
4 always task brainstorming Facilitates idea generation by prompting users with targeted questions, encouraging divergent thinking, and synthesizing concepts into actionable insights through collaborative creative exploration. {project-root}/{bmad_folder}/core/tasks/brainstorming.xml {project-root}/.bmad/core/tasks/brainstorming.xml no
5 always llm-tool-feature web-browsing Provides LLM with capabilities to perform real-time web searches, extract relevant data, and incorporate current information into responses when up-to-date information is required beyond training knowledge. no
6 always llm-tool-feature file-io Enables LLM to manage file operations such as creating, reading, updating, and deleting files, facilitating seamless data handling, storage, and document management within user environments. no
7 always llm-tool-feature sub-agents Allows LLM to create and manage specialized sub-agents that handle specific tasks or modules within larger workflows, improving efficiency through parallel processing and modular task delegation. no

View File

@ -13,7 +13,7 @@ description: 'Initialize the [workflow-type] workflow by detecting continuation
<!-- Path Definitions -->
workflow*path: '{project-root}/{\_bmad_folder*}/[module-path]/workflows/[workflow-name]'
workflow\*path: '{project-root}/.bmad/[module-path]/workflows/[workflow-name]'
# File References (all use {variable} format in file)

View File

@ -13,7 +13,7 @@ description: 'Handle workflow continuation from previous session'
<!-- Path Definitions -->
workflow*path: '{project-root}/{\_bmad_folder*}/[module-path]/workflows/[workflow-name]'
workflow\*path: '{project-root}/.bmad/[module-path]/workflows/[workflow-name]'
# File References (all use {variable} format in file)

View File

@ -3,7 +3,7 @@ name: "step-{{stepNumber}}-{{stepName}}"
description: "{{stepDescription}}"
# Path Definitions
workflow_path: "{project-root}/{*bmad_folder*}/{{targetModule}}/workflows/{{workflowName}}"
workflow_path: "{project-root}/.bmad/{{targetModule}}/workflows/{{workflowName}}"
# File References
thisStepFile: "{workflow_path}/steps/step-{{stepNumber}}-{{stepName}}.md"
@ -16,8 +16,8 @@ outputFile: "{output_folder}/{{outputFileName}}-{project_name}.md"
{{/hasOutput}}
# Task References (list only if used in THIS step file instance and only the ones used, there might be others)
advancedElicitationTask: "{project-root}/{*bmad_folder*}/core/tasks/advanced-elicitation.xml"
partyModeWorkflow: "{project-root}/{*bmad_folder*}/core/workflows/party-mode/workflow.md"
advancedElicitationTask: "{project-root}/.bmad/core/tasks/advanced-elicitation.xml"
partyModeWorkflow: "{project-root}/.bmad/core/workflows/party-mode/workflow.md"
{{#hasTemplates}}
# Template References

View File

@ -11,7 +11,7 @@ description: '[Brief description of what this step accomplishes]'
<!-- Path Definitions -->
workflow*path: '{project-root}/{\_bmad_folder*}/bmb/reference/workflows/[workflow-name]' # the folder the workflow.md file is in
workflow\*path: '{project-root}/.bmad/[module]/reference/workflows/[workflow-name]' # the folder the workflow.md file is in
# File References (all use {variable} format in file)
@ -23,8 +23,8 @@ outputFile: '{output_folder}/[output-file-name]-{project_name}.md'
# Task References (IF THE workflow uses and it makes sense in this step to have these )
advancedElicitationTask: '{project-root}/{_bmad_folder_}/core/tasks/advanced-elicitation.xml'
partyModeWorkflow: '{project-root}/{_bmad_folder_}/core/workflows/party-mode/workflow.md'
advancedElicitationTask: '{project-root}/.bmad/core/tasks/advanced-elicitation.xml'
partyModeWorkflow: '{project-root}/.bmad/core/workflows/party-mode/workflow.md'
# Template References (if this step uses a specific templates)

View File

@ -53,7 +53,7 @@ web_bundle: [true/false] # Set to true for inclusion in web bundle builds
### 1. Module Configuration Loading
Load and read full config from {project-root}/{_bmad_folder_}/[MODULE FOLDER]/config.yaml and resolve:
Load and read full config from {project-root}/.bmad/[MODULE FOLDER]/config.yaml and resolve:
- `project_name`, `output_folder`, `user_name`, `communication_language`, `document_output_language`, [MODULE VARS]
@ -101,4 +101,4 @@ Example: Load, read the full file and then execute `{workflow_path}/steps/step-0
### NOTE: You can View a real example of a perfect workflow.md file that was created from this template
`{project-root}/{bmad_folder}/bmb/reference/workflows/meal-prep-nutrition/workflow.md`
`{project-root}/.bmad/bmb/reference/workflows/meal-prep-nutrition/workflow.md`

View File

@ -49,7 +49,7 @@ This uses **step-file architecture** for disciplined execution:
### 1. Configuration Loading
Load and read full config from {project-root}/{_bmad_folder_}/{{targetModule}}/config.yaml and resolve:
Load and read full config from {project-root}/.bmad/{{targetModule}}/config.yaml and resolve:
- `project_name`, `output_folder`, `user_name`, `communication_language`, `document_output_language`

View File

@ -11,7 +11,6 @@ subheader: "Configure the settings for the BoMB Factory!\nThe agent, workflow an
## user_name
## communication_language
## output_folder
## bmad_folder
## install_user_docs
## kb_install

View File

@ -7,7 +7,7 @@ Reference examples for module-integrated agents.
Module agents integrate with BMAD module workflows (BMM, CIS, BMB). They:
- Orchestrate multi-step workflows
- Use `{bmad_folder}` path variables
- Use `.bmad` path variables
- Have fixed professional personas (no install_config)
- Reference module-specific configurations

View File

@ -10,7 +10,7 @@
agent:
metadata:
id: "{*bmad_folder*}/bmm/agents/security-engineer.md"
id: ".bmad/bmm/agents/security-engineer.md"
name: "Sam"
title: "Security Engineer"
icon: "🔐"
@ -32,11 +32,11 @@ agent:
menu:
# NOTE: These workflows are hypothetical examples assuming add to a module called bmm - not implemented
- trigger: threat-model
exec: "{project-root}/{*bmad_folder*}/bmm/workflows/threat-model/workflow.md"
exec: "{project-root}/.bmad/bmm/workflows/threat-model/workflow.md"
description: "Create STRIDE threat model for architecture"
- trigger: security-review
exec: "{project-root}/{*bmad_folder*}/bmm/workflows/security-review/workflow.md"
exec: "{project-root}/.bmad/bmm/workflows/security-review/workflow.md"
description: "Review code/design for security issues"
- trigger: owasp-check
@ -44,10 +44,10 @@ agent:
description: "Check against OWASP Top 10"
- trigger: compliance
exec: "{project-root}/{*bmad_folder*}/bmm/workflows/compliance-check/workflow.md"
exec: "{project-root}/.bmad/bmm/workflows/compliance-check/workflow.md"
description: "Verify compliance requirements (SOC2, GDPR, etc.)"
# Core workflow that exists
- trigger: party-mode
exec: "{project-root}/{*bmad_folder*}/core/workflows/party-mode/workflow.md"
exec: "{project-root}/.bmad/core/workflows/party-mode/workflow.md"
description: "Multi-agent security discussion"

View File

@ -10,7 +10,7 @@
agent:
metadata:
id: "{*bmad_folder*}/cis/agents/trend-analyst.md"
id: ".bmad/cis/agents/trend-analyst.md"
name: "Nova"
title: "Trend Analyst"
icon: "📈"
@ -32,26 +32,26 @@ agent:
menu:
# NOTE: These workflows are hypothetical examples - not implemented
- trigger: scan-trends
exec: "{project-root}/{*bmad_folder*}/cis/workflows/trend-scan/workflow.md"
exec: "{project-root}/.bmad/cis/workflows/trend-scan/workflow.md"
description: "Scan for emerging trends in a domain"
- trigger: analyze-trend
exec: "{project-root}/{*bmad_folder*}/cis/workflows/trend-analysis/workflow.md"
exec: "{project-root}/.bmad/cis/workflows/trend-analysis/workflow.md"
description: "Deep dive on a specific trend"
- trigger: opportunity-map
exec: "{project-root}/{*bmad_folder*}/cis/workflows/opportunity-mapping/workflow.md"
exec: "{project-root}/.bmad/cis/workflows/opportunity-mapping/workflow.md"
description: "Map trend to strategic opportunities"
- trigger: competitor-trends
exec: "{project-root}/{*bmad_folder*}/cis/tasks/competitor-trend-watch.xml"
exec: "{project-root}/.bmad/cis/tasks/competitor-trend-watch.xml"
description: "Monitor competitor trend adoption"
# Core workflows that exist
- trigger: brainstorm
exec: "{project-root}/{*bmad_folder*}/core/workflows/brainstorming/workflow.md"
exec: "{project-root}/.bmad/core/workflows/brainstorming/workflow.md"
description: "Brainstorm trend implications"
- trigger: party-mode
exec: "{project-root}/{*bmad_folder*}/core/workflows/party-mode/workflow.md"
exec: "{project-root}/.bmad/core/workflows/party-mode/workflow.md"
description: "Discuss trends with other agents"

View File

@ -3,7 +3,7 @@ name: 'step-01-init'
description: 'Initialize the nutrition plan workflow by detecting continuation state and creating output document'
# Path Definitions
workflow_path: '{project-root}/{bmad_folder}/bmb/reference/workflows/meal-prep-nutrition'
workflow_path: '{project-root}/.bmad/bmb/reference/workflows/meal-prep-nutrition'
# File References
thisStepFile: '{workflow_path}/steps/step-01-init.md'

View File

@ -3,7 +3,7 @@ name: 'step-01b-continue'
description: 'Handle workflow continuation from previous session'
# Path Definitions
workflow_path: '{project-root}/{bmad_folder}/bmb/reference/workflows/meal-prep-nutrition'
workflow_path: '{project-root}/.bmad/bmb/reference/workflows/meal-prep-nutrition'
# File References
thisStepFile: '{workflow_path}/steps/step-01b-continue.md'

View File

@ -3,7 +3,7 @@ name: 'step-02-profile'
description: 'Gather comprehensive user profile information through collaborative conversation'
# Path Definitions
workflow_path: '{project-root}/{bmad_folder}/bmb/reference/workflows/meal-prep-nutrition'
workflow_path: '{project-root}/.bmad/bmb/reference/workflows/meal-prep-nutrition'
# File References (all use {variable} format in file)
thisStepFile: '{workflow_path}/steps/step-02-profile.md'
@ -12,8 +12,8 @@ workflowFile: '{workflow_path}/workflow.md'
outputFile: '{output_folder}/nutrition-plan-{project_name}.md'
# Task References
advancedElicitationTask: '{project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml'
partyModeWorkflow: '{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md'
advancedElicitationTask: '{project-root}/.bmad/core/tasks/advanced-elicitation.xml'
partyModeWorkflow: '{project-root}/.bmad/core/workflows/party-mode/workflow.md'
# Template References
profileTemplate: '{workflow_path}/templates/profile-section.md'

View File

@ -3,7 +3,7 @@ name: 'step-03-assessment'
description: 'Analyze nutritional requirements, identify restrictions, and calculate target macros'
# Path Definitions
workflow_path: '{project-root}/{bmad_folder}/bmb/reference/workflows/meal-prep-nutrition'
workflow_path: '{project-root}/.bmad/bmb/reference/workflows/meal-prep-nutrition'
# File References
thisStepFile: '{workflow_path}/steps/step-03-assessment.md'
@ -12,8 +12,8 @@ workflowFile: '{workflow_path}/workflow.md'
outputFile: '{output_folder}/nutrition-plan-{project_name}.md'
# Task References
advancedElicitationTask: '{project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml'
partyModeWorkflow: '{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md'
advancedElicitationTask: '{project-root}/.bmad/core/tasks/advanced-elicitation.xml'
partyModeWorkflow: '{project-root}/.bmad/core/workflows/party-mode/workflow.md'
# Data References
dietaryRestrictionsDB: '{workflow_path}/data/dietary-restrictions.csv'

View File

@ -3,7 +3,7 @@ name: 'step-04-strategy'
description: 'Design a personalized meal strategy that meets nutritional needs and fits lifestyle'
# Path Definitions
workflow_path: '{project-root}/{bmad_folder}/bmb/reference/workflows/meal-prep-nutrition'
workflow_path: '{project-root}/.bmad/bmb/reference/workflows/meal-prep-nutrition'
# File References
thisStepFile: '{workflow_path}/steps/step-04-strategy.md'
@ -13,8 +13,8 @@ workflowFile: '{workflow_path}/workflow.md'
outputFile: '{output_folder}/nutrition-plan-{project_name}.md'
# Task References
advancedElicitationTask: '{project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml'
partyModeWorkflow: '{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md'
advancedElicitationTask: '{project-root}/.bmad/core/tasks/advanced-elicitation.xml'
partyModeWorkflow: '{project-root}/.bmad/core/workflows/party-mode/workflow.md'
# Data References
recipeDatabase: '{workflow_path}/data/recipe-database.csv'
@ -167,8 +167,8 @@ Display: **Select an Option:** [A] Meal Variety Optimization [P] Chef & Dietitia
#### Menu Handling Logic:
- HALT and AWAIT ANSWER
- IF A: Execute `{project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml`
- IF P: Execute `{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md` with a chef and dietitian expert also as part of the party
- IF A: Execute `{project-root}/.bmad/core/tasks/advanced-elicitation.xml`
- IF P: Execute `{project-root}/.bmad/core/workflows/party-mode/workflow.md` with a chef and dietitian expert also as part of the party
- IF C: Save content to nutrition-plan.md, update frontmatter `stepsCompleted` to add 4 at the end of the array before loading next step, check cooking frequency:
- IF cooking frequency > 2x/week: load, read entire file, then execute `{workflow_path}/step-05-shopping.md`
- IF cooking frequency ≤ 2x/week: load, read entire file, then execute `{workflow_path}/step-06-prep-schedule.md`

View File

@ -3,7 +3,7 @@ name: 'step-05-shopping'
description: 'Create a comprehensive shopping list that supports the meal strategy'
# Path Definitions
workflow_path: '{project-root}/{bmad_folder}/bmb/reference/workflows/meal-prep-nutrition'
workflow_path: '{project-root}/.bmad/bmb/reference/workflows/meal-prep-nutrition'
# File References
thisStepFile: '{workflow_path}/steps/step-05-shopping.md'
@ -12,8 +12,8 @@ workflowFile: '{workflow_path}/workflow.md'
outputFile: '{output_folder}/nutrition-plan-{project_name}.md'
# Task References
advancedElicitationTask: '{project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml'
partyModeWorkflow: '{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md'
advancedElicitationTask: '{project-root}/.bmad/core/tasks/advanced-elicitation.xml'
partyModeWorkflow: '{project-root}/.bmad/core/workflows/party-mode/workflow.md'
# Template References
shoppingTemplate: '{workflow_path}/templates/shopping-section.md'
@ -157,8 +157,8 @@ Display: **Select an Option:** [A] Budget Optimization Strategies [P] Shopping P
#### Menu Handling Logic:
- HALT and AWAIT ANSWER
- IF A: Execute `{project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml`
- IF P: Execute `{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md`
- IF A: Execute `{project-root}/.bmad/core/tasks/advanced-elicitation.xml`
- IF P: Execute `{project-root}/.bmad/core/workflows/party-mode/workflow.md`
- IF C: Save content to nutrition-plan.md, update frontmatter `stepsCompleted` to add 5 at the end of the array before loading next step, then load, read entire file, then execute `{workflow_path}/step-06-prep-schedule.md`
- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#5-present-menu-options)

Some files were not shown because too many files have changed in this diff Show More