README.md

BMad Module Template

A minimal template for creating BMad Method modules. Fork this repo or use it as a GitHub template to start building your own module.

Quick Start

1. Click Use this template on GitHub (or fork the repo)
2. Rename skills/my-skill/ to your skill name
3. Edit skills/my-skill/SKILL.md with your skill's instructions
4. Update .claude-plugin/marketplace.json with your module info
5. Update LICENSE with your name and year
6. Replace this README with what your module does

Structure

your-module/
├── .claude-plugin/
│   └── marketplace.json       # Module manifest (required for installation)
├── skills/
│   └── my-skill/              # Rename to your skill name
│       ├── SKILL.md           # Skill instructions
│       ├── prompts/           # Internal capability prompts (optional)
│       ├── scripts/           # Deterministic scripts (optional)
│       └── assets/            # Module registration files (optional)
├── docs/                      # Documentation (optional, GitHub Pages ready)
├── LICENSE
└── README.md

Building with BMad Builder

You don't have to write skills from scratch. The BMad Builder provides guided tools for creating production-quality skills:

• Agent Builder — Build agent skills through conversational discovery
• Workflow Builder — Build workflow and utility skills
• Module Builder — Package skills into an installable module with help system registration
• Build Your First Module — Full walkthrough from idea to distributable module

The Module Builder can scaffold registration files (module.yaml, module-help.csv, merge scripts) so your module integrates with the BMad help system.

Adding More Skills

Add skill directories under skills/ and list them in marketplace.json:

"skills": [
  "./skills/my-agent",
  "./skills/my-workflow"
]

Documentation

A docs/ folder is included for your module's documentation. Publish it with GitHub Pages or any static site host. For a richer docs site, consider Starlight (used by the official BMad modules).

Installation

Users install your module with:

npx bmad-method install --custom-content https://github.com/your-org/your-module

See Distribute Your Module for full details on repo structure, the marketplace.json format, and versioning.

Publishing to the Marketplace

Once your module is stable, you can list it in the BMad Plugins Marketplace for broader discovery:

1. Tag a release (e.g., v1.0.0)
2. Open a PR to the marketplace repo adding a registry entry to registry/community/
3. Your module goes through automated validation and manual review

Review the marketplace contribution guide and governance policy before submitting.

Resources

• BMad Method Documentation — Core framework
• BMad Builder Documentation — Build agents, workflows, and modules
• BMad Plugins Marketplace — Registry, categories, and submission process

Community

• Discord — Get help, share ideas, collaborate
• YouTube — Tutorials, master class, and more
• X / Twitter
• Website

Support BMad

BMad is free for everyone and always will be. Star this repo, buy me a coffee, or email contact@bmadcode.com for corporate sponsorship.

License

MIT — update LICENSE with your own copyright.