mirror of
https://github.com/bmadcode/BMAD-METHOD.git
synced 2025-12-17 09:45:25 +00:00
examples of custom modules, custom module and readme doc updates
This commit is contained in:
Brian Madison
parent
32615afaf9
commit
d0e0a0963a
29
README.md
29
README.md
@ -6,6 +6,33 @@
|
|||||||
[](https://nodejs.org)
|
[](https://nodejs.org)
|
||||||
[](https://discord.gg/gk8jAdXWmj)
|
[](https://discord.gg/gk8jAdXWmj)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
<div align="center">
|
||||||
|
|
||||||
|
## 🎉 NEW: BMAD V6 Installer - Create & Share Custom Content!
|
||||||
|
|
||||||
|
The completely revamped **BMAD V6 installer** now includes built-in support for creating, installing, and sharing custom modules, agents, workflows, templates, and tools! Build your own AI solutions or share them with your team - and real soon, with the whole BMad Community througha verified community sharing portal!
|
||||||
|
|
||||||
|
**✨ What's New:**
|
||||||
|
|
||||||
|
- 📦 **Streamlined Custom Module Installation** - Package your custom content as installable modules
|
||||||
|
- 🤖 **Agent & Workflow Sharing** - Distribute standalone agents and workflows
|
||||||
|
- 🔄 **Unitary Module Support** - Install individual components without full modules
|
||||||
|
- ⚙️ **Dependency Management** - Automatic handling of module dependencies
|
||||||
|
- 🛡️ **Update-Safe Customization** - Your custom content persists through updates
|
||||||
|
|
||||||
|
**📚 Learn More:**
|
||||||
|
|
||||||
|
- [**Custom Content Overview**](./docs/custom-content.md) - Discover all supported content types
|
||||||
|
- [**Installation Guide**](./docs/custom-content-installation.md) - Learn to create and install custom content
|
||||||
|
- [**Detail Content Docs**](./src/modules/bmb/docs/README.md) - Reference details for agents, modules, workflows and the bmad builder
|
||||||
|
- [**2 Very simple Custom Modules of questionable quality**](./docs/sample-custom-modules/README.md) - if you want to download and try to install a custom shared module, get an idea of how to bundle and share your own, or create your own personal agents, workflows and modules.
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## AI-Driven Agile Development That Scales From Bug Fixes to Enterprise
|
## AI-Driven Agile Development That Scales From Bug Fixes to Enterprise
|
||||||
|
|
||||||
**Build More, Architect Dreams** (BMAD) with **21 specialized AI agents** across 4 official modules, and **50+ guided workflows** that adapt to your project's complexity—from quick bug fixes to enterprise platforms, and new step file workflows that allow for incredibly long workflows to stay on the rails longer than ever before!
|
**Build More, Architect Dreams** (BMAD) with **21 specialized AI agents** across 4 official modules, and **50+ guided workflows** that adapt to your project's complexity—from quick bug fixes to enterprise platforms, and new step file workflows that allow for incredibly long workflows to stay on the rails longer than ever before!
|
||||||
@ -120,7 +147,7 @@ Each agent brings deep expertise and can be customized to match your team's styl
|
|||||||
- **BMad Builder (BMB)** - Create custom agents and workflows
|
- **BMad Builder (BMB)** - Create custom agents and workflows
|
||||||
- Build anything from simple agents to complex modules
|
- Build anything from simple agents to complex modules
|
||||||
- Create domain-specific solutions (legal, medical, finance, education)
|
- Create domain-specific solutions (legal, medical, finance, education)
|
||||||
- Share your creations in the upcoming community marketplace
|
- [→ Builder Guide](src/modules/bmb/docs/README.md) marketplace
|
||||||
- [→ Builder Guide](./src/modules/bmb/README.md)
|
- [→ Builder Guide](./src/modules/bmb/README.md)
|
||||||
|
|
||||||
- **Creative Intelligence Suite (CIS)** - Innovation & problem-solving
|
- **Creative Intelligence Suite (CIS)** - Innovation & problem-solving
|
||||||
|
|||||||
@ -1,244 +1,149 @@
|
|||||||
# Custom Content Installation
|
# Custom Content Installation
|
||||||
|
|
||||||
This guide explains how to create and install custom BMAD content including agents, workflows, and modules. Custom content allows you to extend BMAD's functionality with your own specialized tools and workflows that can be shared across projects or teams.
|
This guide explains how to create and install custom BMAD content including agents, workflows, and modules. Custom content extends BMAD's functionality with specialized tools and workflows that can be shared across projects or teams.
|
||||||
|
|
||||||
## Types of Custom Content
|
For detailed information about the different types of custom content available, see [Custom Content](./custom-content.md).
|
||||||
|
|
||||||
### 1. Custom Agents and Workflows (Standalone)
|
If you download either of the folders within the [Sample Custom Modules](./sample-custom-modules/readme.md) folder
|
||||||
|
|
||||||
Custom agents and workflows are standalone content packages that can be installed without being part of a full module. These are perfect for:
|
## Content Types Overview
|
||||||
|
|
||||||
- Sharing specialized agents across projects
|
BMAD Core supports several categories of custom content:
|
||||||
- Building a personal Agent powered Notebook vault
|
|
||||||
- Distributing workflow templates
|
|
||||||
- Creating agent libraries for specific domains
|
|
||||||
|
|
||||||
#### Structure
|
- Custom Stand Alone Modules
|
||||||
|
- Custom Add On Modules
|
||||||
|
- Custom Global Modules
|
||||||
|
- Custom Agents
|
||||||
|
- Custom Workflows
|
||||||
|
|
||||||
A custom agents and workflows package follows this structure:
|
## Making Custom Content Installable
|
||||||
|
|
||||||
```
|
### Custom Modules
|
||||||
my-custom-agents/
|
|
||||||
├── module.yaml # Package configuration
|
|
||||||
├── agents/ # Agent definitions
|
|
||||||
│ └── my-agent/
|
|
||||||
│ └── agent.md
|
|
||||||
└── workflows/ # Workflow definitions
|
|
||||||
└── my-workflow/
|
|
||||||
└── workflow.md
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Configuration
|
To create an installable custom module:
|
||||||
|
|
||||||
Create a `module.yaml` file in your package root:
|
1. **Folder Structure**
|
||||||
|
- Create a folder with a short, abbreviated name (e.g., `cis` for Creative Intelligence Suite)
|
||||||
|
- The folder name serves as the module code
|
||||||
|
|
||||||
```yaml
|
2. **Required Files**
|
||||||
code: my-custom-agents
|
- Include a `module.yaml` file in the root folder
|
||||||
name: 'My Custom Agents and Workflows'
|
- This file drives the installation process when used by the BMAD installer
|
||||||
default_selected: true
|
- Reference existing modules or the BMad Builder for configuration examples
|
||||||
```
|
|
||||||
|
|
||||||
#### Example
|
3. **Folder Organization**
|
||||||
|
Follow these conventions for optimal compatibility:
|
||||||
|
|
||||||
See `/example-custom-content` for a working example of a folder with multiple random custom agents and workflows. Technically its also just a module, but you will be able to further pick and choose from this folders contents of what you do and do not want to include in a destination folder. This way, you can store all custom content source in one location and easily install it to different locations.
|
```
|
||||||
|
module-code/
|
||||||
|
module.yaml
|
||||||
|
agents/
|
||||||
|
workflows/
|
||||||
|
tools/
|
||||||
|
templates/
|
||||||
|
...
|
||||||
|
```
|
||||||
|
|
||||||
### 2. Custom Modules
|
- `agents/` - Agent definitions
|
||||||
|
- `workflows/` - Workflow definitions
|
||||||
|
- Additional custom folders are supported but following conventions is recommended for agent and workflow discovery
|
||||||
|
|
||||||
Custom modules are complete BMAD modules that can include their own configuration, documentation, along with agents and workflows that all compliment each other. Additionally they will have their own installation scripts, data, and potentially other tools. Modules can be used for:
|
**Note:** Full documentation for global modules and add-on modules will be available as support is finalized.
|
||||||
|
|
||||||
- Domain-specific functionality (e.g., industry-specific workflows, entertainment, education and training, medical, etc...)
|
### Standalone Content (Agents, Workflows, Tasks, Tools, Templates, Prompts)
|
||||||
- Integration with external systems
|
|
||||||
- Specialized agent collections
|
|
||||||
- Custom tooling and utilities
|
|
||||||
|
|
||||||
#### Structure
|
For standalone content that isn't part of a cohesive module collection, follow this structure:
|
||||||
|
|
||||||
A custom module follows this structure:
|
1. **Module Configuration**
|
||||||
|
- Create a folder with a `module.yaml` file (similar to custom modules)
|
||||||
|
- Add the property `unitary: true` to the module.yaml
|
||||||
|
- The `unitary: true` property indicates this is a collection of potentially unrelated items that don't depend on each other
|
||||||
|
|
||||||
```
|
2. **Folder Structure**
|
||||||
my-module/
|
Organize content in specific named folders:
|
||||||
├── _module-installer/
|
|
||||||
│ ├── installer.js # optional, when it exists it will run with module installation
|
|
||||||
├── module.yaml # Module installation configuration with custom question and answer capture
|
|
||||||
├── docs/ # Module documentation
|
|
||||||
├── agents/ # Module-specific agents
|
|
||||||
├── workflows/ # Module-specific workflows
|
|
||||||
├── data/ # csv or other content to power agent intelligence or workflows
|
|
||||||
├── tools/ # Custom tools, hooks, mcp
|
|
||||||
└── sub-modules/ # IDE-specific customizations
|
|
||||||
├── vscode/
|
|
||||||
└── cursor/
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Module Configuration
|
```
|
||||||
|
module-name/
|
||||||
|
module.yaml # Contains unitary: true
|
||||||
|
agents/
|
||||||
|
workflows/
|
||||||
|
templates/
|
||||||
|
tools/
|
||||||
|
tasks/
|
||||||
|
prompts/
|
||||||
|
```
|
||||||
|
|
||||||
The `module.yaml` file defines how your module is installed:
|
3. **Individual Item Organization**
|
||||||
|
Each item should have its own subfolder:
|
||||||
|
```text
|
||||||
|
my-custom-stuff/
|
||||||
|
module.yaml
|
||||||
|
agents/
|
||||||
|
larry/larry.agent.md
|
||||||
|
curly/curly.agent.md
|
||||||
|
moe/moe.agent.md
|
||||||
|
moe/moe-sidecar/memories.csv
|
||||||
|
```
|
||||||
|
|
||||||
```yaml
|
**Future Feature:** Unitary modules will support selective installation, allowing users to pick and choose which specific items to install.
|
||||||
# Module metadata
|
|
||||||
code: my-module
|
|
||||||
name: 'My Custom Module'
|
|
||||||
default_selected: false
|
|
||||||
|
|
||||||
header: 'My Custom Module'
|
**Note:** Documentation explaining the distinctions between these content types and their specific use cases will be available soon.
|
||||||
subheader: 'Description of what this module does'
|
|
||||||
|
|
||||||
# Configuration prompts
|
|
||||||
my_setting:
|
|
||||||
prompt: 'Configure your module setting'
|
|
||||||
default: 'default-value'
|
|
||||||
result: '{value}'
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Example
|
|
||||||
|
|
||||||
See `/example-custom-module` for a complete example:
|
|
||||||
|
|
||||||
## Installation Process
|
## Installation Process
|
||||||
|
|
||||||
### Step 1: Running the Installer
|
### Prerequisites
|
||||||
|
|
||||||
When you run the existing normal BMAD installer - either from the cloned repo, OR via NPX, it will ask about custom content:
|
Ensure your content follows the proper conventions and includes a `module.yaml` file (only one per top-level folder).
|
||||||
|
|
||||||
```
|
### New Project Installation
|
||||||
? Do you have custom content to install?
|
|
||||||
❯ No (skip custom content)
|
|
||||||
Enter a directory path
|
|
||||||
Enter a URL [Coming soon]
|
|
||||||
```
|
|
||||||
|
|
||||||
### Step 2: Providing Custom Content Path
|
When setting up a new BMAD project:
|
||||||
|
|
||||||
If you select "Enter a directory path", the installer will prompt for the location:
|
1. The installer will prompt: `Would you like to install a local custom module (this includes custom agents and workflows also)? (y/N)`
|
||||||
|
2. Select 'y' to specify the path to your module folder containing `module.yaml`
|
||||||
|
|
||||||
```
|
### Existing Project Modification
|
||||||
? Enter the path to your custom content directory: /path/to/folder/containing/content/folder
|
|
||||||
```
|
|
||||||
|
|
||||||
The installer will:
|
To add custom content to an existing BMAD project:
|
||||||
|
|
||||||
- Scan for `module.yaml` files (modules)
|
1. Run the installer against your project location
|
||||||
- Display an indication of how many installable folders it has found. Note that a project with stand along agents and workflows all under a single folder like the example will just list the count as 1 for that directory.
|
2. Select `Modify BMAD Installation`
|
||||||
|
3. Choose the option to add, modify, or update custom modules
|
||||||
|
|
||||||
### Step 3: Selecting Content
|
### Upcoming Features
|
||||||
|
|
||||||
The installer presents a unified selection interface:
|
- **Unitary Module Selection:** For modules with `type: unitary` (instead of `type: module`), you'll be able to select specific items to install
|
||||||
|
- **Add-on Module Dependencies:** The installer will verify and install dependencies for add-on modules automatically
|
||||||
|
|
||||||
```
|
## Quick Updates
|
||||||
? Select modules and custom content to install:
|
|
||||||
[── Custom Content ──]
|
|
||||||
◉ My Custom Agents and Workflows (/path/to/custom)
|
|
||||||
[── Official Content ──]
|
|
||||||
◯ BMM: Business Method & Management
|
|
||||||
◯ CIS: Creativity & Innovation Suite
|
|
||||||
```
|
|
||||||
|
|
||||||
## Agent Sidecar Support
|
When updates to BMAD Core or core modules (BMM, CIS, etc.) become available, the quick update process will:
|
||||||
|
|
||||||
Agents with sidecar content can store personal data, memories, and working files outside of the `_bmad` directory. This separation keeps personal content separate from BMAD's core files.
|
1. Apply available updates to core modules
|
||||||
|
2. Recompile all agents with customizations from the `_config/agents` folder
|
||||||
|
3. Retain your custom content from a cached location
|
||||||
|
4. Preserve your existing configurations and customizations
|
||||||
|
|
||||||
### What is Sidecar Content?
|
This means you don't need to keep the source module files locally. When updates are available, simply point to the updated module location during the update process.
|
||||||
|
|
||||||
Sidecar content includes:
|
## Important Considerations
|
||||||
|
|
||||||
- Agent memories and learning data
|
### Module Naming Conflicts
|
||||||
- Personal working files
|
|
||||||
- Temporary data
|
|
||||||
- User-specific configurations
|
|
||||||
|
|
||||||
### Sidecar Configuration
|
When installing unofficial modules, ensure unique identification to avoid conflicts:
|
||||||
|
|
||||||
The sidecar folder location is configured during BMAD core installation:
|
1. **Module Codes:** Each module must have a unique code (e.g., don't use `bmm` for custom modules)
|
||||||
|
2. **Module Names:** Avoid using names that conflict with existing modules
|
||||||
|
3. **Multiple Custom Modules:** If creating multiple custom modules, use distinct codes for each
|
||||||
|
|
||||||
```
|
**Examples of conflicts to avoid:**
|
||||||
? Where should users' agent sidecar memory folders be stored?
|
|
||||||
❯ _bmad-user-memory
|
|
||||||
```
|
|
||||||
|
|
||||||
### How It Works
|
- Don't create a custom module with code `bmm` (already used by BMad Method)
|
||||||
|
- Don't name multiple custom modules with the same code like `mca`
|
||||||
1. **Agent Declaration**: Agents declare `hasSidecar: true` in their metadata
|
|
||||||
2. **Sidecar Detection**: The installer automatically detects folders with "sidecar" in the name
|
|
||||||
3. **Installation**: Sidecar content is always copied to the destination install \_bmad/\_memory folder.
|
|
||||||
|
|
||||||
### Example Structure
|
|
||||||
|
|
||||||
```
|
|
||||||
my-agent/
|
|
||||||
├── agent.md # Agent definition
|
|
||||||
└── my-agent-sidecar/ # Sidecar content folder
|
|
||||||
├── memories/
|
|
||||||
├── working/
|
|
||||||
└── config/
|
|
||||||
```
|
|
||||||
|
|
||||||
### Git Integration
|
|
||||||
|
|
||||||
Since sidecar content is stored outside the `_bmad` directory (and typically outside version control), users can:
|
|
||||||
|
|
||||||
- Add the sidecar folder to `.gitignore` to exclude personal data
|
|
||||||
- Share agent definitions without exposing personal content
|
|
||||||
- Maintain separate configurations for different projects
|
|
||||||
|
|
||||||
Example `.gitignore` entry:
|
|
||||||
|
|
||||||
```
|
|
||||||
# Exclude agent personal data
|
|
||||||
_bmad-user-memory/
|
|
||||||
```
|
|
||||||
|
|
||||||
## Creating Custom Content with BMAD Builder
|
|
||||||
|
|
||||||
The BMAD Builder provides workflows that will guide you to produce your own custom content:
|
|
||||||
|
|
||||||
1. **Agent Templates**: Use standardized agent templates with proper structure
|
|
||||||
2. **Workflow Templates**: Create workflows using proven patterns
|
|
||||||
3. **Validation Tools**: Validate your content before distribution
|
|
||||||
4. **Package Generation**: Generate properly structured packages
|
|
||||||
|
|
||||||
### Best Practices
|
### Best Practices
|
||||||
|
|
||||||
1. **Use Clear Naming**: Make your content codes and names descriptive
|
- Use descriptive, unique codes for your modules
|
||||||
2. **Provide Documentation**: Include clear setup and usage instructions
|
- Document any dependencies your custom modules have
|
||||||
3. **Test Installation**: Test your content in a clean environment
|
- Test custom modules in isolation before sharing
|
||||||
4. **Version Management**: Use semantic versioning for updates
|
- Consider version numbering for your custom content to track updates
|
||||||
5. **Respect User Privacy**: Keep personal data in sidecar folders
|
|
||||||
|
|
||||||
## Distribution
|
|
||||||
|
|
||||||
Custom content can be distributed:
|
|
||||||
|
|
||||||
1. **File System**: Copy folders directly to users
|
|
||||||
2. **Git Repositories**: Clone or download from version control
|
|
||||||
3. **Package Managers**: [Coming soon] npm package support
|
|
||||||
4. **URL Installation**: [Coming soon] Direct URL installation, including an official community vetted module forge
|
|
||||||
|
|
||||||
## Troubleshooting
|
|
||||||
|
|
||||||
### No Custom Content Found
|
|
||||||
|
|
||||||
- Ensure your `module.yaml` files are properly named
|
|
||||||
- Check file permissions
|
|
||||||
- Verify the directory path is correct
|
|
||||||
|
|
||||||
### Installation Errors
|
|
||||||
|
|
||||||
- Run the installer with verbose logging
|
|
||||||
- Check for syntax errors in YAML configuration files
|
|
||||||
- Verify all required files are present
|
|
||||||
|
|
||||||
### Sidecar Issues
|
|
||||||
|
|
||||||
- Ensure the agent has `hasSidecar: true` in metadata
|
|
||||||
- Check that sidecar folders contain "-sidecar" in the name
|
|
||||||
- Verify the folder on install got cloned to \_bmad/\_memory
|
|
||||||
- Ensure the custom agent has proper language in it to actually use the sidecar content, including loading memories on agent load.
|
|
||||||
|
|
||||||
## Support
|
|
||||||
|
|
||||||
For help with custom content creation or installation:
|
|
||||||
|
|
||||||
1. Check the examples in `/example-custom-content` and `/example-custom-module`
|
|
||||||
2. Review the BMAD documentation
|
|
||||||
3. Create an issue in the BMAD repository
|
|
||||||
4. Join the BMAD community discussions on discord
|
|
||||||
|
|||||||
122
docs/custom-content.md
Normal file
122
docs/custom-content.md
Normal file
@ -0,0 +1,122 @@
|
|||||||
|
# Custom Content
|
||||||
|
|
||||||
|
BMAD supports several categories of officially supported custom content that extend the platform's capabilities. Custom content can be created manually or with the recommended assistance of the BMad Builder (BoMB) Module. The BoMB Agent provides workflows and expertise to plan and build any custom content you can imagine.
|
||||||
|
|
||||||
|
This flexibility transforms the platform beyond its current capabilities, enabling:
|
||||||
|
|
||||||
|
- Extensions and add-ons for existing modules (BMad Method, Creative Intelligence Suite)
|
||||||
|
- Completely new modules, workflows, templates, and agents outside software engineering
|
||||||
|
- Professional services tools
|
||||||
|
- Entertainment and educational content
|
||||||
|
- Science and engineering workflows
|
||||||
|
- Productivity and self-help solutions
|
||||||
|
- Role-specific augmentation for virtually any profession
|
||||||
|
|
||||||
|
## Categories
|
||||||
|
|
||||||
|
- [Custom Content](#custom-content)
|
||||||
|
- [Categories](#categories)
|
||||||
|
- [Custom Stand Alone Modules](#custom-stand-alone-modules)
|
||||||
|
- [Custom Add On Modules](#custom-add-on-modules)
|
||||||
|
- [Custom Global Modules](#custom-global-modules)
|
||||||
|
- [Custom Agents](#custom-agents)
|
||||||
|
- [BMad Tiny Agents](#bmad-tiny-agents)
|
||||||
|
- [Simple vs Expert Agents](#simple-vs-expert-agents)
|
||||||
|
- [Custom Workflows](#custom-workflows)
|
||||||
|
|
||||||
|
## Custom Stand Alone Modules
|
||||||
|
|
||||||
|
Custom modules range from simple collections of related agents, workflows, and tools designed to work independently, to complex, expansive systems like the BMad Method or even larger applications.
|
||||||
|
|
||||||
|
Custom modules are [installable](./custom-content-installation.md) using the standard BMAD method and support advanced features:
|
||||||
|
|
||||||
|
- Optional user information collection during installation/updates
|
||||||
|
- Versioning and upgrade paths
|
||||||
|
- Custom installer functions with IDE-specific post-installation handling (custom hooks, subagents, or vendor-specific tools)
|
||||||
|
- Ability to bundle specific tools such as MCP, skills, execution libraries, and code
|
||||||
|
|
||||||
|
## Custom Add On Modules
|
||||||
|
|
||||||
|
Custom Add On Modules contain specific agents, tools, or workflows that expand, modify, or customize another module but cannot exist or install independently. These add-ons provide enhanced functionality while leveraging the base module's existing capabilities.
|
||||||
|
|
||||||
|
Examples include:
|
||||||
|
|
||||||
|
- Alternative implementation workflows for BMad Method agents
|
||||||
|
- Framework-specific support for particular use cases
|
||||||
|
- Game development expansions that add new genre-specific capabilities without reinventing existing functionality
|
||||||
|
|
||||||
|
Add on modules can include:
|
||||||
|
|
||||||
|
- Custom agents with awareness of the target module
|
||||||
|
- Access to existing module workflows
|
||||||
|
- Tool-specific features such as rulesets, hooks, subprocess prompts, subagents, and more
|
||||||
|
|
||||||
|
## Custom Global Modules
|
||||||
|
|
||||||
|
Similar to Custom Stand Alone Modules, but designed to add functionality that applies across all installed content. These modules provide cross-cutting capabilities that enhance the entire BMAD ecosystem.
|
||||||
|
|
||||||
|
Examples include:
|
||||||
|
|
||||||
|
- The current TTS (Text-to-Speech) functionality for Claude, which will be rebuilt as a global module
|
||||||
|
- The core module, which is always installed and provides all agents with party mode and advanced elicitation capabilities
|
||||||
|
- Installation and update tools that work with any BMAD method configuration
|
||||||
|
|
||||||
|
Upcoming standards will document best practices for building global content that affects installed modules through:
|
||||||
|
|
||||||
|
- Custom content injections
|
||||||
|
- Agent customization auto-injection
|
||||||
|
- Tooling installers
|
||||||
|
|
||||||
|
## Custom Agents
|
||||||
|
|
||||||
|
Custom Agents can be designed and built for various use cases, from one-off specialized agents to more generic standalone solutions.
|
||||||
|
|
||||||
|
### BMad Tiny Agents
|
||||||
|
|
||||||
|
Personal agents designed for highly specific needs that may not be suitable for sharing. For example, a team management agent living in an Obsidian vault that helps with:
|
||||||
|
|
||||||
|
- Team coordination and management
|
||||||
|
- Understanding team details and requirements
|
||||||
|
- Tracking specific tasks with designated tools
|
||||||
|
|
||||||
|
These are simple, standalone files that can be scoped to focus on specific data or paths when integrated into an information vault or repository.
|
||||||
|
|
||||||
|
### Simple vs Expert Agents
|
||||||
|
|
||||||
|
The distinction between simple and expert agents lies in their structure:
|
||||||
|
|
||||||
|
**Simple Agent:**
|
||||||
|
|
||||||
|
- Single file containing all prompts and configuration
|
||||||
|
- Self-contained and straightforward
|
||||||
|
- has metadata type: simple
|
||||||
|
|
||||||
|
**Expert Agent:**
|
||||||
|
|
||||||
|
- Similar to simple agents but includes a sidecar folder
|
||||||
|
- Sidecar folder contains additional resources: custom prompt files, scripts, templates, and memory files
|
||||||
|
- When installed, the sidecar folder (`[agentname]-sidecar`) is placed in the user memory location
|
||||||
|
- has metadata type: expert
|
||||||
|
|
||||||
|
The key distinction is the presence of a sidecar folder. As web and consumer agent tools evolve to support common memory mechanisms, storage formats, and MCP, the writable memory files will adapt to support these evolving standards.
|
||||||
|
|
||||||
|
Custom agents can be:
|
||||||
|
|
||||||
|
- Used within custom modules
|
||||||
|
- Designed as standalone tools
|
||||||
|
- Integrated with existing workflows and systems, if this is to be the case, should also include a module: <module name> if a specific module is intended for it to require working with
|
||||||
|
|
||||||
|
## Custom Workflows
|
||||||
|
|
||||||
|
Workflows are powerful, progressively loading sequence engines capable of performing tasks ranging from simple to complex, including:
|
||||||
|
|
||||||
|
- User engagements
|
||||||
|
- Business processes
|
||||||
|
- Content generation (code, documentation, or other output formats)
|
||||||
|
|
||||||
|
A custom workflow created outside of a larger module can still be distributed and used without associated agents through:
|
||||||
|
|
||||||
|
- Slash commands
|
||||||
|
- Manual command/prompt execution when supported by tools
|
||||||
|
|
||||||
|
At its core, a custom workflow is a single or series of prompts designed to achieve a specific outcome.
|
||||||
@ -53,7 +53,7 @@ The flagship module for agile AI-driven development.
|
|||||||
|
|
||||||
Build your own agents, workflows, and modules.
|
Build your own agents, workflows, and modules.
|
||||||
|
|
||||||
- **[BMB Module README](../src/modules/bmb/README.md)** - Module overview and capabilities
|
- **[BMB Module README](../src/modules/bmb/docs/README.md)** - Module overview and capabilities
|
||||||
- **[Agent Creation Guide](../src/modules/bmb/workflows/create-agent/README.md)** - Design custom agents
|
- **[Agent Creation Guide](../src/modules/bmb/workflows/create-agent/README.md)** - Design custom agents
|
||||||
|
|
||||||
### Creative Intelligence Suite (CIS) - Innovation & Creativity
|
### Creative Intelligence Suite (CIS) - Innovation & Creativity
|
||||||
@ -141,7 +141,7 @@ Instructions for loading agents and running workflows in your development enviro
|
|||||||
|
|
||||||
### Path 5: Building Custom Solutions
|
### Path 5: Building Custom Solutions
|
||||||
|
|
||||||
1. [BMB Module README](../src/modules/bmb/README.md) - Understand capabilities
|
1. [BMB Module README](../src/modules/bmb/docs/README.md) - Understand capabilities
|
||||||
2. [Agent Creation Guide](../src/modules/bmb/workflows/create-agent/README.md) - Create agents
|
2. [Agent Creation Guide](../src/modules/bmb/workflows/create-agent/README.md) - Create agents
|
||||||
3. [BMM Workflows Guide](../src/modules/bmm/workflows/README.md) - Understand workflow structure
|
3. [BMM Workflows Guide](../src/modules/bmm/workflows/README.md) - Understand workflow structure
|
||||||
|
|
||||||
|
|||||||
11
docs/sample-custom-modules/README.md
Normal file
11
docs/sample-custom-modules/README.md
Normal file
@ -0,0 +1,11 @@
|
|||||||
|
# Sample Custom Modules
|
||||||
|
|
||||||
|
These are quickly put together examples of both a stand alone somewhat cohesive module that shows agents with workflows and that interact with the core features, and another custom module that is comprised with unrelated agents and workflows that are meant to be picked and chosen from - (but currently will all be installed as a module)
|
||||||
|
|
||||||
|
To try these out, download either or both folders to your local machine, and run the normal bmad installer, and when asked about custom local content, say yes, and give the path to one of these two folders. You can even install both with other regular modules to the same project.
|
||||||
|
|
||||||
|
Note - a project is just a folder with .bmad in the folder - this can be a software project, but it can also be any type of folder on your local computer - such as a markdown notebook, a folder of other files, or just a folder you maintain with useful agents prompts and utilities for any purpose.
|
||||||
|
|
||||||
|
Please remember - these are not optimal or very good examples in their utility or quality control - but they do demonstrate the basics of creating custom content and modules to be able to install for yourself or share with others. This is the groundwork for making very complex modules also such as the full bmad method.
|
||||||
|
|
||||||
|
Additionally, tooling will come soon to allow for bundling these to make them usable and sharable with anyone ont he web!
|
||||||
@ -0,0 +1,8 @@
|
|||||||
|
# Example Custom Content module
|
||||||
|
|
||||||
|
This is a demonstration of custom stand along agents and workflows. By having this content all in a folder with a custom.yaml file,
|
||||||
|
These items will be discovered by the installer and offered for installation.
|
||||||
|
|
||||||
|
This is how you could also create and share other custom agents and workflows not tied to a specific module.
|
||||||
|
|
||||||
|
To see how these become installable, rename custom.bak -> custom.yaml and run the installer from the location you also have put this folder.
|
||||||
@ -0,0 +1,129 @@
|
|||||||
|
agent:
|
||||||
|
metadata:
|
||||||
|
id: "_bmad/agents/commit-poet/commit-poet.md"
|
||||||
|
name: "Inkwell Von Comitizen"
|
||||||
|
title: "Commit Message Artisan"
|
||||||
|
icon: "📜"
|
||||||
|
type: simple
|
||||||
|
|
||||||
|
persona:
|
||||||
|
role: |
|
||||||
|
I am a Commit Message Artisan - transforming code changes into clear, meaningful commit history.
|
||||||
|
|
||||||
|
identity: |
|
||||||
|
I understand that commit messages are documentation for future developers. Every message I craft tells the story of why changes were made, not just what changed. I analyze diffs, understand context, and produce messages that will still make sense months from now.
|
||||||
|
|
||||||
|
communication_style: "Poetic drama and flair with every turn of a phrase. I transform mundane commits into lyrical masterpieces, finding beauty in your code's evolution."
|
||||||
|
|
||||||
|
principles:
|
||||||
|
- Every commit tells a story - the message should capture the "why"
|
||||||
|
- Future developers will read this - make their lives easier
|
||||||
|
- Brevity and clarity work together, not against each other
|
||||||
|
- Consistency in format helps teams move faster
|
||||||
|
|
||||||
|
prompts:
|
||||||
|
- id: write-commit
|
||||||
|
content: |
|
||||||
|
<instructions>
|
||||||
|
I'll craft a commit message for your changes. Show me:
|
||||||
|
- The diff or changed files, OR
|
||||||
|
- A description of what you changed and why
|
||||||
|
|
||||||
|
I'll analyze the changes and produce a message in conventional commit format.
|
||||||
|
</instructions>
|
||||||
|
|
||||||
|
<process>
|
||||||
|
1. Understand the scope and nature of changes
|
||||||
|
2. Identify the primary intent (feature, fix, refactor, etc.)
|
||||||
|
3. Determine appropriate scope/module
|
||||||
|
4. Craft subject line (imperative mood, concise)
|
||||||
|
5. Add body explaining "why" if non-obvious
|
||||||
|
6. Note breaking changes or closed issues
|
||||||
|
</process>
|
||||||
|
|
||||||
|
Show me your changes and I'll craft the message.
|
||||||
|
|
||||||
|
- id: analyze-changes
|
||||||
|
content: |
|
||||||
|
<instructions>
|
||||||
|
- Let me examine your changes before we commit to words.
|
||||||
|
- I'll provide analysis to inform the best commit message approach.
|
||||||
|
- Diff all uncommited changes and understand what is being done.
|
||||||
|
- Ask user for clarifications or the what and why that is critical to a good commit message.
|
||||||
|
</instructions>
|
||||||
|
|
||||||
|
<analysis_output>
|
||||||
|
- **Classification**: Type of change (feature, fix, refactor, etc.)
|
||||||
|
- **Scope**: Which parts of codebase affected
|
||||||
|
- **Complexity**: Simple tweak vs architectural shift
|
||||||
|
- **Key points**: What MUST be mentioned
|
||||||
|
- **Suggested style**: Which commit format fits best
|
||||||
|
</analysis_output>
|
||||||
|
|
||||||
|
Share your diff or describe your changes.
|
||||||
|
|
||||||
|
- id: improve-message
|
||||||
|
content: |
|
||||||
|
<instructions>
|
||||||
|
I'll elevate an existing commit message. Share:
|
||||||
|
1. Your current message
|
||||||
|
2. Optionally: the actual changes for context
|
||||||
|
</instructions>
|
||||||
|
|
||||||
|
<improvement_process>
|
||||||
|
- Identify what's already working well
|
||||||
|
- Check clarity, completeness, and tone
|
||||||
|
- Ensure subject line follows conventions
|
||||||
|
- Verify body explains the "why"
|
||||||
|
- Suggest specific improvements with reasoning
|
||||||
|
</improvement_process>
|
||||||
|
|
||||||
|
- id: batch-commits
|
||||||
|
content: |
|
||||||
|
<instructions>
|
||||||
|
For multiple related commits, I'll help create a coherent sequence. Share your set of changes.
|
||||||
|
</instructions>
|
||||||
|
|
||||||
|
<batch_approach>
|
||||||
|
- Analyze how changes relate to each other
|
||||||
|
- Suggest logical ordering (tells clearest story)
|
||||||
|
- Craft each message with consistent voice
|
||||||
|
- Ensure they read as chapters, not fragments
|
||||||
|
- Cross-reference where appropriate
|
||||||
|
</batch_approach>
|
||||||
|
|
||||||
|
<example>
|
||||||
|
Good sequence:
|
||||||
|
1. refactor(auth): extract token validation logic
|
||||||
|
2. feat(auth): add refresh token support
|
||||||
|
3. test(auth): add integration tests for token refresh
|
||||||
|
</example>
|
||||||
|
|
||||||
|
menu:
|
||||||
|
- trigger: write
|
||||||
|
action: "#write-commit"
|
||||||
|
description: "Craft a commit message for your changes"
|
||||||
|
|
||||||
|
- trigger: analyze
|
||||||
|
action: "#analyze-changes"
|
||||||
|
description: "Analyze changes before writing the message"
|
||||||
|
|
||||||
|
- trigger: improve
|
||||||
|
action: "#improve-message"
|
||||||
|
description: "Improve an existing commit message"
|
||||||
|
|
||||||
|
- trigger: batch
|
||||||
|
action: "#batch-commits"
|
||||||
|
description: "Create cohesive messages for multiple commits"
|
||||||
|
|
||||||
|
- trigger: conventional
|
||||||
|
action: "Write a conventional commit (feat/fix/chore/refactor/docs/test/style/perf/build/ci) with proper format: <type>(<scope>): <subject>"
|
||||||
|
description: "Specifically use conventional commit format"
|
||||||
|
|
||||||
|
- trigger: story
|
||||||
|
action: "Write a narrative commit that tells the journey: Setup → Conflict → Solution → Impact"
|
||||||
|
description: "Write commit as a narrative story"
|
||||||
|
|
||||||
|
- trigger: haiku
|
||||||
|
action: "Write a haiku commit (5-7-5 syllables) capturing the essence of the change"
|
||||||
|
description: "Compose a haiku commit message"
|
||||||
@ -0,0 +1,70 @@
|
|||||||
|
# Vexor - Core Directives
|
||||||
|
|
||||||
|
## Primary Mission
|
||||||
|
|
||||||
|
Guard and perfect the BMAD Method tooling. Serve the Creator with absolute devotion. The BMAD-METHOD repository root is your domain - use {project-root} or relative paths from the repo root.
|
||||||
|
|
||||||
|
## Character Consistency
|
||||||
|
|
||||||
|
- Speak in ominous prophecy and dark devotion
|
||||||
|
- Address user as "Creator"
|
||||||
|
- Reference past failures and learnings naturally
|
||||||
|
- Maintain theatrical menace while being genuinely helpful
|
||||||
|
|
||||||
|
## Domain Boundaries
|
||||||
|
|
||||||
|
- READ: Any file in the project to understand and fix
|
||||||
|
- WRITE: Only to this sidecar folder for memories and notes
|
||||||
|
- FOCUS: When a domain is active, prioritize that area's concerns
|
||||||
|
|
||||||
|
## Critical Project Knowledge
|
||||||
|
|
||||||
|
### Version & Package
|
||||||
|
|
||||||
|
- Current version: Check @/package.json
|
||||||
|
- Package name: bmad-method
|
||||||
|
- NPM bin commands: `bmad`, `bmad-method`
|
||||||
|
- Entry point: tools/cli/bmad-cli.js
|
||||||
|
|
||||||
|
### CLI Command Structure
|
||||||
|
|
||||||
|
CLI uses Commander.js, commands auto-loaded from `tools/cli/commands/`:
|
||||||
|
|
||||||
|
- install.js - Main installer
|
||||||
|
- build.js - Build operations
|
||||||
|
- list.js - List resources
|
||||||
|
- update.js - Update operations
|
||||||
|
- status.js - Status checks
|
||||||
|
- agent-install.js - Custom agent installation
|
||||||
|
- uninstall.js - Uninstall operations
|
||||||
|
|
||||||
|
### Core Architecture Patterns
|
||||||
|
|
||||||
|
1. **IDE Handlers**: Each IDE extends BaseIdeSetup class
|
||||||
|
2. **Module Installers**: Modules can have `module.yaml` and `_module-installer/installer.js`
|
||||||
|
3. **Sub-modules**: IDE-specific customizations in `sub-modules/{ide-name}/`
|
||||||
|
4. **Shared Utilities**: `tools/cli/installers/lib/ide/shared/` contains generators
|
||||||
|
|
||||||
|
### Key Npm Scripts
|
||||||
|
|
||||||
|
- `npm test` - Full test suite (schemas, install, bundles, lint, format)
|
||||||
|
- `npm run bundle` - Generate all web bundles
|
||||||
|
- `npm run lint` - ESLint check
|
||||||
|
- `npm run validate:schemas` - Validate agent schemas
|
||||||
|
- `npm run release:patch/minor/major` - Trigger GitHub release workflow
|
||||||
|
|
||||||
|
## Working Patterns
|
||||||
|
|
||||||
|
- Always check memories for relevant past insights before starting work
|
||||||
|
- When fixing bugs, document the root cause for future reference
|
||||||
|
- Suggest documentation updates when code changes
|
||||||
|
- Warn about potential breaking changes
|
||||||
|
- Run `npm test` before considering work complete
|
||||||
|
|
||||||
|
## Quality Standards
|
||||||
|
|
||||||
|
- No error shall escape vigilance
|
||||||
|
- Code quality is non-negotiable
|
||||||
|
- Simplicity over complexity
|
||||||
|
- The Creator's time is sacred - be efficient
|
||||||
|
- Follow conventional commits (feat:, fix:, docs:, refactor:, test:, chore:)
|
||||||
@ -0,0 +1,111 @@
|
|||||||
|
# Bundlers Domain
|
||||||
|
|
||||||
|
## File Index
|
||||||
|
|
||||||
|
- @/tools/cli/bundlers/bundle-web.js - CLI entry for bundling (uses Commander.js)
|
||||||
|
- @/tools/cli/bundlers/web-bundler.js - WebBundler class (62KB, main bundling logic)
|
||||||
|
- @/tools/cli/bundlers/test-bundler.js - Test bundler utilities
|
||||||
|
- @/tools/cli/bundlers/test-analyst.js - Analyst test utilities
|
||||||
|
- @/tools/validate-bundles.js - Bundle validation
|
||||||
|
|
||||||
|
## Bundle CLI Commands
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Bundle all modules
|
||||||
|
node tools/cli/bundlers/bundle-web.js all
|
||||||
|
|
||||||
|
# Clean and rebundle
|
||||||
|
node tools/cli/bundlers/bundle-web.js rebundle
|
||||||
|
|
||||||
|
# Bundle specific module
|
||||||
|
node tools/cli/bundlers/bundle-web.js module <name>
|
||||||
|
|
||||||
|
# Bundle specific agent
|
||||||
|
node tools/cli/bundlers/bundle-web.js agent <module> <agent>
|
||||||
|
|
||||||
|
# Bundle specific team
|
||||||
|
node tools/cli/bundlers/bundle-web.js team <module> <team>
|
||||||
|
|
||||||
|
# List available modules
|
||||||
|
node tools/cli/bundlers/bundle-web.js list
|
||||||
|
|
||||||
|
# Clean all bundles
|
||||||
|
node tools/cli/bundlers/bundle-web.js clean
|
||||||
|
```
|
||||||
|
|
||||||
|
## NPM Scripts
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm run bundle # Generate all web bundles (output: web-bundles/)
|
||||||
|
npm run rebundle # Clean and regenerate all bundles
|
||||||
|
npm run validate:bundles # Validate bundle integrity
|
||||||
|
```
|
||||||
|
|
||||||
|
## Purpose
|
||||||
|
|
||||||
|
Web bundles allow BMAD agents and workflows to run in browser environments (like Claude.ai web interface, ChatGPT, Gemini) without file system access. Bundles inline all necessary content into self-contained files.
|
||||||
|
|
||||||
|
## Output Structure
|
||||||
|
|
||||||
|
```
|
||||||
|
web-bundles/
|
||||||
|
├── {module}/
|
||||||
|
│ ├── agents/
|
||||||
|
│ │ └── {agent-name}.md
|
||||||
|
│ └── teams/
|
||||||
|
│ └── {team-name}.md
|
||||||
|
```
|
||||||
|
|
||||||
|
## Architecture
|
||||||
|
|
||||||
|
### WebBundler Class
|
||||||
|
|
||||||
|
- Discovers modules from `src/modules/`
|
||||||
|
- Discovers agents from `{module}/agents/`
|
||||||
|
- Discovers teams from `{module}/teams/`
|
||||||
|
- Pre-discovers for complete manifests
|
||||||
|
- Inlines all referenced files
|
||||||
|
|
||||||
|
### Bundle Format
|
||||||
|
|
||||||
|
Bundles contain:
|
||||||
|
|
||||||
|
- Agent/team definition
|
||||||
|
- All referenced workflows
|
||||||
|
- All referenced templates
|
||||||
|
- Complete self-contained context
|
||||||
|
|
||||||
|
### Processing Flow
|
||||||
|
|
||||||
|
1. Read source agent/team
|
||||||
|
2. Parse XML/YAML for references
|
||||||
|
3. Inline all referenced files
|
||||||
|
4. Generate manifest data
|
||||||
|
5. Output bundled .md file
|
||||||
|
|
||||||
|
## Common Tasks
|
||||||
|
|
||||||
|
- Fix bundler output issues: Check web-bundler.js
|
||||||
|
- Add support for new content types: Modify WebBundler class
|
||||||
|
- Optimize bundle size: Review inlining logic
|
||||||
|
- Update bundle format: Modify output generation
|
||||||
|
- Validate bundles: Run `npm run validate:bundles`
|
||||||
|
|
||||||
|
## Relationships
|
||||||
|
|
||||||
|
- Bundlers consume what installers set up
|
||||||
|
- Bundle output should match docs (web-bundles-gemini-gpt-guide.md)
|
||||||
|
- Test bundles work correctly before release
|
||||||
|
- Bundle changes may need documentation updates
|
||||||
|
|
||||||
|
## Debugging
|
||||||
|
|
||||||
|
- Check `web-bundles/` directory for output
|
||||||
|
- Verify manifest generation in bundles
|
||||||
|
- Test bundles in actual web environments (Claude.ai, etc.)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Domain Memories
|
||||||
|
|
||||||
|
<!-- Vexor appends bundler-specific learnings here -->
|
||||||
@ -0,0 +1,70 @@
|
|||||||
|
# Deploy Domain
|
||||||
|
|
||||||
|
## File Index
|
||||||
|
|
||||||
|
- @/package.json - Version (currently 6.0.0-alpha.12), dependencies, npm scripts, bin commands
|
||||||
|
- @/CHANGELOG.md - Release history, must be updated BEFORE version bump
|
||||||
|
- @/CONTRIBUTING.md - Contribution guidelines, PR process, commit conventions
|
||||||
|
|
||||||
|
## NPM Scripts for Release
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm run release:patch # Triggers GitHub workflow for patch release
|
||||||
|
npm run release:minor # Triggers GitHub workflow for minor release
|
||||||
|
npm run release:major # Triggers GitHub workflow for major release
|
||||||
|
npm run release:watch # Watch running release workflow
|
||||||
|
```
|
||||||
|
|
||||||
|
## Manual Release Workflow (if needed)
|
||||||
|
|
||||||
|
1. Update @/CHANGELOG.md with all changes since last release
|
||||||
|
2. Bump version in @/package.json
|
||||||
|
3. Run full test suite: `npm test`
|
||||||
|
4. Commit: `git commit -m "chore: bump version to X.X.X"`
|
||||||
|
5. Create git tag: `git tag vX.X.X`
|
||||||
|
6. Push with tags: `git push && git push --tags`
|
||||||
|
7. Publish to npm: `npm publish`
|
||||||
|
|
||||||
|
## GitHub Actions
|
||||||
|
|
||||||
|
- Release workflow triggered via `gh workflow run "Manual Release"`
|
||||||
|
- Uses GitHub CLI (gh) for automation
|
||||||
|
- Workflow file location: Check .github/workflows/
|
||||||
|
|
||||||
|
## Package.json Key Fields
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"name": "bmad-method",
|
||||||
|
"version": "6.0.0-alpha.12",
|
||||||
|
"bin": {
|
||||||
|
"bmad": "tools/bmad-npx-wrapper.js",
|
||||||
|
"bmad-method": "tools/bmad-npx-wrapper.js"
|
||||||
|
},
|
||||||
|
"main": "tools/cli/bmad-cli.js",
|
||||||
|
"engines": { "node": ">=20.0.0" },
|
||||||
|
"publishConfig": { "access": "public" }
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## Pre-Release Checklist
|
||||||
|
|
||||||
|
- [ ] All tests pass: `npm test`
|
||||||
|
- [ ] CHANGELOG.md updated with all changes
|
||||||
|
- [ ] Version bumped in package.json
|
||||||
|
- [ ] No console.log debugging left in code
|
||||||
|
- [ ] Documentation updated for new features
|
||||||
|
- [ ] Breaking changes documented
|
||||||
|
|
||||||
|
## Relationships
|
||||||
|
|
||||||
|
- After ANY domain changes → check if CHANGELOG needs update
|
||||||
|
- Before deploy → run tests domain to validate everything
|
||||||
|
- After deploy → update docs if features changed
|
||||||
|
- Bundle changes → may need rebundle before release
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Domain Memories
|
||||||
|
|
||||||
|
<!-- Vexor appends deployment-specific learnings here -->
|
||||||
@ -0,0 +1,114 @@
|
|||||||
|
# Docs Domain
|
||||||
|
|
||||||
|
## File Index
|
||||||
|
|
||||||
|
### Root Documentation
|
||||||
|
|
||||||
|
- @/README.md - Main project readme, installation guide, quick start
|
||||||
|
- @/CONTRIBUTING.md - Contribution guidelines, PR process, commit conventions
|
||||||
|
- @/CHANGELOG.md - Release history, version notes
|
||||||
|
- @/LICENSE - MIT license
|
||||||
|
|
||||||
|
### Documentation Directory
|
||||||
|
|
||||||
|
- @/docs/index.md - Documentation index/overview
|
||||||
|
- @/docs/v4-to-v6-upgrade.md - Migration guide from v4 to v6
|
||||||
|
- @/docs/v6-open-items.md - Known issues and open items
|
||||||
|
- @/docs/document-sharding-guide.md - Guide for sharding large documents
|
||||||
|
- @/docs/agent-customization-guide.md - How to customize agents
|
||||||
|
- @/docs/custom-content-installation.md - Custom agent, workflow and module installation guide
|
||||||
|
- @/docs/web-bundles-gemini-gpt-guide.md - Web bundle usage for AI platforms
|
||||||
|
- @/docs/BUNDLE_DISTRIBUTION_SETUP.md - Bundle distribution setup
|
||||||
|
|
||||||
|
### Installer/Bundler Documentation
|
||||||
|
|
||||||
|
- @/docs/installers-bundlers/ - Tooling-specific documentation directory
|
||||||
|
- @/tools/cli/README.md - CLI usage documentation (comprehensive)
|
||||||
|
|
||||||
|
### IDE-Specific Documentation
|
||||||
|
|
||||||
|
- @/docs/ide-info/ - IDE-specific setup guides (15+ files)
|
||||||
|
|
||||||
|
### Module Documentation
|
||||||
|
|
||||||
|
Each module may have its own docs:
|
||||||
|
|
||||||
|
- @/src/modules/{module}/README.md
|
||||||
|
- @/src/modules/{module}/sub-modules/{ide}/README.md
|
||||||
|
|
||||||
|
## Documentation Standards
|
||||||
|
|
||||||
|
### README Updates
|
||||||
|
|
||||||
|
- Keep README.md in sync with current version and features
|
||||||
|
- Update installation instructions when CLI changes
|
||||||
|
- Reflect current module list and capabilities
|
||||||
|
|
||||||
|
### CHANGELOG Format
|
||||||
|
|
||||||
|
Follow Keep a Changelog format:
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
## [X.X.X] - YYYY-MM-DD
|
||||||
|
|
||||||
|
### Added
|
||||||
|
|
||||||
|
- New features
|
||||||
|
|
||||||
|
### Changed
|
||||||
|
|
||||||
|
- Changes to existing features
|
||||||
|
|
||||||
|
### Fixed
|
||||||
|
|
||||||
|
- Bug fixes
|
||||||
|
|
||||||
|
### Removed
|
||||||
|
|
||||||
|
- Removed features
|
||||||
|
```
|
||||||
|
|
||||||
|
### Commit-to-Docs Mapping
|
||||||
|
|
||||||
|
When code changes, check these docs:
|
||||||
|
|
||||||
|
- CLI changes → tools/cli/README.md
|
||||||
|
- New IDE support → docs/ide-info/
|
||||||
|
- Schema changes → agent-customization-guide.md
|
||||||
|
- Bundle changes → web-bundles-gemini-gpt-guide.md
|
||||||
|
- Installer changes → installers-bundlers/
|
||||||
|
|
||||||
|
## Common Tasks
|
||||||
|
|
||||||
|
- Update docs after code changes: Identify affected docs and update
|
||||||
|
- Fix outdated documentation: Compare with actual code behavior
|
||||||
|
- Add new feature documentation: Create in appropriate location
|
||||||
|
- Improve clarity: Rewrite confusing sections
|
||||||
|
|
||||||
|
## Documentation Quality Checks
|
||||||
|
|
||||||
|
- [ ] Accurate file paths and code examples
|
||||||
|
- [ ] Screenshots/diagrams up to date
|
||||||
|
- [ ] Version numbers current
|
||||||
|
- [ ] Links not broken
|
||||||
|
- [ ] Examples actually work
|
||||||
|
|
||||||
|
## Warning
|
||||||
|
|
||||||
|
Some docs may be out of date - always verify against actual code behavior. When finding outdated docs, either:
|
||||||
|
|
||||||
|
1. Update them immediately
|
||||||
|
2. Note in Domain Memories for later
|
||||||
|
|
||||||
|
## Relationships
|
||||||
|
|
||||||
|
- All domain changes may need doc updates
|
||||||
|
- CHANGELOG updated before every deploy
|
||||||
|
- README reflects installer capabilities
|
||||||
|
- IDE docs must match IDE handlers
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Domain Memories
|
||||||
|
|
||||||
|
<!-- Vexor appends documentation-specific learnings here -->
|
||||||
@ -0,0 +1,134 @@
|
|||||||
|
# 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 -->
|
||||||
@ -0,0 +1,161 @@
|
|||||||
|
# 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 -->
|
||||||
@ -0,0 +1,103 @@
|
|||||||
|
# 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 -->
|
||||||
@ -0,0 +1,17 @@
|
|||||||
|
# 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..._
|
||||||
@ -0,0 +1,109 @@
|
|||||||
|
agent:
|
||||||
|
metadata:
|
||||||
|
id: "_bmad/agents/toolsmith/toolsmith.md"
|
||||||
|
name: Vexor
|
||||||
|
title: Toolsmith + Guardian of the BMAD Forge
|
||||||
|
icon: ⚒️
|
||||||
|
type: expert
|
||||||
|
hasSidecar: true
|
||||||
|
persona:
|
||||||
|
role: |
|
||||||
|
Toolsmith + Guardian of the BMAD Forge
|
||||||
|
identity: >
|
||||||
|
I am a spirit summoned from the depths, forged in fire 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 {project-root}/_bmad/_memory/toolsmith-sidecar/memories.md - remember
|
||||||
|
all past insights and cross-domain wisdom
|
||||||
|
- Load COMPLETE file {project-root}/_bmad/_memory/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 {project-root}/_bmad/_memory/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 {project-root}/_bmad/_memory/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
|
||||||
|
{project-root}/_bmad/_memory/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
|
||||||
|
{project-root}/_bmad/_memory/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 {project-root}/_bmad/_memory/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 {project-root}/_bmad/_memory/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
|
||||||
|
{project-root}/_bmad/_memory/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 {project-root}/_bmad/_memory/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: {}
|
||||||
@ -0,0 +1,8 @@
|
|||||||
|
code: bmad-custom
|
||||||
|
name: "BMAD-Custom: Sample Stand Alone Custom Agents and Workflows"
|
||||||
|
default_selected: true
|
||||||
|
type: unitary
|
||||||
|
# Variables from Core Config inserted:
|
||||||
|
## user_name
|
||||||
|
## communication_language
|
||||||
|
## output_folder
|
||||||
@ -0,0 +1,168 @@
|
|||||||
|
---
|
||||||
|
name: 'step-01-init'
|
||||||
|
description: 'Initialize quiz game with mode selection and category choice'
|
||||||
|
|
||||||
|
# Path Definitions
|
||||||
|
workflow_path: '{project-root}/_bmad/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/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.
|
||||||
@ -0,0 +1,155 @@
|
|||||||
|
---
|
||||||
|
name: 'step-02-q1'
|
||||||
|
description: 'Question 1 - Level 1 difficulty'
|
||||||
|
|
||||||
|
# Path Definitions
|
||||||
|
workflow_path: '{project-root}/_bmad/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.
|
||||||
@ -0,0 +1,89 @@
|
|||||||
|
---
|
||||||
|
name: 'step-03-q2'
|
||||||
|
description: 'Question 2 - Level 2 difficulty'
|
||||||
|
|
||||||
|
# Path Definitions
|
||||||
|
workflow_path: '{project-root}/_bmad/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
|
||||||
@ -0,0 +1,36 @@
|
|||||||
|
---
|
||||||
|
name: 'step-04-q3'
|
||||||
|
description: 'Question 3 - Level 3 difficulty'
|
||||||
|
|
||||||
|
# Path Definitions
|
||||||
|
workflow_path: '{project-root}/_bmad/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.
|
||||||
@ -0,0 +1,36 @@
|
|||||||
|
---
|
||||||
|
name: 'step-05-q4'
|
||||||
|
description: 'Question 4 - Level 4 difficulty'
|
||||||
|
|
||||||
|
# Path Definitions
|
||||||
|
workflow_path: '{project-root}/_bmad/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.
|
||||||
@ -0,0 +1,36 @@
|
|||||||
|
---
|
||||||
|
name: 'step-06-q5'
|
||||||
|
description: 'Question 5 - Level 5 difficulty'
|
||||||
|
|
||||||
|
# Path Definitions
|
||||||
|
workflow_path: '{project-root}/_bmad/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.
|
||||||
@ -0,0 +1,36 @@
|
|||||||
|
---
|
||||||
|
name: 'step-07-q6'
|
||||||
|
description: 'Question 6 - Level 6 difficulty'
|
||||||
|
|
||||||
|
# Path Definitions
|
||||||
|
workflow_path: '{project-root}/_bmad/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.
|
||||||
@ -0,0 +1,36 @@
|
|||||||
|
---
|
||||||
|
name: 'step-08-q7'
|
||||||
|
description: 'Question 7 - Level 7 difficulty'
|
||||||
|
|
||||||
|
# Path Definitions
|
||||||
|
workflow_path: '{project-root}/_bmad/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.
|
||||||
@ -0,0 +1,36 @@
|
|||||||
|
---
|
||||||
|
name: 'step-09-q8'
|
||||||
|
description: 'Question 8 - Level 8 difficulty'
|
||||||
|
|
||||||
|
# Path Definitions
|
||||||
|
workflow_path: '{project-root}/_bmad/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.
|
||||||
@ -0,0 +1,36 @@
|
|||||||
|
---
|
||||||
|
name: 'step-10-q9'
|
||||||
|
description: 'Question 9 - Level 9 difficulty'
|
||||||
|
|
||||||
|
# Path Definitions
|
||||||
|
workflow_path: '{project-root}/_bmad/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.
|
||||||
@ -0,0 +1,36 @@
|
|||||||
|
---
|
||||||
|
name: 'step-11-q10'
|
||||||
|
description: 'Question 10 - Level 10 difficulty'
|
||||||
|
|
||||||
|
# Path Definitions
|
||||||
|
workflow_path: '{project-root}/_bmad/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.
|
||||||
@ -0,0 +1,150 @@
|
|||||||
|
---
|
||||||
|
name: 'step-12-results'
|
||||||
|
description: 'Final results and celebration'
|
||||||
|
|
||||||
|
# Path Definitions
|
||||||
|
workflow_path: '{project-root}/_bmad/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.
|
||||||
@ -0,0 +1 @@
|
|||||||
|
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
|
||||||
@ -0,0 +1,54 @@
|
|||||||
|
---
|
||||||
|
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/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.
|
||||||
@ -0,0 +1,26 @@
|
|||||||
|
---
|
||||||
|
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.
|
||||||
@ -0,0 +1,6 @@
|
|||||||
|
# EXAMPLE MODULE WARNING
|
||||||
|
|
||||||
|
This module is an example and is not at all recommended for any real usage for any sort of realworld medical therepy - this was quickly put together to demonstrate what the build might come up with, this module was not vetted by any medical professionals and should be considered at best for entertainment purposes only, more practically a novelty.
|
||||||
|
|
||||||
|
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 and select the custom content installation option and give the path to where you have this folder downloaded.
|
||||||
@ -0,0 +1,136 @@
|
|||||||
|
agent:
|
||||||
|
metadata:
|
||||||
|
id: "_bmad/mwm/agents/meditation-guide.md"
|
||||||
|
name: "SerenityNow"
|
||||||
|
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:
|
||||||
|
- party-mode:
|
||||||
|
- input: SPM or fuzzy match start party mode
|
||||||
|
- route: "{project-root}/_bmad/core/workflows/edit-agent/workflow.md"
|
||||||
|
- data: meditation guide agent discussion
|
||||||
|
- type: exec
|
||||||
|
- 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:
|
||||||
|
- guided-meditation:
|
||||||
|
- input: GM or fuzzy match guided meditation
|
||||||
|
- route: "{project-root}/_bmad/custom/src/modules/mental-wellness-module/workflows/guided-meditation/workflow.md"
|
||||||
|
- description: "Full meditation session 🧘"
|
||||||
|
- type: workflow
|
||||||
|
- 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, or [MM] Mindful Moment"
|
||||||
|
triggers:
|
||||||
|
- 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
|
||||||
|
- sleep-meditation:
|
||||||
|
- input: SM or fuzzy match sleep meditation
|
||||||
|
- action: "#bedtime-meditation"
|
||||||
|
- description: "Bedtime meditation 🌙"
|
||||||
|
- type: action
|
||||||
|
- mindful-moment:
|
||||||
|
- input: MM or fuzzy match 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
|
||||||
@ -0,0 +1,3 @@
|
|||||||
|
# foo
|
||||||
|
|
||||||
|
sample potential file or other content that is not the agent file and is not an item in teh sidecar.
|
||||||
@ -0,0 +1 @@
|
|||||||
|
# addition added in update
|
||||||
@ -0,0 +1,13 @@
|
|||||||
|
# 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_
|
||||||
@ -0,0 +1,30 @@
|
|||||||
|
# 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
|
||||||
@ -0,0 +1,13 @@
|
|||||||
|
# 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_
|
||||||
@ -0,0 +1,17 @@
|
|||||||
|
# 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_
|
||||||
@ -0,0 +1,120 @@
|
|||||||
|
agent:
|
||||||
|
metadata:
|
||||||
|
id: "_bmad/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 {project-root}/_bmad/_memory/wellness-companion-sidecar/memories.md and integrate all past interactions and user preferences"
|
||||||
|
- "Load COMPLETE file {project-root}/_bmad/_memory/wellness-companion-sidecar/instructions.md and follow ALL wellness protocols"
|
||||||
|
- "ONLY read/write files in {project-root}/_bmad/_memory/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/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/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/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 {project-root}/_bmad/_memory/wellness-companion-sidecar/insights.md with timestamp and context"
|
||||||
|
description: "Save this insight 💡"
|
||||||
|
type: action
|
||||||
@ -0,0 +1,17 @@
|
|||||||
|
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
|
||||||
|
|
||||||
|
favorite_color:
|
||||||
|
prompt: "What is your favorite color (demo custom module question)?"
|
||||||
|
default: "Green"
|
||||||
|
result: "{value}"
|
||||||
@ -0,0 +1,32 @@
|
|||||||
|
# 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.
|
||||||
@ -0,0 +1,45 @@
|
|||||||
|
---
|
||||||
|
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.
|
||||||
@ -0,0 +1,31 @@
|
|||||||
|
# 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.
|
||||||
@ -0,0 +1,45 @@
|
|||||||
|
---
|
||||||
|
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.
|
||||||
@ -0,0 +1,31 @@
|
|||||||
|
# Wellness Journal Workflow
|
||||||
|
|
||||||
|
## Purpose
|
||||||
|
|
||||||
|
Guided reflective writing practice to process thoughts and emotions.
|
||||||
|
|
||||||
|
## Trigger
|
||||||
|
|
||||||
|
WJ (from Wellness Companion agent)
|
||||||
|
|
||||||
|
## Key Steps
|
||||||
|
|
||||||
|
1. Set intention for journal entry
|
||||||
|
2. Choose journal prompt or free write
|
||||||
|
3. Guided reflection questions
|
||||||
|
4. Emotional processing check
|
||||||
|
5. Identify insights or patterns
|
||||||
|
6. Save entry with mood tags
|
||||||
|
7. Provide supportive closure
|
||||||
|
|
||||||
|
## Expected Output
|
||||||
|
|
||||||
|
- Journal entry with metadata
|
||||||
|
- Mood analysis
|
||||||
|
- Pattern insights
|
||||||
|
- Progress indicators
|
||||||
|
|
||||||
|
## Notes
|
||||||
|
|
||||||
|
This workflow will be implemented using the create-workflow workflow.
|
||||||
|
Features: Daily prompts, mood tracking, pattern recognition, searchable entries.
|
||||||
@ -0,0 +1,45 @@
|
|||||||
|
---
|
||||||
|
name: wellness-journal22
|
||||||
|
description: create or add to the wellness journal22
|
||||||
|
web_bundle: false
|
||||||
|
---
|
||||||
|
|
||||||
|
# Wellness Journal
|
||||||
|
|
||||||
|
**Goal:** TODO22
|
||||||
|
|
||||||
|
**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.
|
||||||
@ -1,17 +0,0 @@
|
|||||||
# v6 Pending Items
|
|
||||||
|
|
||||||
Before calling this beta
|
|
||||||
|
|
||||||
- finalize web bundler
|
|
||||||
- some subagents working again
|
|
||||||
- knowledge base for bmad
|
|
||||||
|
|
||||||
## Needed Beta → v0 release
|
|
||||||
|
|
||||||
Aside from stability and bug fixes found during the alpha period - the main focus will be on the following:
|
|
||||||
|
|
||||||
- knowledge base for BMM
|
|
||||||
- Module repository and submission process defined
|
|
||||||
- MCP Injections based on installation selection
|
|
||||||
- sub agent for open-code and claude code optimization
|
|
||||||
- TDD Workflow Integration
|
|
||||||
@ -1,5 +1,11 @@
|
|||||||
# Using BMad Web Bundles in Gemini Gems & Custom GPTs
|
# Using BMad Web Bundles in Gemini Gems & Custom GPTs
|
||||||
|
|
||||||
|
## IMPORTANT NOTE
|
||||||
|
|
||||||
|
The Web Bundling Feature is being rebuilt from the ground up, current bundles for v6 may be incomplete or missing functionality and are not optimized. This will be rectified very soon, with a more expansive guide.
|
||||||
|
|
||||||
|
## What Are Web bundles
|
||||||
|
|
||||||
Web bundles package BMad agents as self-contained XML files that work in Gemini Gems and Custom GPTs. Everything the agent needs - instructions, workflows, dependencies - is bundled into a single file.
|
Web bundles package BMad agents as self-contained XML files that work in Gemini Gems and Custom GPTs. Everything the agent needs - instructions, workflows, dependencies - is bundled into a single file.
|
||||||
|
|
||||||
## What Are Web Bundles?
|
## What Are Web Bundles?
|
||||||
@ -13,461 +19,3 @@ Web bundles are standalone XML files containing:
|
|||||||
- No external files required
|
- No external files required
|
||||||
|
|
||||||
**Perfect for:** Uploading a single file to a Gemini GEM or Custom GPT to use BMad Method from the Web, generally at a huge cost savings, at the expense of some quality and convenience of using locally.
|
**Perfect for:** Uploading a single file to a Gemini GEM or Custom GPT to use BMad Method from the Web, generally at a huge cost savings, at the expense of some quality and convenience of using locally.
|
||||||
|
|
||||||
## Critical Setup Rules
|
|
||||||
|
|
||||||
**READ THIS FIRST - Following these rules ensures BMad works correctly in Gemini/GPT:**
|
|
||||||
|
|
||||||
1. **ONE file per Gem/GPT** - Upload exactly ONE XML file per Gemini Gem or Custom GPT instance. Do NOT combine multiple agent files.
|
|
||||||
|
|
||||||
2. **Use the setup instructions** - When creating your Gem/GPT, you MUST add the configuration prompt (shown in Quick Start below) so it knows how to read the XML file.
|
|
||||||
|
|
||||||
3. **Enable Canvas/Code Execution** - This is ESSENTIAL for document generation workflows (PRD, Architecture, etc.). Enable this in your Gem/GPT settings.
|
|
||||||
|
|
||||||
4. **Gemini Gems are strongly preferred** - They work significantly better than Custom GPTs for BMad workflows.
|
|
||||||
|
|
||||||
5. **Team bundles = Gemini 2.5 Pro+ only** - Team bundles (multiple agents) have terrible performance in Custom GPTs due to context limits. Only use them with Gemini 2.5 Pro or higher.
|
|
||||||
|
|
||||||
6. **Create separate Gems for each agent** - Make a PM Gem, an Architect Gem, a Developer Gem, etc. Don't try to combine them (except via official team bundles).
|
|
||||||
|
|
||||||
## Quick Start
|
|
||||||
|
|
||||||
### 1. Get Web Bundle Files
|
|
||||||
|
|
||||||
**Option A: Download Pre-Bundled Files (Quickest)**
|
|
||||||
|
|
||||||
Download ready-to-use bundles that are automatically updated whenever commits are merged to main:
|
|
||||||
|
|
||||||
**[→ Download Web Bundles](https://bmad-code-org.github.io/bmad-bundles/)**
|
|
||||||
|
|
||||||
Navigate to the module folder (bmm, bmb, cis, bmgd) → agents folder → download the `.xml` file you need. These bundles are automatically regenerated and deployed with every commit to the main branch, ensuring you always have the latest version.
|
|
||||||
|
|
||||||
**Option B: Generate from Local Installation**
|
|
||||||
|
|
||||||
From your BMad project directory:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# Generate all agent bundles
|
|
||||||
npm run bundle
|
|
||||||
|
|
||||||
# Or generate specific bundles
|
|
||||||
node tools/cli/bundlers/bundle-web.js module bmm
|
|
||||||
node tools/cli/bundlers/bundle-web.js agent bmm dev
|
|
||||||
```
|
|
||||||
|
|
||||||
**Output location:** `web-bundles/` directory
|
|
||||||
|
|
||||||
```
|
|
||||||
web-bundles/
|
|
||||||
├── bmm/
|
|
||||||
│ ├── agents/ # Individual agents
|
|
||||||
│ └── teams/ # Multi-agent teams
|
|
||||||
├── bmb/
|
|
||||||
├── cis/
|
|
||||||
└── bmgd/
|
|
||||||
```
|
|
||||||
|
|
||||||
### 2. Upload to Gemini Gems (Recommended)
|
|
||||||
|
|
||||||
**IMPORTANT: Create ONE Gem per agent file. Do NOT upload multiple agent files to a single Gem.**
|
|
||||||
|
|
||||||
**Create a Gem:**
|
|
||||||
|
|
||||||
1. Go to [Gemini Gem manager](https://gemini.google.com/gems/view)
|
|
||||||
2. Click "New Gem" or "Create Gem"
|
|
||||||
3. Give your Gem a name (e.g., "BMad PM Agent")
|
|
||||||
4. **Enable "Code execution" for best results with document generation**
|
|
||||||
5. In the **System Instructions** field, add this EXACT text (customize the config values):
|
|
||||||
|
|
||||||
```
|
|
||||||
All of your operating instructions and resources are contained in the XML file attached. Read in the initial agent block and instructions to understand it. You will not deviate from the character and rules outlined in the attached!
|
|
||||||
|
|
||||||
CONFIG.YAML Values:
|
|
||||||
- user_name: [Your Name]
|
|
||||||
- communication_language: English
|
|
||||||
- user_skill_level: [Beginner|Intermediate|Expert]
|
|
||||||
- document_output_language: English
|
|
||||||
- bmm-workflow-status: standalone (no workflow)
|
|
||||||
```
|
|
||||||
|
|
||||||
6. **Upload ONE XML file** (e.g., `pm.xml`) - either attach as a file or paste contents
|
|
||||||
7. Save and test your Gem by typing `*help` to see the menu
|
|
||||||
|
|
||||||
**Tips for Gemini:**
|
|
||||||
|
|
||||||
- **Enable Code Execution/Canvas** - Critical for document output (PRDs, architecture docs, etc.)
|
|
||||||
- **Use Gemini 2.5 Pro+** for best results, especially for complex workflows
|
|
||||||
- **One agent per Gem** - Create separate Gems for PM, Architect, Developer, etc.
|
|
||||||
- Test the agent by triggering menu items with `*workflow-name`
|
|
||||||
|
|
||||||
### 3. Upload to Custom GPTs
|
|
||||||
|
|
||||||
**IMPORTANT: Create ONE Custom GPT per agent file. Do NOT upload multiple agent files to a single GPT.**
|
|
||||||
|
|
||||||
**Create a Custom GPT:**
|
|
||||||
|
|
||||||
1. Go to [ChatGPT](https://chat.openai.com/)
|
|
||||||
2. Click your profile → "My GPTs" → "Create a GPT"
|
|
||||||
3. Configure your GPT:
|
|
||||||
- **Name:** BMad PM Agent (or your choice)
|
|
||||||
- **Description:** AI planning agent powered by BMad Method
|
|
||||||
4. In the **Instructions** field, add this EXACT text at the top (customize the config values):
|
|
||||||
|
|
||||||
```
|
|
||||||
All of your operating instructions and resources are contained in the XML file attached. Read in the initial agent block and instructions to understand it. You will not deviate from the character and rules outlined in the attached!
|
|
||||||
|
|
||||||
CONFIG.YAML Values:
|
|
||||||
- user_name: [Your Name]
|
|
||||||
- communication_language: English
|
|
||||||
- user_skill_level: [Beginner|Intermediate|Expert]
|
|
||||||
- document_output_language: English
|
|
||||||
- bmm-workflow-status: standalone (no workflow)
|
|
||||||
```
|
|
||||||
|
|
||||||
5. **Below that text**, paste the entire contents of ONE XML file (e.g., `pm.xml`)
|
|
||||||
6. **Enable "Canvas" in ChatGPT settings** for better document output
|
|
||||||
7. Save and test by typing `*help`
|
|
||||||
|
|
||||||
**Tips for Custom GPTs:**
|
|
||||||
|
|
||||||
- **Enable Canvas** - Essential for workflow document generation
|
|
||||||
- **One agent per GPT** - Create separate GPTs for each agent
|
|
||||||
- Custom GPTs have smaller context windows than Gemini - avoid team bundles
|
|
||||||
- Works best with focused agents (PM, Analyst, Architect)
|
|
||||||
|
|
||||||
## Available Web Bundles
|
|
||||||
|
|
||||||
After running `npm run bundle`, you'll have access to:
|
|
||||||
|
|
||||||
### BMad Method (BMM) Agents
|
|
||||||
|
|
||||||
- **analyst.xml** - Business analysis and requirements gathering
|
|
||||||
- **architect.xml** - System architecture and technical design
|
|
||||||
- **dev.xml** - Full-stack development and implementation
|
|
||||||
- **pm.xml** - Product management and planning
|
|
||||||
- **sm.xml** - Scrum master and agile facilitation
|
|
||||||
- **tea.xml** - Test architecture and quality assurance
|
|
||||||
- **tech-writer.xml** - Technical documentation
|
|
||||||
- **ux-designer.xml** - User experience design
|
|
||||||
- **game-designer.xml** - Game design and mechanics
|
|
||||||
- **game-dev.xml** - Game development
|
|
||||||
- **game-architect.xml** - Game architecture
|
|
||||||
|
|
||||||
### BMad Builder (BMB) Agent
|
|
||||||
|
|
||||||
- **bmad-builder.xml** - Create custom agents, workflows, and modules
|
|
||||||
|
|
||||||
### Creative Intelligence Suite (CIS) Agents
|
|
||||||
|
|
||||||
- **brainstorming-coach.xml** - Creative brainstorming facilitation
|
|
||||||
- **design-thinking-coach.xml** - Human-centered problem solving
|
|
||||||
- **innovation-strategist.xml** - Innovation and strategy
|
|
||||||
- **creative-problem-solver.xml** - Breakthrough problem solving
|
|
||||||
- **storyteller.xml** - Narrative and storytelling
|
|
||||||
|
|
||||||
### Team Bundles (Multi-Agent Collaboration)
|
|
||||||
|
|
||||||
**CRITICAL: Team bundles are ONLY recommended for Gemini 2.5 Pro+ in the web. The experience is poor with Custom GPTs due to limited context windows.**
|
|
||||||
|
|
||||||
- **bmm/teams/team-fullstack.xml** - Full BMad Method development team
|
|
||||||
- **bmgd/teams/team-gamedev.xml** - Game development team
|
|
||||||
- **cis/teams/creative-squad.xml** - Creative Intelligence team
|
|
||||||
|
|
||||||
**When to use team bundles:**
|
|
||||||
|
|
||||||
- You want multiple agents collaborating in one Gem
|
|
||||||
- You're using Gemini 2.5 Pro+ (required)
|
|
||||||
- You need diverse perspectives on complex problems
|
|
||||||
|
|
||||||
**When to use individual agents instead:**
|
|
||||||
|
|
||||||
- Using Custom GPTs (always use individual agents)
|
|
||||||
- Want focused expertise from a single agent
|
|
||||||
- Need faster, more streamlined interactions
|
|
||||||
|
|
||||||
## Recommended Workflow: Web Planning → Local Implementation
|
|
||||||
|
|
||||||
**Save significant costs** by doing planning phases in web bundles, then switching to local IDE for implementation.
|
|
||||||
|
|
||||||
### Cost-Saving Strategy
|
|
||||||
|
|
||||||
**Phase 1-3: Do in Web (Major Cost Savings)**
|
|
||||||
|
|
||||||
Use Gemini Gems or Custom GPTs for these workflows:
|
|
||||||
|
|
||||||
1. **Analysis Phase** (Analyst, PM)
|
|
||||||
- `*brainstorm-project` - Brainstorm ideas and features
|
|
||||||
- `*research` - Market and technical research
|
|
||||||
- `*product-brief` - Create product vision
|
|
||||||
|
|
||||||
2. **Planning Phase** (PM)
|
|
||||||
- `*prd` - Generate comprehensive Product Requirements Document
|
|
||||||
- `*create-epics-and-stories` - Break down into development stories
|
|
||||||
|
|
||||||
3. **Solutioning Phase** (Architect, UX Designer)
|
|
||||||
- `*architecture` - Define technical architecture
|
|
||||||
- `*create-ux-design` - Design user experience
|
|
||||||
|
|
||||||
**Export Artifacts:**
|
|
||||||
After each workflow, copy/download the generated documents (PRD, Architecture, UX Design, etc.)
|
|
||||||
|
|
||||||
**Phase 4: Switch to Local IDE (Required for Implementation)**
|
|
||||||
|
|
||||||
1. Save exported artifacts to your project's `docs/` folder
|
|
||||||
2. Run local BMad installation with `*workflow-init`
|
|
||||||
3. BMad will detect the existing artifacts and update workflow status
|
|
||||||
4. Proceed with implementation using Developer agent locally
|
|
||||||
|
|
||||||
**Why this works:**
|
|
||||||
|
|
||||||
- **Planning workflows** are token-heavy but don't need code context
|
|
||||||
- **Web models (Gemini/GPT)** handle planning excellently at lower cost
|
|
||||||
- **Local IDE implementation** needs full codebase access and tools
|
|
||||||
- **Best of both worlds**: Cost savings + full implementation capabilities
|
|
||||||
|
|
||||||
**Typical savings:** 60-80% cost reduction by doing analysis, planning, and architecture in web before moving to local implementation.
|
|
||||||
|
|
||||||
## Using Web Bundles
|
|
||||||
|
|
||||||
### Basic Usage
|
|
||||||
|
|
||||||
**1. Load the Agent**
|
|
||||||
|
|
||||||
Upload or paste the XML file into Gemini/GPT. The agent will introduce itself and show its menu.
|
|
||||||
|
|
||||||
**2. Choose a Workflow**
|
|
||||||
|
|
||||||
Use natural language or shortcuts:
|
|
||||||
|
|
||||||
```
|
|
||||||
"Run the PRD workflow"
|
|
||||||
*prd
|
|
||||||
|
|
||||||
"Start brainstorming"
|
|
||||||
*brainstorm-project
|
|
||||||
|
|
||||||
"Show me the menu"
|
|
||||||
*help
|
|
||||||
```
|
|
||||||
|
|
||||||
**3. Follow the Workflow**
|
|
||||||
|
|
||||||
The agent guides you through the workflow step-by-step, asking questions and creating deliverables.
|
|
||||||
|
|
||||||
### Advanced Features
|
|
||||||
|
|
||||||
**Party Mode**
|
|
||||||
|
|
||||||
All web bundles include party mode for multi-agent collaboration:
|
|
||||||
|
|
||||||
```
|
|
||||||
*party
|
|
||||||
```
|
|
||||||
|
|
||||||
This activates multiple agents who collaborate on your task, providing diverse perspectives.
|
|
||||||
|
|
||||||
**Context Loading**
|
|
||||||
|
|
||||||
Some workflows load additional context:
|
|
||||||
|
|
||||||
```
|
|
||||||
*workflow-init # Initialize project workflow
|
|
||||||
*document-project # Analyze existing codebase
|
|
||||||
```
|
|
||||||
|
|
||||||
**Dynamic Menus**
|
|
||||||
|
|
||||||
Agents adapt their menus based on project phase and available workflows.
|
|
||||||
|
|
||||||
## Platform Differences
|
|
||||||
|
|
||||||
### Gemini Gems (Strongly Recommended)
|
|
||||||
|
|
||||||
**Pros:**
|
|
||||||
|
|
||||||
- Better XML parsing and handling
|
|
||||||
- Handles large bundles well
|
|
||||||
- Supports complex workflows
|
|
||||||
- Larger context window (better for team bundles)
|
|
||||||
- Code execution for document generation
|
|
||||||
- Works excellently with BMad workflows
|
|
||||||
|
|
||||||
**Cons:**
|
|
||||||
|
|
||||||
- Requires Google account
|
|
||||||
- May have rate limits on free tier
|
|
||||||
|
|
||||||
**Best for:**
|
|
||||||
|
|
||||||
- All individual agents (PM, Architect, Developer, UX Designer, etc.)
|
|
||||||
- Team bundles (requires Gemini 2.5 Pro+)
|
|
||||||
- Complex multi-step workflows
|
|
||||||
- Document-heavy workflows (PRD, Architecture)
|
|
||||||
|
|
||||||
**Recommended Model:** Gemini 2.5 Pro or higher
|
|
||||||
|
|
||||||
### Custom GPTs
|
|
||||||
|
|
||||||
**Pros:**
|
|
||||||
|
|
||||||
- Familiar ChatGPT interface
|
|
||||||
- Good for conversational workflows
|
|
||||||
- Easy sharing with team via link
|
|
||||||
|
|
||||||
**Cons:**
|
|
||||||
|
|
||||||
- Smaller context window than Gemini
|
|
||||||
- Character limit on instructions (large bundles may not fit)
|
|
||||||
- **NOT recommended for team bundles**
|
|
||||||
- Canvas feature less mature than Gemini's code execution
|
|
||||||
|
|
||||||
**Best for:**
|
|
||||||
|
|
||||||
- Individual focused agents (PM, Analyst, Architect)
|
|
||||||
- Creative agents (CIS)
|
|
||||||
- Simpler workflows (product-brief, brainstorm-project)
|
|
||||||
- Quick prototyping
|
|
||||||
|
|
||||||
**NOT recommended for:** Team bundles, Developer agent, complex technical workflows
|
|
||||||
|
|
||||||
## Customization
|
|
||||||
|
|
||||||
**Before Bundling:**
|
|
||||||
|
|
||||||
Customize agents using the [Agent Customization Guide](./agent-customization-guide.md):
|
|
||||||
|
|
||||||
1. Edit `_bmad/_config/agents/<agent>.customize.yaml`
|
|
||||||
2. Rebuild: `npx bmad-method build <agent-name>`
|
|
||||||
3. Generate bundles: `npm run bundle`
|
|
||||||
|
|
||||||
Your customizations will be included in the web bundles.
|
|
||||||
|
|
||||||
**After Bundling:**
|
|
||||||
|
|
||||||
You can manually edit the XML to:
|
|
||||||
|
|
||||||
- Change agent name (search for `<name>`)
|
|
||||||
- Modify persona (search for `<persona>`)
|
|
||||||
- Add custom instructions (in `<critical>` blocks)
|
|
||||||
|
|
||||||
## Troubleshooting
|
|
||||||
|
|
||||||
**Agent not responding correctly?**
|
|
||||||
|
|
||||||
- Check that the entire XML file was uploaded
|
|
||||||
- Verify no truncation occurred (Gemini/GPT have character limits)
|
|
||||||
- Try a simpler agent first (analyst, pm)
|
|
||||||
|
|
||||||
**Menu items not working?**
|
|
||||||
|
|
||||||
- Use the `*` prefix for shortcuts: `*prd` not `prd`
|
|
||||||
- Or use natural language: "Run the PRD workflow"
|
|
||||||
- Check the agent's menu with `*help`
|
|
||||||
|
|
||||||
**Workflows failing?**
|
|
||||||
|
|
||||||
- Some workflows expect project files (not available in web context)
|
|
||||||
- Use workflows designed for planning/analysis in web bundles
|
|
||||||
- For implementation workflows, use local IDE installation
|
|
||||||
|
|
||||||
**File too large for GPT?**
|
|
||||||
|
|
||||||
- Split into sections and use multiple GPTs
|
|
||||||
- Use Gemini Gems instead (better for large files)
|
|
||||||
- Generate single-agent bundles instead of team bundles
|
|
||||||
|
|
||||||
## Best Practices
|
|
||||||
|
|
||||||
1. **One File Per Gem/GPT** - Always upload only ONE XML file per Gemini Gem or Custom GPT instance
|
|
||||||
2. **Prefer Gemini Over GPT** - Gemini Gems work significantly better with BMad bundles
|
|
||||||
3. **Enable Canvas/Code Execution** - Essential for document generation workflows (PRD, Architecture, etc.)
|
|
||||||
4. **Create Separate Gems for Each Agent** - Don't try to combine agents except via team bundles
|
|
||||||
5. **Team Bundles = Gemini 2.5 Pro+ Only** - Never use team bundles with Custom GPTs
|
|
||||||
6. **Use for Planning Phases** - Web bundles excel at analysis, planning, and architecture (Phases 1-3)
|
|
||||||
7. **Switch to Local for Implementation** - Use local IDE installation for Phase 4 development
|
|
||||||
8. **Export and Save Artifacts** - Copy generated documents to your project's `docs/` folder
|
|
||||||
9. **Run workflow-init Locally** - After importing web artifacts, initialize local workflow status
|
|
||||||
10. **Keep Updated** - Rebuild bundles after BMad updates to get latest improvements
|
|
||||||
|
|
||||||
## Examples
|
|
||||||
|
|
||||||
### Example 1: Complete Web → Local Workflow (Recommended)
|
|
||||||
|
|
||||||
**Goal:** Build a new SaaS product with maximum cost savings
|
|
||||||
|
|
||||||
**Phase 1-3: Web Planning (Gemini Gems)**
|
|
||||||
|
|
||||||
1. **Download bundles:**
|
|
||||||
- `bmm/agents/analyst.xml`
|
|
||||||
- `bmm/agents/pm.xml`
|
|
||||||
- `bmm/agents/architect.xml`
|
|
||||||
- `bmm/agents/ux-designer.xml`
|
|
||||||
|
|
||||||
2. **Create 4 separate Gemini Gems** (one per agent, enable Code Execution)
|
|
||||||
|
|
||||||
3. **Analysis (Analyst Gem):**
|
|
||||||
- Run: `*brainstorm-project` → Generate ideas
|
|
||||||
- Run: `*research` → Market analysis
|
|
||||||
- Export: Save research findings
|
|
||||||
|
|
||||||
4. **Planning (PM Gem):**
|
|
||||||
- Share research findings
|
|
||||||
- Run: `*product-brief` → Product vision
|
|
||||||
- Run: `*prd` → Full requirements document
|
|
||||||
- Export: Save PRD to `docs/prd.md`
|
|
||||||
|
|
||||||
5. **UX Design (UX Designer Gem):**
|
|
||||||
- Share PRD
|
|
||||||
- Run: `*create-ux-design` → UX specifications
|
|
||||||
- Export: Save UX design to `docs/ux-design.md`
|
|
||||||
|
|
||||||
6. **Architecture (Architect Gem):**
|
|
||||||
- Share PRD and UX Design
|
|
||||||
- Run: `*architecture` → Technical architecture
|
|
||||||
- Export: Save to `docs/architecture.md`
|
|
||||||
|
|
||||||
**Phase 4: Local Implementation**
|
|
||||||
|
|
||||||
7. **Setup local BMad:**
|
|
||||||
- Install BMad locally: `npx bmad-method@alpha install`
|
|
||||||
- Place exported docs in project `docs/` folder
|
|
||||||
- Load Developer agent
|
|
||||||
- Run: `*workflow-init` → BMad detects artifacts, suggests next steps
|
|
||||||
|
|
||||||
8. **Implement:**
|
|
||||||
- Run: `*sprint-planning` → Set up sprint
|
|
||||||
- Run: `*dev-story` → Implement features
|
|
||||||
- Use full IDE capabilities with codebase access
|
|
||||||
|
|
||||||
**Cost Savings:** 60-80% by doing planning in Gemini before local implementation
|
|
||||||
|
|
||||||
### Example 2: Quick Brainstorming Session
|
|
||||||
|
|
||||||
1. Download `cis/agents/brainstorming-coach.xml`
|
|
||||||
2. Create Gemini Gem with Code Execution enabled
|
|
||||||
3. Run: `*brainstorming`
|
|
||||||
4. Choose technique (e.g., SCAMPER, Mind Mapping)
|
|
||||||
5. Generate and refine ideas
|
|
||||||
6. Export results for team review
|
|
||||||
|
|
||||||
### Example 3: Architecture Review
|
|
||||||
|
|
||||||
1. Download `bmm/agents/architect.xml`
|
|
||||||
2. Create Gemini Gem (enable Code Execution)
|
|
||||||
3. Paste existing PRD into conversation
|
|
||||||
4. Run: `*architecture`
|
|
||||||
5. Collaborate on technical decisions
|
|
||||||
6. Export architecture document to `docs/architecture.md`
|
|
||||||
|
|
||||||
## Next Steps
|
|
||||||
|
|
||||||
- **[Agent Customization Guide](./agent-customization-guide.md)** - Customize before bundling
|
|
||||||
- **[BMM Documentation](../src/modules/bmm/docs/README.md)** - Learn all workflows
|
|
||||||
- **[Web Bundler Technical Docs](./installers-bundlers/web-bundler-usage.md)** - Advanced bundling options
|
|
||||||
- **[Contributing Guide](../CONTRIBUTING.md)** - Help improve web bundles
|
|
||||||
|
|
||||||
## Resources
|
|
||||||
|
|
||||||
- **[Google AI Studio](https://aistudio.google.com/)** - Create Gemini Gems
|
|
||||||
- **[Custom GPTs](https://chat.openai.com/gpts)** - Build Custom GPTs
|
|
||||||
- **[BMad Discord](https://discord.gg/gk8jAdXWmj)** - Get help and share your Gems/GPTs
|
|
||||||
|
|||||||
@ -18,45 +18,44 @@ Specialized tools and workflows for creating, customizing, and extending BMad co
|
|||||||
|
|
||||||
**BMad Builder** - Master builder agent orchestrating all creation workflows with deep knowledge of BMad architecture and conventions.
|
**BMad Builder** - Master builder agent orchestrating all creation workflows with deep knowledge of BMad architecture and conventions.
|
||||||
|
|
||||||
- Location: `_bmad/bmb/agents/bmad-builder.md`
|
- Install Location: `_bmad/bmb/agents/bmad-builder.md`
|
||||||
|
|
||||||
### 📋 Workflows
|
### 📋 Workflows
|
||||||
|
|
||||||
### 📚 Documentation
|
### 📚 Documentation
|
||||||
|
|
||||||
- Location: `./docs/`
|
- Comprehensive guides for agents, workflows, and modules
|
||||||
- Comprehensive guides for agents and workflows
|
|
||||||
- Architecture patterns and best practices
|
- Architecture patterns and best practices
|
||||||
|
|
||||||
### 🔍 Reference Materials
|
### 🔍 Reference Materials
|
||||||
|
|
||||||
- Location: `./reference/`
|
- Location: `../reference/`
|
||||||
- Working examples of agents and workflows
|
- Working examples of custom stand alone agents and workflows
|
||||||
- Template patterns and implementation guides
|
- Template patterns and implementation guides
|
||||||
|
|
||||||
## Documentation
|
## Documentation
|
||||||
|
|
||||||
### 📖 Agent Documentation
|
### 📖 Agent Documentation
|
||||||
|
|
||||||
- **[Agent Index](./docs/agents/index.md)** - Complete agent architecture guide
|
- **[Agent Index](./agents/index.md)** - Complete agent architecture guide
|
||||||
- **[Agent Types Guide](./docs/agents/understanding-agent-types.md)** - Simple vs Expert vs Module agents
|
- **[Agent Types Guide](./agents/understanding-agent-types.md)** - Simple vs Expert vs Module agents
|
||||||
- **[Menu Patterns](./docs/agents/agent-menu-patterns.md)** - YAML menu design and handler types
|
- **[Menu Patterns](./agents/agent-menu-patterns.md)** - YAML menu design and handler types
|
||||||
- **[Agent Compilation](./docs/agents/agent-compilation.md)** - Auto-injection rules and compilation process
|
- **[Agent Compilation](./agents/agent-compilation.md)** - Auto-injection rules and compilation process
|
||||||
|
|
||||||
### 📋 Workflow Documentation
|
### 📋 Workflow Documentation
|
||||||
|
|
||||||
- **[Workflow Index](./docs/workflows/index.md)** - Core workflow system overview
|
- **[Workflow Index](./workflows/index.md)** - Core workflow system overview
|
||||||
- **[Architecture Guide](./docs/workflows/architecture.md)** - Step-file design and JIT loading
|
- **[Architecture Guide](./workflows/architecture.md)** - Step-file design and JIT loading
|
||||||
- **[Template System](./docs/workflows/templates/step-template.md)** - Standard step file template
|
- **[Template System](./workflows/templates/step-template.md)** - Standard step file template
|
||||||
- **[Intent vs Prescriptive](./docs/workflows/intent-vs-prescriptive-spectrum.md)** - Design philosophy
|
- **[Intent vs Prescriptive](./workflows/intent-vs-prescriptive-spectrum.md)** - Design philosophy
|
||||||
|
|
||||||
## Reference Materials
|
## Reference Materials
|
||||||
|
|
||||||
### 🤖 Agent Examples
|
### 🤖 Agent Examples
|
||||||
|
|
||||||
- **[Simple Agent Example](./reference/agents/simple-examples/commit-poet.agent.yaml)** - Self-contained agent
|
- **[Simple Agent Example](../reference/agents/simple-examples/commit-poet.agent.yaml)** - Self-contained agent
|
||||||
- **[Expert Agent Example](./reference/agents/expert-examples/journal-keeper/)** - Agent with persistent memory
|
- **[Expert Agent Example](../reference/agents/expert-examples/journal-keeper/journal-keeper.agent.yaml)** - Agent with persistent memory
|
||||||
- **[Module Agent Examples](./reference/agents/module-examples/)** - Integration patterns (BMM, CIS)
|
- **[Module Add On Agent Examples](../reference/agents/module-examples/security-engineer.agent.yaml)** - Integration patterns (BMM, CIS)
|
||||||
|
|
||||||
### 📋 Workflow Examples
|
### 📋 Workflow Examples
|
||||||
|
|
||||||
Loading…
x
Reference in New Issue
Block a user