BMAD-METHOD/install-custom-modules.md at e535f943258eb9eb3ac94ce75c014e9a6be5442f

mirror of https://github.com/bmad-code-org/BMAD-METHOD.git synced 2026-01-30 04:32:02 +00:00

Files

forcetrainer e535f94325 docs: comprehensive style guide update with reference and glossary standards

Style Guide Additions:
- Add Reference Structure section with 6 document types (Index, Catalog,
  Deep-Dive, Configuration, Glossary, Comprehensive)
- Add Glossary Structure section with table-based format leveraging
  Starlight's right-nav for navigation
- Include checklists for both new document types

Reference Docs Updated:
- agents/index.md: Catalog format, universal commands tip admonition
- configuration/core-tasks.md: Configuration format with admonitions
- configuration/global-config.md: Table-based config reference
- workflows/index.md: Minimal index format
- workflows/core-workflows.md: Catalog format
- workflows/document-project.md: Deep-dive with Quick Facts admonition
- workflows/bmgd-workflows.md: Comprehensive format, removed ~30 hr rules

Glossary Rewritten:
- Converted from 373 lines with ### headers to 123 lines with tables
- Right nav now shows 9 categories instead of 50+ terms
- Added italic context markers (*BMGD.*, *Brownfield.*, etc.)
- Alphabetized terms within categories
- Removed redundant inline TOC

All Docs:
- Remove horizontal rules (---) per style guide
- Remove "Related" sections (sidebar handles navigation)
- Standardize admonition usage
- Archive deleted workflow customization docs

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

2026-01-12 00:23:05 -05:00

3.4 KiB

Raw Blame History

title, description

title	description
How to Install Custom Modules	Add custom agents, workflows, and modules to BMad

Use the BMad installer to add custom agents, workflows, and modules that extend BMad's functionality.

When to Use This

Adding third-party BMad modules to your project
Installing your own custom agents or workflows
Sharing custom content across projects or teams

:::note[Prerequisites]

BMad installed in your project
Custom content with a valid module.yaml file :::

Steps

1. Prepare Your Custom Content

Your custom content needs a module.yaml file. Choose the appropriate structure:

For a cohesive module (agents and workflows that work together):

module-code/
  module.yaml
  agents/
  workflows/
  tools/
  templates/

For standalone items (unrelated agents/workflows):

module-name/
  module.yaml        # Contains unitary: true
  agents/
    larry/larry.agent.md
    curly/curly.agent.md
  workflows/

Add unitary: true in your module.yaml to indicate items don't depend on each other.

2. Run the Installer

New project:

npx bmad-method install

When prompted "Would you like to install a local custom module?", select 'y' and provide the path to your module folder.

Existing project:

npx bmad-method install

Select Modify BMad Installation
Choose the option to add, modify, or update custom modules
Provide the path to your module folder

3. Verify Installation

Check that your custom content appears in the _bmad/ directory and is accessible from your AI tool.

What You Get

Custom agents available in your AI tool
Custom workflows accessible via *workflow-name
Content integrated with BMad's update system

Content Types

BMad supports several categories of custom content:

Type	Description
Stand Alone Modules	Complete modules with their own agents and workflows
Add On Modules	Extensions that add to existing modules
Global Modules	Content available across all modules
Custom Agents	Individual agent definitions
Custom Workflows	Individual workflow definitions

For detailed information about content types, see Custom Content Types.

Updating Custom Content

When BMad Core or module updates are available, the quick update process:

Applies updates to core modules
Recompiles all agents with your customizations
Retains your custom content from cache
Preserves your configurations

You don't need to keep source module files locally—just point to the updated location during updates.

Tips

Use unique module codes — Don't use bmm or other existing module codes
Avoid naming conflicts — Each module needs a distinct code
Document dependencies — Note any modules your custom content requires
Test in isolation — Verify custom modules work before sharing
Version your content — Track updates with version numbers

:::caution[Naming Conflicts] Don't create custom modules with codes like bmm (already used by BMad Method). Each custom module needs a unique code. :::

Example Modules

Find example custom modules in the samples/sample-custom-modules/ folder of the BMad repository. Download either sample folder to try them out.

3.4 KiB Raw Blame History