You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: clarify module requirements (no package.json needed)
- Modules only require module.yaml to function
- module-help.csv is optional but highly suggested for BMad help system
- package.json is only needed for npm publishing, not module functionality
- Add note about future auto-generation of module-help.csv from metadata
- Update all module structure examples to clarify optional vs required files
|**package.json**| NPM publishing, version info | 📦 For publishing only |
59
65
60
66
## Why Build Modules?
61
67
@@ -177,9 +183,26 @@ config:
177
183
# Add your config keys here
178
184
```
179
185
180
-
### package.json
186
+
### module-help.csv (Optional but Powerful)
187
+
188
+
The `module-help.csv` file registers your module's agents and workflows with BMad's intelligent help system. This enables contextual recommendations and smart workflow chaining.
181
189
182
-
Configure `package.json` for npm publishing:
190
+
:::tip[Why module-help.csv Matters]
191
+
The BMad help system uses this file to suggest the right workflows at the right time. Without it, your module's features remain hidden. With it, they become part of the intelligent BMad ecosystem.
your-module,discovery,"Your Workflow Name",your-workflow,10,workflows/your-workflow/workflow.md,your-workflow,false,workflow-builder,,"Brief description of what this workflow does",_your-module-output/,
197
+
```
198
+
199
+
:::note[Future Changes]
200
+
In a future release, `module-help.csv` will be auto-generated from workflow and agent metadata. For now, it's the manual way to tap into the power of the BMad help system.
201
+
:::
202
+
203
+
### package.json (For npm Publishing Only)
204
+
205
+
If you plan to publish your module to npm, create `package.json`:
183
206
184
207
```json
185
208
{
@@ -196,6 +219,10 @@ Configure `package.json` for npm publishing:
196
219
Use scoped naming (`@username/module-name` or `@bmad-code-org/` for official modules).
197
220
:::
198
221
222
+
:::note[Local Modules Don't Need package.json]
223
+
If you're only using your module locally or sharing it directly (folder, git repo), you can skip `package.json` entirely. It's only required for npm publishing.
224
+
:::
225
+
199
226
## Step 4: Implement Your Agents and Workflows
200
227
201
228
Morgan created spec files during the build step. Now implement your agents and workflows:
@@ -218,9 +245,10 @@ Before publishing, validate your module:
218
245
219
246
Morgan checks:
220
247
-`module.yaml` is complete and valid
248
+
-`module-help.csv` is properly formatted (if present)
221
249
- Agent files follow BMad standards
222
250
- Workflows have proper structure
223
-
-Package.json is configured correctly
251
+
-Folder structure is correct
224
252
225
253
Fix any issues Morgan identifies, then re-validate.
0 commit comments