bmad-modules.yaml

# Official module registry — the single source of truth for which modules
# the BMad installer offers and how they are displayed.
#
# Order here determines display order in the installer picker (after the
# built-in core and bmm entries, which are loaded from local module.yaml).
#
# default_channel (optional) — the install channel when the user does not
# override with --channel/--pin/--next. Valid values: stable | next.
# Omit to inherit the installer's hardcoded default (stable).
#
# deprecated (optional, default false) — when true, the module is hidden from
# the installer picker UNLESS it is already installed (so existing users can
# still see/manage it, but new users are not offered it).
# deprecation-message (optional) — surfaced in the picker hint for a deprecated
# module that is still installed; use it to point users to the replacement.
#
# marketplace-plugin (optional, default false) — when true, the module's
# installable skills are resolved from its .claude-plugin/marketplace.json via
# the plugin resolver (instead of copying the single module-definition dir).
# Use this for modules whose module.yaml does not sit alongside the skill
# folders. module-definition should still point at the real module.yaml so
# config/version lookups work.
#
# post-install-message (optional) — an "action needed" notice shown to the user
# after install completes, once for each install run that includes the module.
# Interactive installs require the user to acknowledge it (press Enter);
# non-interactive (--yes) installs print it and continue. Use for required
# follow-up steps (e.g. "run the X setup skill").
#
# aliases (optional) — prior `code` values this module was registered under.
# An existing install recorded under an alias resolves to this entry (source,
# name, description, post-install message) instead of being orphaned as
# "no source available" when the code changes. quick-update also migrates the
# install to the new code and removes the stale `_bmad/<alias>/` directory.

modules:
  bmad-builder:
    url: https://github.com/bmad-code-org/bmad-builder
    module-definition: skills/module.yaml
    code: bmb
    name: "BMad Builder"
    description: "Skill, workflow, and agent builder"
    defaultSelected: false
    type: bmad-org
    npmPackage: bmad-builder
    default_channel: stable

  bmad-creative-intelligence-suite:
    url: https://github.com/bmad-code-org/bmad-module-creative-intelligence-suite
    module-definition: src/module.yaml
    code: cis
    name: "BMad Creative Intelligence Suite"
    description: "Creative thinking partners"
    defaultSelected: false
    type: bmad-org
    npmPackage: bmad-creative-intelligence-suite
    default_channel: stable

  bmad-method-test-architecture-enterprise:
    url: https://github.com/bmad-code-org/bmad-method-test-architecture-enterprise
    module-definition: src/module.yaml
    code: tea
    name: "BMad Test Architect"
    description: "Enterprise testing BMM add-on"
    defaultSelected: false
    type: bmad-org
    npmPackage: bmad-method-test-architecture-enterprise
    default_channel: stable

  bmad-loop:
    url: https://github.com/bmad-code-org/bmad-loop
    module-definition: src/bmad_loop/data/skills/bmad-loop-setup/assets/module.yaml
    code: bmad-loop
    # bauto is the pre-rename code (module was bmad-auto before both the repo
    # and its contents were renamed to bmad-loop); keeps existing bauto
    # installs migrating forward instead of being orphaned.
    aliases: [bauto]
    name: "BMad Loop"
    description: "Builds, verifies, and retros a whole epic unattended"
    defaultSelected: false
    type: bmad-org
    default_channel: stable
    # Skills live outside a single module.yaml dir; resolve them from
    # .claude-plugin/marketplace.json via the plugin resolver (see external-manager).
    marketplace-plugin: true
    post-install-message: |
      BMad Loop installed. To finish setup, run the bmad-loop-setup skill
      from your agent:

        > use the bmad-loop-setup skill

      It installs the bmad-loop orchestrator tool and wires up the per-project
      hooks and policy. The automation skills don't run until setup completes.

  bmad-game-dev-studio:
    url: https://github.com/bmad-code-org/bmad-module-game-dev-studio.git
    module-definition: src/module.yaml
    code: gds
    name: "BMad Game Dev Studio"
    description: "Ideate, design, and build games"
    defaultSelected: false
    type: bmad-org
    npmPackage: bmad-game-dev-studio
    default_channel: stable

  # --- Deprecated: hidden from the picker unless already installed ---

  bmad-automator:
    url: https://github.com/bmad-code-org/bmad-automator
    module-definition: skills/module.yaml
    code: automator
    name: "BMad Automator Epic Builder Experimental"
    description: "EXPERIMENTAL: only supports claude and codex currently"
    defaultSelected: false
    type: experimental
    npmPackage: bmad-story-automator
    default_channel: next
    deprecated: true
    deprecation-message: "BMad Automator has been deprecated and is replaced by BMad Loop (bmad-loop). Install BMad Loop instead."

  bmad-method-wds-expansion:
    url: https://github.com/bmad-code-org/bmad-method-wds-expansion
    module-definition: src/module.yaml
    code: wds
    plugin_name: bmad-wds # WDS marketplace.json declares the plugin under this name
    name: "Whiteport Design Studio"
    description: "Strategic UX and Design first planning methodology"
    defaultSelected: false
    type: bmad-org
    npmPackage: bmad-wds
    default_channel: stable
    deprecated: true
    deprecation-message: "Whiteport Design Studio is no longer receiving updates. Its capabilities are being folded into BMad Method (bmm) as enhanced UX features. Your existing install is kept as-is."