BMad Method

interface PackageInfo {
  name: 'bmad-method';
  type: 'npm';
  language: 'JavaScript';
  install: 'npx bmad-method install';
  version: '4.44.3';
  nodeVersion: '>=20.10.0';
}

# Install BMad Method
npx bmad-method install                    # Interactive mode with prompts
npx bmad-method install --full             # Full installation
npx bmad-method install --ide cursor       # Configure specific IDE

# Check status
npx bmad-method status                     # Show installation status

# List available resources
npx bmad-method list:expansions            # List expansion packs
npx bmad-method list:agents                # List all agents

your-project/
├── .bmad-core/              # Core framework
│   ├── agents/              # 10 agent personas
│   ├── tasks/               # 21 core tasks
│   ├── templates/           # 13 document templates
│   ├── workflows/           # 6 workflow definitions
│   ├── checklists/          # 6 quality checklists
│   ├── agent-teams/         # 4 team configurations
│   ├── data/                # Knowledge base files
│   └── core-config.yaml     # Project configuration
├── common/                  # Shared resources
│   ├── tasks/               # 2 common shared tasks (create-doc, execute-checklist)
│   └── utils/               # Common utilities
├── .{expansion-pack}/       # Optional expansion packs
├── docs/                    # Generated documentation
│   ├── prd.md              # Product Requirements
│   ├── architecture.md      # Architecture document
│   └── stories/            # Story files for development
└── web-bundles/            # Optional web bundles for ChatGPT/Claude/Gemini

markdownExploder: true              # Use markdown-tree-parser for sharding
qa:
  qaLocation: docs/qa               # QA artifacts directory
prd:
  prdFile: docs/prd.md             # PRD file path
  prdVersion: v4                    # Format version
  prdSharded: true                  # Enable sharding
  prdShardedLocation: docs/prd      # Sharded directory
  epicFilePattern: epic-{n}*.md     # Epic file naming pattern
architecture:
  architectureFile: docs/architecture.md
  architectureVersion: v4
  architectureSharded: true
  architectureShardedLocation: docs/architecture
devLoadAlwaysFiles:                 # Files dev always loads
  - docs/architecture/coding-standards.md
  - docs/architecture/tech-stack.md
devStoryLocation: docs/stories      # Story directory
slashPrefix: "*"                    # Command prefix

const installer = require('bmad-method/tools/installer/lib/installer');
const WebBuilder = require('bmad-method/tools/builders/web-builder');
const DependencyResolver = require('bmad-method/tools/lib/dependency-resolver');

// Install BMad programmatically
await installer.install({
  installType: 'full',
  directory: './my-project',
  ides: ['claude-code', 'cursor']
});

// Build web bundles
const builder = new WebBuilder({ rootDir: process.cwd() });
await builder.buildAgents();

// Resolve dependencies
const resolver = new DependencyResolver('./my-project');
const agents = await resolver.listAgents();

*agent analyst          # Create project brief
*agent pm               # Create PRD with epics and stories
*agent ux-expert        # Create frontend specification
*agent architect        # Create full-stack architecture
*agent po               # Validate and shard documents

*agent sm               # Create story files with complete context
*agent dev              # Implement stories sequentially
*agent qa               # Review and gate implementation

npx bmad-method flatten -i . -o project.xml    # Document existing codebase
*agent pm                                       # Create brownfield PRD
*agent architect                                # Document architecture changes
*agent po                                       # Shard documents

*agent sm               # Create brownfield stories
*agent dev              # Implement with safety checks
*agent qa               # Validate changes

*agent po
*shard-doc

# Output:
# docs/prd/ with epic-1.md, epic-2.md, etc.
# docs/architecture/ with tech-stack.md, coding-standards.md, etc.

interface StoryContext {
  requirements: 'From sharded PRD epic';
  architecture: 'Selective sections (tech-stack, backend-architecture, etc.)';
  previousStories: 'Learnings from completed stories';
  sourceReferences: '[Source: docs/architecture/tech-stack.md#frameworks]';
  tasks: 'Checkbox list with subtasks';
}

interface QualityGateDecision {
  PASS: 'All criteria met, ready for production';
  CONCERNS: 'Issues found but not blocking';
  FAIL: 'Critical issues, must address';
  WAIVED: 'Issues waived by stakeholder';
}

interface TemplateMarkup {
  placeholders: {
    syntax: '{{variable_name}}';
    example: '{{project_name}}, {{epic_num}}';
  };
  llmInstructions: {
    syntax: '[[LLM: instructions]]';
    visibility: 'Invisible to users, processed by AI';
  };
  elicitation: {
    property: 'elicit: true';
    format: 'Mandatory 1-9 options with methods';
  };
}

interface DependencyResolution {
  pattern: '{root}/{type}/{name}';
  types: ['tasks', 'templates', 'checklists', 'data'];
  example: 'create-doc.md → .bmad-core/tasks/create-doc.md';
}