BMM-API Module

BMAD Platform API Integration for BMM Workflows

This module extends the base BMM (BMAD Method Module) with API integration capabilities, enabling remote document storage via the BMAD Platform API.

Features

• 🌐 Remote Storage - Documents upload to BMAD Platform API
• 📝 All Workflows Enhanced - Analysis, Planning, Solutioning, Implementation, Testing
• 🔄 Graceful Fallback - Works offline with local storage
• 🎨 Asset Management - Diagrams and wireframes upload as assets

Requirements

• BMAD with BMM module installed (Get BMAD)
• BMAD Platform API (optional, for remote storage)

Installation

@orchestrit/bmm CLI

This repo also includes a small npm CLI package at the repo root.

npx @orchestrit/bmm install

For now, install only prints a placeholder message. We'll add the real installation steps next.

Publish to npm

From the repo root:

npm login
npm publish --access public

Option 1: Using degit (Recommended)

# Download the module into your existing BMAD installation
npx degit codeflyer/bmad-bmm-api/.bmad/bmm-api .bmad/bmm-api
npx degit codeflyer/bmad-bmm-api/.github/agents .github/agents --force

Option 2: Git Clone

# Clone and extract module
git clone https://github.com/codeflyer/bmad-bmm-api.git /tmp/bmm-api
cp -r /tmp/bmm-api/.bmad/bmm-api .bmad/
cp -r /tmp/bmm-api/.github/agents .github/agents
rm -rf /tmp/bmm-api

Post-Installation: Apply the Module

Copy the module files to overlay on your BMM:

cp -r .bmad/bmm-api/* .bmad/bmm/

Configuration

After installation, add to .bmad/bmm/config.yaml:

# BMAD Platform API Configuration
api_base_url: 'http://localhost:3000/api/v1'
project_key: 'your-project-key'

Enhanced Workflows

| Phase | Workflows | |-------|-----------| | Analysis | product-brief, research (market/domain/technical) | | Planning | create-ux-design | | Solutioning | architecture, implementation-readiness | | Implementation | dev-story, sprint-planning, retrospective, code-review, create-story | | Quick Flow | create-tech-spec, quick-dev | | Diagrams | create-diagram, create-dataflow, create-flowchart, create-wireframe | | Documentation | document-project (full-scan, deep-dive) | | Testing | test-design, nfr-assess, trace, test-review |

Documentation

See docs/api-integration.md for full API documentation.

Module Contents

bmm-api/
├── _module-installer/
│   └── install-config.yaml    # Module metadata
├── docs/
│   └── api-integration.md     # Full API documentation
├── workflows/                 # API-enhanced workflow files
│   ├── 1-analysis/
│   ├── 2-plan-workflows/
│   ├── 3-solutioning/
│   ├── 4-implementation/
│   ├── bmad-quick-flow/
│   ├── diagrams/
│   ├── document-project/
│   └── testarch/
├── config.yaml
└── README.md

Version

• Module Version: 1.0.0
• Base BMM Compatibility: 1.x

Author

codeflyer