2.3 KiB

Raw Blame History

BMad CLI Tool

Installing external repo BMad official modules

For external official modules to be discoverable during install, ensure an entry for the external repo is added to the marketplace registry/official.yaml source of truth. Add the same entry to modules/registry-fallback.yaml only when BMAD-METHOD needs a bundled fallback or a staged registry supplement.

For community modules - this is handled through the marketplace community registry.

Use module-definition for conventional module repos with module.yaml. Use source-root for pure skill bundles that should be copied directly into _bmad/<module-code>/.

Some modules also need packaging files that live outside the skill payload. BMad Automator (bma) is the current example: BMAD-METHOD copies its runtime files from source/, but the runtime behavior itself remains owned by bmad-automator.

Post-Install Notes

Modules can display setup guidance to users after configuration is collected during npx bmad-method install. Notes are defined in the module's own module.yaml — no changes to the installer are needed.

Simple Format

Always displayed after the module is configured:

post-install-notes: |
  Thank you for choosing the XYZ Cool Module
  For Support about this Module call 555-1212

Conditional Format

Display different messages based on a config question's answer:

post-install-notes:
  config_key_name:
    value1: |
      Instructions for value1...      
    value2: |
      Instructions for value2...

Values without an entry (e.g., none) display nothing. Multiple config keys can each have their own conditional notes.

Example: TEA Module

The TEA module uses the conditional format keyed on tea_browser_automation:

post-install-notes:
  tea_browser_automation:
    cli: |
      Playwright CLI Setup:
        npm install -g @playwright/cli@latest
        playwright-cli install --skills      
    mcp: |
      Playwright MCP Setup (two servers):
        1. playwright    — npx @playwright/mcp@latest
        2. playwright-test — npx playwright run-test-mcp-server      
    auto: |
      Playwright CLI Setup:
        ...
      Playwright MCP Setup (two servers):
        ...

When a user selects auto, they see both CLI and MCP instructions. When they select none, nothing is shown.

2.3 KiB Raw Blame History