Create Your First Module
Package agents and workflows into a complete, shareable module.
What Youâll Learn
Section titled âWhat Youâll Learnâ- What a BMad module is and what it contains
- How to create a module brief with Morgan (module-builder)
- How to build a complete module from your brief
- How to configure module.yaml and module-help.csv
Understanding Modules
Section titled âUnderstanding ModulesâA module is a bundle of agents, workflows, and configuration that solves specific problems or addresses particular domains. Think of modules as plugins or extensions â packaged capabilities you can install, share, and distribute.
Module Structure
Section titled âModule StructureâEvery BMad module follows a standard structure:
your-module/âââ src/â âââ module.yaml # Module metadata and install configâ âââ module-help.csv # Feature registry for BMad help systemâ âââ agents/ # Agent definitions (.agent.yaml)â âââ workflows/ # Workflow filesâ âââ tools/ # Small reusable toolsâââ README.md # Module documentationWhat Makes a Complete Module?
Section titled âWhat Makes a Complete Module?â| Component | Purpose | Required |
|---|---|---|
| module.yaml | Metadata, install questions, config | â Yes |
| module-help.csv | Feature registry for BMad help system | â Highly suggested |
| Agents | AI assistants with specific roles | âȘ Optional |
| Workflows | Step-by-step processes | âȘ Optional |
| Tools | Reusable prompt files | âȘ Optional |
Why Build Modules?
Section titled âWhy Build Modules?âBMad modules arenât just for software development. Your imagination is the limit.
BMad enables modules for ANY domain â from personal growth to professional practice. With the module marketplace coming, youâll be able to share your creations with the world.
Inspiring Module Examples
Section titled âInspiring Module Examplesâ| Domain | Module Concept | What It Does |
|---|---|---|
| Personal Growth | Therapist Agent | An AI companion that remembers every conversation, tracks emotional patterns, and helps you see growth over time |
| Legal | Legal Office Module | Complete legal practice: document drafting, case research, client intake workflows |
| Creative Writing | Story Architect Module | Create the next great novel or screenplay â character development, plot outlining, dialogue coaching |
| Finance | Tax Workflow Module | Find deductions TurboTax misses and create audit-proof documentation that would cost hundreds from an accountant |
| Education | Personal Tutor Module | Adaptive learning that remembers your progress and customizes explanations to your learning style |
| Health | Fitness Coach Module | Custom workout and nutrition plans that evolve with your progress and preferences |
| Business | Marketing Strategist Module | Campaign planning, content generation, analytics interpretation â your entire marketing department |
| Relationships | Communication Coach Module | Navigate difficult conversations, resolve conflicts, strengthen connections |
| Music | Songwriterâs Assistant | Generate lyrics, suggest chord progressions, arrange songs, and provide creative feedback |
| Cooking | Personal Chef Module | Recipe suggestions based on ingredients you have, meal planning, dietary adaptations |
| Travel | Trip Planner Module | Custom itineraries, local recommendations, budget optimization, packing lists |
| Parenting | Family Coordinator Module | Activity ideas, milestone tracking, scheduling support, educational guidance |
| Hobbies | D&D Campaign Module | Character creation, world-building, encounter design, story tracking for tabletop games |
| Spirituality | Meditation Guide Module | Personalized meditation sessions, progress tracking, technique recommendations |
| Sports | Coach Module | Training plans, strategy development, performance analysis for any sport |
| Gardening | Garden Planner Module | Crop selection, planting schedules, pest control, harvest tracking |
What Problem Will You Solve?
Section titled âWhat Problem Will You Solve?âEvery great module starts with a problem you want to solve:
- What frustrates you? (repetitive tasks, complex processes, knowledge gaps)
- What expertise do you have? (professional skills, life experiences, specialized knowledge)
- What could be easier? (workflows you repeat, decisions you struggle with, goals youâre pursuing)
Morgan (the module-builder) helps you turn that problem into a complete, shareable solution.
Step 1: Create a Module Brief
Section titled âStep 1: Create a Module BriefâBefore building, Morgan helps you create a module brief â a vision document that defines your moduleâs purpose, audience, and features.
Invoke Morganâs brief creation:
[PB] or "product-brief"Morgan guides you through discovery:
| Step | What Youâll Define |
|---|---|
| Spark | What problem are you solving? |
| Type | What kind of module is this? (domain, tool, creative) |
| Vision | What does success look like? |
| Users | Who will use this module? |
| Value | What makes this module unique? |
| Agents | What agents will it include? |
| Workflows | What workflows will it include? |
| Tools | What tools or templates will it include? |
| Scenarios | How will people use this in practice? |
| Creative | Whatâs the personality/brand? |
The brief becomes your roadmap: a document called module-brief-{code}.md that Morgan uses to build your module.
Step 2: Build Your Module
Section titled âStep 2: Build Your ModuleâOnce your brief is complete, invoke Morganâs module creation:
[CM] or "create-module"Morgan will ask for the path to your module brief file. Provide the full path to module-brief-{code}.md.
Morgan then builds your module structure:
| Component | What Morgan Creates |
|---|---|
| module.yaml | Module metadata, install questions, configuration |
| Agent specs | Placeholder/spec files for each agent |
| Workflow specs | Placeholder/spec files for each workflow |
| README.md | Module documentation template |
| TODO.md | Implementation checklist |
Step 3: Configure Your Module
Section titled âStep 3: Configure Your Moduleâmodule.yaml
Section titled âmodule.yamlâThe module.yaml file defines your module:
name: "Your Module Name"code: "your-module-code"version: "0.1.0"description: "What your module does"
# Install questions shown to usersinstall: - question: "What's your experience level?" config_key: "experience_level" options: - "beginner" - "intermediate" - "advanced"
# Configuration valuesconfig: output_folder: "_your-module-output" # Add your config keys heremodule-help.csv (Optional but Powerful)
Section titled âmodule-help.csv (Optional but Powerful)â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.
module,phase,name,code,sequence,workflow-file,command,required,agent,options,description,output-location,outputsyour-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/,Step 4: Implement Your Agents and Workflows
Section titled âStep 4: Implement Your Agents and WorkflowsâMorgan created spec files during the build step. Now implement your agents and workflows:
- Create agent
.agent.yamlfiles based on the specs - Create workflow
.mdfiles with step files - Add tools or templates as needed
For details on creating agents and workflows, see:
Step 5: Validate Your Module
Section titled âStep 5: Validate Your ModuleâBefore sharing, validate your module:
[VM] or "validate-module"Morgan checks:
module.yamlis complete and validmodule-help.csvis properly formatted (if present)- Agent files follow BMad standards
- Workflows have proper structure
- Folder structure is correct
Fix any issues Morgan identifies, then re-validate.
What Youâve Accomplished
Section titled âWhat Youâve AccomplishedâYouâve created a complete BMad module with:
- A documented vision (module brief)
- Proper module structure and configuration
- module-help.csv for BMad help system integration
- Agents, workflows, and tools
- Install experience for users
Your module is now ready to:
- Install locally for testing
- Share with your team
- Share with the community
Quick Reference
Section titled âQuick Referenceâ| Action | How |
|---|---|
| Create brief | [PB] or product-brief |
| Build module | [CM] or create-module |
| Validate | [VM] or validate-module |
| Edit module | [EM] or edit-module |
Common Questions
Section titled âCommon QuestionsâShould I use bmad-module-template?
Yes! The bmad-module-template provides a starting point with proper structure. You can also use Morgan to generate a module from scratch.
Whatâs the difference between the brief and the module?
The brief is a vision document created through creative discovery. The module is the implementation built from that brief. Think of it as: brief = blueprint, module = building.
Can I update my module after sharing it?
Yes! Share the updated module folder or repository. Users can reinstall to get the latest version.
How do I share my module privately?
Share the module folder directly, or host it in a private Git repository. Users can install from a local path.
Getting Help
Section titled âGetting Helpâ- Discord Community â Ask in #bmad-method-help or #report-bugs-and-issues
- GitHub Issues â Report bugs or request features
Further Reading
Section titled âFurther Readingâ| Resource | Description |
|---|---|
| What Are Modules | Deep technical details on module architecture |
| bmad-module-template | Starting point for new modules |
| Install Custom Modules | Installing and using modules |