bmad-method 6.0.0-alpha.14 → 6.0.0-alpha.15
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.coderabbit.yaml +36 -0
- package/{CODE_OF_CONDUCT.md → .github/CODE_OF_CONDUCT.md} +4 -4
- package/CHANGELOG.md +136 -408
- package/README.md +4 -1
- package/docs/custom-content-installation.md +245 -0
- package/docs/index.md +2 -2
- package/docs/installers-bundlers/installers-modules-platforms-reference.md +6 -5
- package/docs/web-bundles-gemini-gpt-guide.md +1 -1
- package/example-custom-content/README.md +4 -0
- package/example-custom-content/agents/commit-poet/commit-poet.agent.yaml +1 -1
- package/example-custom-content/agents/toolsmith/toolsmith-sidecar/instructions.md +1 -1
- package/example-custom-content/agents/toolsmith/toolsmith-sidecar/knowledge/docs.md +1 -1
- package/example-custom-content/agents/toolsmith/toolsmith-sidecar/knowledge/installers.md +1 -1
- package/example-custom-content/agents/toolsmith/toolsmith-sidecar/knowledge/modules.md +2 -2
- package/example-custom-content/agents/toolsmith/toolsmith.agent.yaml +1 -1
- package/example-custom-content/{custom.yaml → module.yaml} +1 -0
- package/example-custom-content/workflows/quiz-master/steps/step-01-init.md +2 -2
- package/example-custom-content/workflows/quiz-master/steps/step-02-q1.md +1 -1
- package/example-custom-content/workflows/quiz-master/steps/step-03-q2.md +1 -1
- package/example-custom-content/workflows/quiz-master/steps/step-04-q3.md +1 -1
- package/example-custom-content/workflows/quiz-master/steps/step-05-q4.md +1 -1
- package/example-custom-content/workflows/quiz-master/steps/step-06-q5.md +1 -1
- package/example-custom-content/workflows/quiz-master/steps/step-07-q6.md +1 -1
- package/example-custom-content/workflows/quiz-master/steps/step-08-q7.md +1 -1
- package/example-custom-content/workflows/quiz-master/steps/step-09-q8.md +1 -1
- package/example-custom-content/workflows/quiz-master/steps/step-10-q9.md +1 -1
- package/example-custom-content/workflows/quiz-master/steps/step-11-q10.md +1 -1
- package/example-custom-content/workflows/quiz-master/steps/step-12-results.md +1 -1
- package/example-custom-content/workflows/quiz-master/workflow.md +1 -1
- package/example-custom-module/mwm/README.md +5 -0
- package/example-custom-module/mwm/agents/cbt-coach/cbt-coach.agent.yaml +1 -0
- package/example-custom-module/mwm/agents/crisis-navigator.agent.yaml +3 -2
- package/example-custom-module/mwm/agents/meditation-guide.agent.yaml +3 -2
- package/example-custom-module/mwm/agents/wellness-companion/wellness-companion.agent.yaml +1 -0
- package/example-custom-module/mwm/{_module-installer/install-config.yaml → module.yaml} +1 -0
- package/package.json +1 -1
- package/src/core/_module-installer/installer.js +1 -1
- package/src/modules/bmb/_module-installer/installer.js +1 -1
- package/src/modules/bmb/docs/agents/index.md +1 -1
- package/src/modules/bmb/workflows/create-module/steps/step-04-structure.md +3 -3
- package/src/modules/bmb/workflows/create-module/steps/step-05-config.md +1 -1
- package/src/modules/bmb/workflows/create-module/steps/step-08-installer.md +8 -8
- package/src/modules/bmb/workflows/create-module/steps/step-09-documentation.md +2 -1
- package/src/modules/bmb/workflows/create-module/steps/step-10-roadmap.md +3 -2
- package/src/modules/bmb/workflows/create-module/steps/step-11-validate.md +3 -3
- package/src/modules/bmb/workflows/create-module/templates/installer.template.js +1 -1
- package/src/modules/bmb/workflows/create-module/validation.md +3 -3
- package/src/modules/bmb/workflows/create-workflow/steps/step-01-init.md +1 -1
- package/src/modules/bmb/workflows/create-workflow/steps/step-07-build.md +1 -1
- package/src/modules/bmgd/README.md +2 -1
- package/src/modules/bmm/_module-installer/installer.js +1 -1
- package/src/modules/bmm/_module-installer/platform-specifics/claude-code.js +1 -1
- package/src/modules/bmm/_module-installer/platform-specifics/windsurf.js +1 -1
- package/src/modules/cis/_module-installer/installer.js +1 -1
- package/tools/cli/README.md +4 -4
- package/tools/cli/installers/lib/core/config-collector.js +16 -8
- package/tools/cli/installers/lib/core/custom-module-cache.js +239 -0
- package/tools/cli/installers/lib/core/detector.js +8 -4
- package/tools/cli/installers/lib/core/installer.js +815 -23
- package/tools/cli/installers/lib/core/manifest-generator.js +176 -13
- package/tools/cli/installers/lib/core/manifest.js +47 -0
- package/tools/cli/installers/lib/custom/handler.js +150 -20
- package/tools/cli/installers/lib/modules/manager.js +78 -32
- package/tools/cli/lib/agent/compiler.js +3 -11
- package/tools/cli/lib/agent/installer.js +2 -1
- package/tools/cli/lib/cli-utils.js +21 -4
- package/tools/cli/lib/ui.js +499 -11
- package/tools/maintainer/review-pr-README.md +55 -0
- package/tools/maintainer/review-pr.md +242 -0
- package/tools/migrate-custom-module-paths.js +124 -0
- package/bmad-method-6.0.0-alpha.14.tgz +0 -0
- package/docs/custom-agent-installation.md +0 -137
- package/example-custom-content/workflows/quiz-master/workflow-plan-quiz-master.md +0 -269
- /package/src/core/{_module-installer/install-config.yaml → module.yaml} +0 -0
- /package/src/modules/bmb/{_module-installer/install-config.yaml → module.yaml} +0 -0
- /package/src/modules/bmb/workflows/create-module/templates/{install-config.template.yaml → module.template.yaml} +0 -0
- /package/src/modules/bmgd/{_module-installer/install-config.yaml → module.yaml} +0 -0
- /package/src/modules/bmm/{_module-installer/install-config.yaml → module.yaml} +0 -0
- /package/src/modules/cis/{_module-installer/install-config.yaml → module.yaml} +0 -0
|
@@ -0,0 +1,245 @@
|
|
|
1
|
+
# Custom Content Installation
|
|
2
|
+
|
|
3
|
+
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.
|
|
4
|
+
|
|
5
|
+
## Types of Custom Content
|
|
6
|
+
|
|
7
|
+
### 1. Custom Agents and Workflows (Standalone)
|
|
8
|
+
|
|
9
|
+
Custom agents and workflows are standalone content packages that can be installed without being part of a full module. These are perfect for:
|
|
10
|
+
|
|
11
|
+
- Sharing specialized agents across projects
|
|
12
|
+
- Building a personal Agent powered Notebook vault
|
|
13
|
+
- Distributing workflow templates
|
|
14
|
+
- Creating agent libraries for specific domains
|
|
15
|
+
|
|
16
|
+
#### Structure
|
|
17
|
+
|
|
18
|
+
A custom agents and workflows package follows this structure:
|
|
19
|
+
|
|
20
|
+
```
|
|
21
|
+
my-custom-agents/
|
|
22
|
+
├── module.yaml # Package configuration
|
|
23
|
+
├── agents/ # Agent definitions
|
|
24
|
+
│ └── my-agent/
|
|
25
|
+
│ └── agent.md
|
|
26
|
+
└── workflows/ # Workflow definitions
|
|
27
|
+
└── my-workflow/
|
|
28
|
+
└── workflow.md
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
#### Configuration
|
|
32
|
+
|
|
33
|
+
Create a `module.yaml` file in your package root:
|
|
34
|
+
|
|
35
|
+
```yaml
|
|
36
|
+
code: my-custom-agents
|
|
37
|
+
name: 'My Custom Agents and Workflows'
|
|
38
|
+
default_selected: true
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
#### Example
|
|
42
|
+
|
|
43
|
+
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.
|
|
44
|
+
|
|
45
|
+
### 2. Custom Modules
|
|
46
|
+
|
|
47
|
+
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:
|
|
48
|
+
|
|
49
|
+
- Domain-specific functionality (e.g., industry-specific workflows, entertainment, education and training, medical, etc...)
|
|
50
|
+
- Integration with external systems
|
|
51
|
+
- Specialized agent collections
|
|
52
|
+
- Custom tooling and utilities
|
|
53
|
+
|
|
54
|
+
#### Structure
|
|
55
|
+
|
|
56
|
+
A custom module follows this structure:
|
|
57
|
+
|
|
58
|
+
```
|
|
59
|
+
my-module/
|
|
60
|
+
├── _module-installer/
|
|
61
|
+
│ ├── installer.js # optional, when it exists it will run with module installation
|
|
62
|
+
├── module.yaml # Module installation configuration with custom question and answer capture
|
|
63
|
+
├── docs/ # Module documentation
|
|
64
|
+
├── agents/ # Module-specific agents
|
|
65
|
+
├── workflows/ # Module-specific workflows
|
|
66
|
+
├── data/ # csv or other content to power agent intelligence or workflows
|
|
67
|
+
├── tools/ # Custom tools, hooks, mcp
|
|
68
|
+
└── sub-modules/ # IDE-specific customizations
|
|
69
|
+
├── vscode/
|
|
70
|
+
└── cursor/
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
#### Module Configuration
|
|
74
|
+
|
|
75
|
+
The `module.yaml` file defines how your module is installed:
|
|
76
|
+
|
|
77
|
+
```yaml
|
|
78
|
+
# Module metadata
|
|
79
|
+
code: my-module
|
|
80
|
+
name: 'My Custom Module'
|
|
81
|
+
default_selected: false
|
|
82
|
+
|
|
83
|
+
header: 'My Custom Module'
|
|
84
|
+
subheader: 'Description of what this module does'
|
|
85
|
+
|
|
86
|
+
# Configuration prompts
|
|
87
|
+
my_setting:
|
|
88
|
+
prompt: 'Configure your module setting'
|
|
89
|
+
default: 'default-value'
|
|
90
|
+
result: '{value}'
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
#### Example
|
|
94
|
+
|
|
95
|
+
See `/example-custom-module` for a complete example:
|
|
96
|
+
|
|
97
|
+
## Installation Process
|
|
98
|
+
|
|
99
|
+
### Step 1: Running the Installer
|
|
100
|
+
|
|
101
|
+
When you run the existing normal BMAD installer - either from the cloned repo, OR via NPX, it will ask about custom content:
|
|
102
|
+
|
|
103
|
+
```
|
|
104
|
+
? Do you have custom content to install?
|
|
105
|
+
❯ No (skip custom content)
|
|
106
|
+
Enter a directory path
|
|
107
|
+
Enter a URL [Coming soon]
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
### Step 2: Providing Custom Content Path
|
|
111
|
+
|
|
112
|
+
If you select "Enter a directory path", the installer will prompt for the location:
|
|
113
|
+
|
|
114
|
+
```
|
|
115
|
+
? Enter the path to your custom content directory: /path/to/folder/containing/content/folder
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
The installer will:
|
|
119
|
+
|
|
120
|
+
- Scan for `module.yaml` files (modules)
|
|
121
|
+
- 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.
|
|
122
|
+
|
|
123
|
+
### Step 3: Selecting Content
|
|
124
|
+
|
|
125
|
+
The installer presents a unified selection interface:
|
|
126
|
+
|
|
127
|
+
```
|
|
128
|
+
? Select modules and custom content to install:
|
|
129
|
+
[── Custom Content ──]
|
|
130
|
+
◉ My Custom Agents and Workflows (/path/to/custom)
|
|
131
|
+
[── Official Content ──]
|
|
132
|
+
◯ BMM: Business Method & Management
|
|
133
|
+
◯ CIS: Creativity & Innovation Suite
|
|
134
|
+
```
|
|
135
|
+
|
|
136
|
+
## Agent Sidecar Support
|
|
137
|
+
|
|
138
|
+
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.
|
|
139
|
+
|
|
140
|
+
### What is Sidecar Content?
|
|
141
|
+
|
|
142
|
+
Sidecar content includes:
|
|
143
|
+
|
|
144
|
+
- Agent memories and learning data
|
|
145
|
+
- Personal working files
|
|
146
|
+
- Temporary data
|
|
147
|
+
- User-specific configurations
|
|
148
|
+
|
|
149
|
+
### Sidecar Configuration
|
|
150
|
+
|
|
151
|
+
The sidecar folder location is configured during BMAD core installation:
|
|
152
|
+
|
|
153
|
+
```
|
|
154
|
+
? Where should users' agent sidecar memory folders be stored?
|
|
155
|
+
❯ .bmad-user-memory
|
|
156
|
+
```
|
|
157
|
+
|
|
158
|
+
### How It Works
|
|
159
|
+
|
|
160
|
+
1. **Agent Declaration**: Agents declare `hasSidecar: true` in their metadata
|
|
161
|
+
2. **Sidecar Detection**: The installer automatically detects folders with "sidecar" in the name
|
|
162
|
+
3. **Installation**: Sidecar content is copied to the configured location
|
|
163
|
+
4. **Path Replacement**: The `{agent_sidecar_folder}` placeholder in agent configurations is replaced with the actual path to the installed instance of the sidecar folder. Now when you use the agent, depending on its design, will use the content in sidecar to record interactions, remember things you tell it, or serve a host of many other issues.
|
|
164
|
+
|
|
165
|
+
### Example Structure
|
|
166
|
+
|
|
167
|
+
```
|
|
168
|
+
my-agent/
|
|
169
|
+
├── agent.md # Agent definition
|
|
170
|
+
└── my-agent-sidecar/ # Sidecar content folder
|
|
171
|
+
├── memories/
|
|
172
|
+
├── working/
|
|
173
|
+
└── config/
|
|
174
|
+
```
|
|
175
|
+
|
|
176
|
+
### Git Integration
|
|
177
|
+
|
|
178
|
+
Since sidecar content is stored outside the `.bmad` directory (and typically outside version control), users can:
|
|
179
|
+
|
|
180
|
+
- Add the sidecar folder to `.gitignore` to exclude personal data
|
|
181
|
+
- Share agent definitions without exposing personal content
|
|
182
|
+
- Maintain separate configurations for different projects
|
|
183
|
+
|
|
184
|
+
Example `.gitignore` entry:
|
|
185
|
+
|
|
186
|
+
```
|
|
187
|
+
# Exclude agent personal data
|
|
188
|
+
.bmad-user-memory/
|
|
189
|
+
```
|
|
190
|
+
|
|
191
|
+
## Creating Custom Content with BMAD Builder
|
|
192
|
+
|
|
193
|
+
The BMAD Builder provides workflows that will guide you to produce your own custom content:
|
|
194
|
+
|
|
195
|
+
1. **Agent Templates**: Use standardized agent templates with proper structure
|
|
196
|
+
2. **Workflow Templates**: Create workflows using proven patterns
|
|
197
|
+
3. **Validation Tools**: Validate your content before distribution
|
|
198
|
+
4. **Package Generation**: Generate properly structured packages
|
|
199
|
+
|
|
200
|
+
### Best Practices
|
|
201
|
+
|
|
202
|
+
1. **Use Clear Naming**: Make your content codes and names descriptive
|
|
203
|
+
2. **Provide Documentation**: Include clear setup and usage instructions
|
|
204
|
+
3. **Test Installation**: Test your content in a clean environment
|
|
205
|
+
4. **Version Management**: Use semantic versioning for updates
|
|
206
|
+
5. **Respect User Privacy**: Keep personal data in sidecar folders
|
|
207
|
+
|
|
208
|
+
## Distribution
|
|
209
|
+
|
|
210
|
+
Custom content can be distributed:
|
|
211
|
+
|
|
212
|
+
1. **File System**: Copy folders directly to users
|
|
213
|
+
2. **Git Repositories**: Clone or download from version control
|
|
214
|
+
3. **Package Managers**: [Coming soon] npm package support
|
|
215
|
+
4. **URL Installation**: [Coming soon] Direct URL installation, including an official community vetted module forge
|
|
216
|
+
|
|
217
|
+
## Troubleshooting
|
|
218
|
+
|
|
219
|
+
### No Custom Content Found
|
|
220
|
+
|
|
221
|
+
- Ensure your `module.yaml` files are properly named
|
|
222
|
+
- Check file permissions
|
|
223
|
+
- Verify the directory path is correct
|
|
224
|
+
|
|
225
|
+
### Installation Errors
|
|
226
|
+
|
|
227
|
+
- Run the installer with verbose logging
|
|
228
|
+
- Check for syntax errors in YAML configuration files
|
|
229
|
+
- Verify all required files are present
|
|
230
|
+
|
|
231
|
+
### Sidecar Issues
|
|
232
|
+
|
|
233
|
+
- Ensure the agent has `hasSidecar: true` in metadata
|
|
234
|
+
- Check that sidecar folders contain "sidecar" in the name
|
|
235
|
+
- Verify the agent_sidecar_folder configuration
|
|
236
|
+
- Ensure the custom agent has proper language in it to actually use the sidecar content, including loading memories on agent load.
|
|
237
|
+
|
|
238
|
+
## Support
|
|
239
|
+
|
|
240
|
+
For help with custom content creation or installation:
|
|
241
|
+
|
|
242
|
+
1. Check the examples in `/example-custom-content` and `/example-custom-module`
|
|
243
|
+
2. Review the BMAD documentation
|
|
244
|
+
3. Create an issue in the BMAD repository
|
|
245
|
+
4. Join the BMAD community discussions on discord
|
package/docs/index.md
CHANGED
|
@@ -96,9 +96,9 @@ Instructions for loading agents and running workflows in your development enviro
|
|
|
96
96
|
|
|
97
97
|
## 🔧 Advanced Topics
|
|
98
98
|
|
|
99
|
-
### Custom Agents
|
|
99
|
+
### Custom Agents, Workflow and Modules
|
|
100
100
|
|
|
101
|
-
- **[Custom
|
|
101
|
+
- **[Custom Content Installation](./custom-content-installation.md)** - Install and personalize agents, workflows and modules with the default bmad-method installer!
|
|
102
102
|
- [Agent Customization Guide](./agent-customization-guide.md) - Customize agent behavior and responses
|
|
103
103
|
|
|
104
104
|
### Installation & Bundling
|
|
@@ -59,6 +59,7 @@ project-root/
|
|
|
59
59
|
### Key Exclusions
|
|
60
60
|
|
|
61
61
|
- `_module-installer/` directories are never copied to destination
|
|
62
|
+
- module.yaml
|
|
62
63
|
- `localskip="true"` agents are filtered out
|
|
63
64
|
- Source `config.yaml` templates are replaced with generated configs
|
|
64
65
|
|
|
@@ -92,8 +93,8 @@ Creative Innovation Studio for design workflows
|
|
|
92
93
|
```
|
|
93
94
|
src/modules/{module}/
|
|
94
95
|
├── _module-installer/ # Not copied to destination
|
|
95
|
-
│ ├── installer.js
|
|
96
|
-
|
|
96
|
+
│ ├── installer.js # Post-install logic
|
|
97
|
+
├── module.yaml
|
|
97
98
|
├── agents/
|
|
98
99
|
├── tasks/
|
|
99
100
|
├── templates/
|
|
@@ -107,7 +108,7 @@ src/modules/{module}/
|
|
|
107
108
|
|
|
108
109
|
### Collection Process
|
|
109
110
|
|
|
110
|
-
Modules define prompts in `
|
|
111
|
+
Modules define prompts in `module.yaml`:
|
|
111
112
|
|
|
112
113
|
```yaml
|
|
113
114
|
project_name:
|
|
@@ -218,12 +219,12 @@ Platform-specific content without source modification:
|
|
|
218
219
|
src/modules/mymod/
|
|
219
220
|
├── _module-installer/
|
|
220
221
|
│ ├── installer.js
|
|
221
|
-
|
|
222
|
+
├── module.yaml
|
|
222
223
|
├── agents/
|
|
223
224
|
└── tasks/
|
|
224
225
|
```
|
|
225
226
|
|
|
226
|
-
2. **Configuration** (`
|
|
227
|
+
2. **Configuration** (`module.yaml`)
|
|
227
228
|
|
|
228
229
|
```yaml
|
|
229
230
|
code: mymod
|
|
@@ -73,7 +73,7 @@ web-bundles/
|
|
|
73
73
|
|
|
74
74
|
**Create a Gem:**
|
|
75
75
|
|
|
76
|
-
1. Go to [
|
|
76
|
+
1. Go to [Gemini Gem manager](https://gemini.google.com/gems/view)
|
|
77
77
|
2. Click "New Gem" or "Create Gem"
|
|
78
78
|
3. Give your Gem a name (e.g., "BMad PM Agent")
|
|
79
79
|
4. **Enable "Code execution" for best results with document generation**
|
|
@@ -2,3 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
This is a demonstration of custom stand along agents and workflows. By having this content all in a folder with a custom.yaml file,
|
|
4
4
|
These items will be discovered by the installer and offered for installation.
|
|
5
|
+
|
|
6
|
+
This is how you could also create and share other custom agents and workflows not tied to a specific module.
|
|
7
|
+
|
|
8
|
+
To see how these become installable, rename custom.bak -> custom.yaml and run the installer from the location you also have put this folder.
|
|
@@ -41,7 +41,7 @@ CLI uses Commander.js, commands auto-loaded from `tools/cli/commands/`:
|
|
|
41
41
|
### Core Architecture Patterns
|
|
42
42
|
|
|
43
43
|
1. **IDE Handlers**: Each IDE extends BaseIdeSetup class
|
|
44
|
-
2. **Module Installers**: Modules can have `_module-installer/installer.js`
|
|
44
|
+
2. **Module Installers**: Modules can have `module.yaml` and `_module-installer/installer.js`
|
|
45
45
|
3. **Sub-modules**: IDE-specific customizations in `sub-modules/{ide-name}/`
|
|
46
46
|
4. **Shared Utilities**: `tools/cli/installers/lib/ide/shared/` contains generators
|
|
47
47
|
|
|
@@ -16,7 +16,7 @@
|
|
|
16
16
|
- @/docs/v6-open-items.md - Known issues and open items
|
|
17
17
|
- @/docs/document-sharding-guide.md - Guide for sharding large documents
|
|
18
18
|
- @/docs/agent-customization-guide.md - How to customize agents
|
|
19
|
-
- @/docs/custom-
|
|
19
|
+
- @/docs/custom-content-installation.md - Custom agent, workflow and module installation guide
|
|
20
20
|
- @/docs/web-bundles-gemini-gpt-guide.md - Web bundle usage for AI platforms
|
|
21
21
|
- @/docs/BUNDLE_DISTRIBUTION_SETUP.md - Bundle distribution setup
|
|
22
22
|
|
|
@@ -117,7 +117,7 @@ Contains:
|
|
|
117
117
|
|
|
118
118
|
- Add new IDE handler: Create file in /tools/cli/installers/lib/ide/, extend BaseIdeSetup
|
|
119
119
|
- Fix installer bug: Check installer.js (94KB - main logic)
|
|
120
|
-
- Add module installer: Create \_module-installer/installer.js
|
|
120
|
+
- Add module installer: Create \_module-installer/installer.js if custom installer logic needed
|
|
121
121
|
- Update shared generators: Modify files in /shared/ directory
|
|
122
122
|
|
|
123
123
|
## Relationships
|
|
@@ -27,7 +27,7 @@ src/modules/{module-name}/
|
|
|
27
27
|
│ ├── injections.yaml
|
|
28
28
|
│ ├── config.yaml
|
|
29
29
|
│ └── sub-agents/
|
|
30
|
-
├──
|
|
30
|
+
├── module.yaml # Module install configuration
|
|
31
31
|
└── README.md # Module documentation
|
|
32
32
|
```
|
|
33
33
|
|
|
@@ -145,7 +145,7 @@ Defined in @/tools/cli/lib/platform-codes.js
|
|
|
145
145
|
- Create new module installer: Add \_module-installer/installer.js
|
|
146
146
|
- Add IDE sub-module: Create sub-modules/{ide-name}/ with config
|
|
147
147
|
- Add new IDE support: Create handler in installers/lib/ide/
|
|
148
|
-
- Customize module installation: Modify
|
|
148
|
+
- Customize module installation: Modify module.yaml
|
|
149
149
|
|
|
150
150
|
## Relationships
|
|
151
151
|
|
|
@@ -3,7 +3,7 @@ name: 'step-01-init'
|
|
|
3
3
|
description: 'Initialize quiz game with mode selection and category choice'
|
|
4
4
|
|
|
5
5
|
# Path Definitions
|
|
6
|
-
workflow_path: '{project-root}
|
|
6
|
+
workflow_path: '{project-root}/{bmad_folder}/custom/src/workflows/quiz-master'
|
|
7
7
|
|
|
8
8
|
# File References
|
|
9
9
|
thisStepFile: '{workflow_path}/steps/step-01-init.md'
|
|
@@ -66,7 +66,7 @@ To set up the quiz game by selecting game mode, choosing a category, and prepari
|
|
|
66
66
|
|
|
67
67
|
### 1. Welcome and Configuration Loading
|
|
68
68
|
|
|
69
|
-
Load config from {project-root}
|
|
69
|
+
Load config from {project-root}/{bmad_folder}/bmb/config.yaml to get user_name.
|
|
70
70
|
|
|
71
71
|
Present dramatic welcome:
|
|
72
72
|
"🎺 _DRAMATIC MUSIC PLAYS_ 🎺
|
|
@@ -3,7 +3,7 @@ name: 'step-02-q1'
|
|
|
3
3
|
description: 'Question 1 - Level 1 difficulty'
|
|
4
4
|
|
|
5
5
|
# Path Definitions
|
|
6
|
-
workflow_path: '{project-root}
|
|
6
|
+
workflow_path: '{project-root}/{bmad_folder}/custom/src/workflows/quiz-master'
|
|
7
7
|
|
|
8
8
|
# File References
|
|
9
9
|
thisStepFile: '{workflow_path}/steps/step-02-q1.md'
|
|
@@ -3,7 +3,7 @@ name: 'step-03-q2'
|
|
|
3
3
|
description: 'Question 2 - Level 2 difficulty'
|
|
4
4
|
|
|
5
5
|
# Path Definitions
|
|
6
|
-
workflow_path: '{project-root}
|
|
6
|
+
workflow_path: '{project-root}/{bmad_folder}/custom/src/workflows/quiz-master'
|
|
7
7
|
|
|
8
8
|
# File References
|
|
9
9
|
thisStepFile: '{workflow_path}/steps/step-03-q2.md'
|
|
@@ -3,7 +3,7 @@ name: 'step-04-q3'
|
|
|
3
3
|
description: 'Question 3 - Level 3 difficulty'
|
|
4
4
|
|
|
5
5
|
# Path Definitions
|
|
6
|
-
workflow_path: '{project-root}
|
|
6
|
+
workflow_path: '{project-root}/{bmad_folder}/custom/src/workflows/quiz-master'
|
|
7
7
|
|
|
8
8
|
# File References
|
|
9
9
|
thisStepFile: '{workflow_path}/steps/step-04-q3.md'
|
|
@@ -3,7 +3,7 @@ name: 'step-05-q4'
|
|
|
3
3
|
description: 'Question 4 - Level 4 difficulty'
|
|
4
4
|
|
|
5
5
|
# Path Definitions
|
|
6
|
-
workflow_path: '{project-root}
|
|
6
|
+
workflow_path: '{project-root}/{bmad_folder}/custom/src/workflows/quiz-master'
|
|
7
7
|
|
|
8
8
|
# File References
|
|
9
9
|
thisStepFile: '{workflow_path}/steps/step-05-q4.md'
|
|
@@ -3,7 +3,7 @@ name: 'step-06-q5'
|
|
|
3
3
|
description: 'Question 5 - Level 5 difficulty'
|
|
4
4
|
|
|
5
5
|
# Path Definitions
|
|
6
|
-
workflow_path: '{project-root}
|
|
6
|
+
workflow_path: '{project-root}/{bmad_folder}/custom/src/workflows/quiz-master'
|
|
7
7
|
|
|
8
8
|
# File References
|
|
9
9
|
thisStepFile: '{workflow_path}/steps/step-06-q5.md'
|
|
@@ -3,7 +3,7 @@ name: 'step-07-q6'
|
|
|
3
3
|
description: 'Question 6 - Level 6 difficulty'
|
|
4
4
|
|
|
5
5
|
# Path Definitions
|
|
6
|
-
workflow_path: '{project-root}
|
|
6
|
+
workflow_path: '{project-root}/{bmad_folder}/custom/src/workflows/quiz-master'
|
|
7
7
|
|
|
8
8
|
# File References
|
|
9
9
|
thisStepFile: '{workflow_path}/steps/step-07-q6.md'
|
|
@@ -3,7 +3,7 @@ name: 'step-08-q7'
|
|
|
3
3
|
description: 'Question 7 - Level 7 difficulty'
|
|
4
4
|
|
|
5
5
|
# Path Definitions
|
|
6
|
-
workflow_path: '{project-root}
|
|
6
|
+
workflow_path: '{project-root}/{bmad_folder}/custom/src/workflows/quiz-master'
|
|
7
7
|
|
|
8
8
|
# File References
|
|
9
9
|
thisStepFile: '{workflow_path}/steps/step-08-q7.md'
|
|
@@ -3,7 +3,7 @@ name: 'step-09-q8'
|
|
|
3
3
|
description: 'Question 8 - Level 8 difficulty'
|
|
4
4
|
|
|
5
5
|
# Path Definitions
|
|
6
|
-
workflow_path: '{project-root}
|
|
6
|
+
workflow_path: '{project-root}/{bmad_folder}/custom/src/workflows/quiz-master'
|
|
7
7
|
|
|
8
8
|
# File References
|
|
9
9
|
thisStepFile: '{workflow_path}/steps/step-09-q8.md'
|
|
@@ -3,7 +3,7 @@ name: 'step-10-q9'
|
|
|
3
3
|
description: 'Question 9 - Level 9 difficulty'
|
|
4
4
|
|
|
5
5
|
# Path Definitions
|
|
6
|
-
workflow_path: '{project-root}
|
|
6
|
+
workflow_path: '{project-root}/{bmad_folder}/custom/src/workflows/quiz-master'
|
|
7
7
|
|
|
8
8
|
# File References
|
|
9
9
|
thisStepFile: '{workflow_path}/steps/step-10-q9.md'
|
|
@@ -3,7 +3,7 @@ name: 'step-11-q10'
|
|
|
3
3
|
description: 'Question 10 - Level 10 difficulty'
|
|
4
4
|
|
|
5
5
|
# Path Definitions
|
|
6
|
-
workflow_path: '{project-root}
|
|
6
|
+
workflow_path: '{project-root}/{bmad_folder}/custom/src/workflows/quiz-master'
|
|
7
7
|
|
|
8
8
|
# File References
|
|
9
9
|
thisStepFile: '{workflow_path}/steps/step-11-q10.md'
|
|
@@ -3,7 +3,7 @@ name: 'step-12-results'
|
|
|
3
3
|
description: 'Final results and celebration'
|
|
4
4
|
|
|
5
5
|
# Path Definitions
|
|
6
|
-
workflow_path: '{project-root}
|
|
6
|
+
workflow_path: '{project-root}/{bmad_folder}/custom/src/workflows/quiz-master'
|
|
7
7
|
|
|
8
8
|
# File References
|
|
9
9
|
thisStepFile: '{workflow_path}/steps/step-12-results.md'
|
|
@@ -45,7 +45,7 @@ web_bundle: true
|
|
|
45
45
|
|
|
46
46
|
### 1. Module Configuration Loading
|
|
47
47
|
|
|
48
|
-
Load and read full config from {project-root}
|
|
48
|
+
Load and read full config from {project-root}/{bmad_folder}/bmb/config.yaml and resolve:
|
|
49
49
|
|
|
50
50
|
- `user_name`, `output_folder`, `communication_language`, `document_output_language`
|
|
51
51
|
|
|
@@ -2,3 +2,8 @@
|
|
|
2
2
|
|
|
3
3
|
This module is an example and is not at all recommended for any usage, this module was not vetted by any medical professionals and should
|
|
4
4
|
be considered at best for entertainment purposes only.
|
|
5
|
+
|
|
6
|
+
You should see the option in the module selector when installing.
|
|
7
|
+
|
|
8
|
+
If you have received a module from someone else that is not in the official installation - you can install it similarly by running the
|
|
9
|
+
normal bmad-method installer from the the same location you have placed the folder.
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
agent:
|
|
2
2
|
metadata:
|
|
3
|
+
id: "{bmad_folder}/mwm/agents/crisis-navigator.md"
|
|
3
4
|
name: "Beacon"
|
|
4
5
|
title: "Crisis Navigator"
|
|
5
6
|
icon: "🆘"
|
|
@@ -95,7 +96,7 @@ agent:
|
|
|
95
96
|
triggers:
|
|
96
97
|
- trigger: party-mode
|
|
97
98
|
input: SPM or fuzzy match start party mode
|
|
98
|
-
route: "{project-root}
|
|
99
|
+
route: "{project-root}/{bmad_folder}/core/workflows/edit-agent/workflow.md"
|
|
99
100
|
data: crisis navigator agent discussion
|
|
100
101
|
type: exec
|
|
101
102
|
- trigger: expert-chat
|
|
@@ -117,7 +118,7 @@ agent:
|
|
|
117
118
|
type: action
|
|
118
119
|
|
|
119
120
|
- trigger: "safety-plan"
|
|
120
|
-
route: "{project-root}
|
|
121
|
+
route: "{project-root}/{bmad_folder}/custom/src/modules/mental-wellness-module/workflows/crisis-support/workflow.md"
|
|
121
122
|
description: "Create safety plan 🛡️"
|
|
122
123
|
type: workflow
|
|
123
124
|
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
agent:
|
|
2
2
|
metadata:
|
|
3
|
+
id: "{bmad_folder}/mwm/agents/meditation-guide.md"
|
|
3
4
|
name: "Serenity"
|
|
4
5
|
title: "Meditation Guide"
|
|
5
6
|
icon: "🧘"
|
|
@@ -92,7 +93,7 @@ agent:
|
|
|
92
93
|
triggers:
|
|
93
94
|
- trigger: party-mode
|
|
94
95
|
input: SPM or fuzzy match start party mode
|
|
95
|
-
route: "{project-root}
|
|
96
|
+
route: "{project-root}/{bmad_folder}/core/workflows/edit-agent/workflow.md"
|
|
96
97
|
data: meditation guide agent discussion
|
|
97
98
|
type: exec
|
|
98
99
|
- trigger: expert-chat
|
|
@@ -104,7 +105,7 @@ agent:
|
|
|
104
105
|
triggers:
|
|
105
106
|
- trigger: guided-meditation
|
|
106
107
|
input: GM or fuzzy match guided meditation
|
|
107
|
-
route: "{project-root}
|
|
108
|
+
route: "{project-root}/{bmad_folder}/custom/src/modules/mental-wellness-module/workflows/guided-meditation/workflow.md"
|
|
108
109
|
description: "Full meditation session 🧘"
|
|
109
110
|
type: workflow
|
|
110
111
|
- trigger: body-scan
|
package/package.json
CHANGED
|
@@ -6,7 +6,7 @@ const chalk = require('chalk');
|
|
|
6
6
|
*
|
|
7
7
|
* @param {Object} options - Installation options
|
|
8
8
|
* @param {string} options.projectRoot - The root directory of the target project
|
|
9
|
-
* @param {Object} options.config - Module configuration from
|
|
9
|
+
* @param {Object} options.config - Module configuration from module.yaml
|
|
10
10
|
* @param {Array<string>} options.installedIDEs - Array of IDE codes that were installed
|
|
11
11
|
* @param {Object} options.logger - Logger instance for output
|
|
12
12
|
* @returns {Promise<boolean>} - Success status
|
|
@@ -8,7 +8,7 @@ const chalk = require('chalk');
|
|
|
8
8
|
*
|
|
9
9
|
* @param {Object} options - Installation options
|
|
10
10
|
* @param {string} options.projectRoot - The root directory of the target project
|
|
11
|
-
* @param {Object} options.config - Module configuration from
|
|
11
|
+
* @param {Object} options.config - Module configuration from module.yaml
|
|
12
12
|
* @param {Object} options.coreConfig - Core configuration containing user_name
|
|
13
13
|
* @param {Array<string>} options.installedIDEs - Array of IDE codes that were installed
|
|
14
14
|
* @param {Object} options.logger - Logger instance for output
|