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
Copy file name to clipboardExpand all lines: docs/how-to/distribute-your-module.md
+19Lines changed: 19 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,6 +23,19 @@ Set up a GitHub repository so others can install your BMad module with a single
23
23
- Git installed locally
24
24
:::
25
25
26
+
## Getting Started
27
+
28
+
The fastest way to start is with the [BMad Module Template](https://github.com/bmad-code-org/bmad-module-template):
29
+
30
+
1. Click **Use this template** on GitHub to create your new repo
31
+
2. Install BMad Builder in the project: `npx bmad-method install` and select the BMad Builder module
32
+
3. Use the Agent Builder or Workflow Builder to create your skills
33
+
4. Organize your finished skills under `skills/`
34
+
5. Update `.claude-plugin/marketplace.json` with your module info
35
+
6. Add documentation under `docs/`
36
+
37
+
If you already have a repo with skills, you can skip the template and use the Module Builder's Create Module (CM) capability to scaffold the `marketplace.json` and registration files directly.
38
+
26
39
## Step 1: Understand the Plugin Format
27
40
28
41
The BMad installer discovers modules through a `.claude-plugin/marketplace.json` manifest at the repository root. The Module Builder generates this file during the Create Module (CM) step, but you need to verify and complete it before publishing.
@@ -186,6 +199,12 @@ After publishing, users can:
186
199
- Discover your module's capabilities through the help system
187
200
- Receive configuration prompts defined in your `module.yaml`
188
201
202
+
## List Your Module in the Marketplace
203
+
204
+
Once your module is published and working, you can submit it to the [BMad Plugins Marketplace](https://github.com/bmad-code-org/bmad-plugins-marketplace) so users can discover it alongside official modules. Listing is optional — your module is fully installable without it — but it gives your module visibility and a trust tier badge after review.
205
+
206
+
See the marketplace [CONTRIBUTING.md](https://github.com/bmad-code-org/bmad-plugins-marketplace/blob/main/CONTRIBUTING.md) for the submission process.
207
+
189
208
## Tips
190
209
191
210
- Include a `README.md` that explains what the module does, how to install it, and any external dependencies
0 commit comments