@cloudkinetix/bmad-enhanced/README.md

Cloud-Kinetix enhanced fork of BMAD-METHOD - Breakthrough Method of Agile AI-driven Development with robust versioning and unified validation.

<!-- START CLOUD-KINETIX SECTION - DO NOT MODIFY THIS MARKER -->

# BMad-METHOD - Cloud Kinetix Enhanced Fork

<div align="center">
  <img src="https://img.shields.io/npm/v/@cloudkinetix/bmad-enhanced.svg" alt="npm version" />
  <img src="https://img.shields.io/badge/Trae%20IDE-Support%20Added-blue" alt="Trae IDE Support" />
  <img src="https://img.shields.io/badge/Enterprise-Ready-green" alt="Enterprise Ready" />
  <img src="https://img.shields.io/badge/Based%20on-BMAD%20v4.31.0-blue" alt="Based on BMAD" />
</div>

## 🚀 Cloud Kinetix Enhancements

This is the **Cloud-Kinetix enhanced fork** of BMAD-METHOD, adding enterprise features:

### ✨ Key Differentiators (CK Exclusive)

#### 📦 Enterprise Expansion Packs

Extend BMAD with specialized capabilities:

- **🔗 JIRA Integration** (`ck-jira-integration`) - Bidirectional sync, natural language commands, agile ceremonies
- **🤖 LLM Agent Development** (`ck-llm-agent-dev`) - Build custom LLM agents with specialized toolkits
- **🔄 Parallel Development** (`ck-parallel-dev`) - Work on multiple stories simultaneously
- **🚀 GitLab CI/CD** (`ck-gitlab-cicd-automation`) - Automated pipeline generation and monitoring

#### 🎯 IDE & Installation Enhancements

Cloud-Kinetix exclusive improvements:

- **Trae IDE Support** - Added 8th IDE with `.trae/rules/` format (CK exclusive)
- **Expansion Pack IDE Integration** - CK expansion packs automatically configured for all IDEs
- **Professional Installer** - Interactive CLI with progress tracking and error recovery
- **Auto-Discovery System** - Dynamic IDE and expansion pack detection from configuration

#### 🖥️ Supported IDEs

| IDE                       | Option Switch           | Configuration Location | Agent Command Format |
| ------------------------- | ----------------------- | ---------------------- | -------------------- |
| **Cursor**                | `--ide cursor`          | `.cursorrules`         | `@agent`             |
| **Claude Code**           | `--ide claude-code`     | `.claude/CLAUDE.md`    | `/agent`             |
| **Windsurf**              | `--ide windsurf`        | `.windsurfrules`       | `@agent`             |
| **Roo Cline**             | `--ide roo`             | `.roo/.roomodes/`      | Custom modes         |
| **Cline**                 | `--ide cline`           | `.clinerules`          | Rules integration    |
| **Gemini CLI**            | `--ide gemini-cli`      | `.geminirules`         | `@agent`             |
| **VS Code Copilot**       | `--ide vs-code-copilot` | `.github/chatmodes/`   | Chat modes           |
| **Trae** _(CK Exclusive)_ | `--ide trae`            | `.trae/rules/`         | `@agent`             |

> **Note**: The installer auto-detects installed IDEs and prompts for selection during interactive installation.

#### 💼 Enterprise Features

Professional tools for production environments:

- **💾 Backup System** - Automatic backups before installations with rollback capability
- **📊 Status Tracking** - Monitor installed components and expansion packs
- **🔧 Non-Interactive Mode** - CI/CD friendly installation options
- **📄 Enterprise Logging** - Detailed installation logs and error tracking

### 🚀 Ultra-Simple Installation

**One Command - Everything Included:**

```bash
# Installs in the current directory
npx @cloudkinetix/bmad-enhanced@latest install
```

**What you get:**

- ✅ **Full upstream BMAD** (latest version with all features)
- ✅ **All 8 expansion packs** (4 CK + 4 upstream: JIRA, AI dev, parallel dev, GitLab CI/CD, game dev, infrastructure, creator tools)
- ✅ **All IDE configurations** automatically set up by upstream
- ✅ **Simple thin wrapper** - just adds our expansion packs on top of proven upstream installer

**Install in a Different Directory:**

```bash
# Specify a custom directory with --directory
npx @cloudkinetix/bmad-enhanced@latest install --directory ./my-project
```

> **💡 Ultra-Simple**: Thin wrapper over upstream BMAD + our expansion packs. Maximum reliability, minimum complexity.

### 🛠️ Additional Commands

Beyond installation, `bmad-enhanced` provides these helpful commands:

| Command           | Description                              | Example                         |
| ----------------- | ---------------------------------------- | ------------------------------- |
| `status`          | Check installation status and components | `bmad-enhanced status`          |
| `backup`          | Create backup of current installation    | `bmad-enhanced backup`          |
| `list:expansions` | List all available expansion packs       | `bmad-enhanced list:expansions` |

```bash
# Check what's installed
npx @cloudkinetix/bmad-enhanced@latest status

# Create a backup
npx @cloudkinetix/bmad-enhanced@latest backup

# See available expansion packs
npx @cloudkinetix/bmad-enhanced@latest list:expansions
```

### 🆕 Latest CK Version: 1.27.0-beta.1
Ultra-simple thin wrapper over upstream BMAD + all expansion packs. Maximum reliability, minimum complexity.

### 🔧 Troubleshooting

#### Getting Old Version or Installation Issues?

If you're experiencing installation issues or getting an older version, try this:

```bash
# Clear npm cache and force fresh download
npm cache clean --force
npx @cloudkinetix/bmad-enhanced@latest install --expansion-packs ck-jira-integration
```

**Common Issues:**

- **"Expansion pack not found"** → You might have cached old version, use `@latest` tag
- **Interactive prompts when using `--expansion-packs`** → Clear npm cache and retry
- **Version shows as older than expected** → Run `npm cache clean --force`

**Always use `@latest` for guaranteed fresh installation:**

```bash
npx @cloudkinetix/bmad-enhanced@latest install --full
```

### 📝 Recent Changes

#### 🎉 **LATEST: v1.27.0-beta.1 - Robust 1.x Versioning System (Aug 2025)**
- **Ultra-Simple**: Thin wrapper over upstream BMAD + expansion packs
- **Maximum Reliability**: Leverages proven upstream installer
- **Zero Complexity**: No custom backup/monitoring logic needed
- **Always Current**: Automatically uses latest upstream BMAD
- **Bulletproof**: ~50 lines of code vs 400+ lines before

#### ⚠️ **BREAKING CHANGE: Story File Naming Convention (v1.10.5)**

> **Important**: Story files now use `.storyimpl.md` extension instead of `.story.md`

- **Old format**: `1.1.story.md`
- **New format**: `1.1.storyimpl.md`
- **Reason**: Clarifies that these are implementation stories for developers
- **Affected components**:
  - `create-next-story` task
  - Unity game story creation
  - JIRA integration story sync
  - All story file references in agents

---

<!-- END CLOUD-KINETIX SECTION - DO NOT MODIFY THIS MARKER -->

<!-- UPSTREAM CONTENT BELOW - Safe to accept upstream changes -->

# BMad-Method: Universal AI Agent Framework

[![Version](https://img.shields.io/npm/v/bmad-method?color=blue&label=version)](https://www.npmjs.com/package/bmad-method)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
[![Node.js Version](https://img.shields.io/badge/node-%3E%3D20.0.0-brightgreen)](https://nodejs.org)
[![Discord](https://img.shields.io/badge/Discord-Join%20Community-7289da?logo=discord&logoColor=white)](https://discord.gg/gk8jAdXWmj)

Foundations in Agentic Agile Driven Development, known as the Breakthrough Method of Agile AI-Driven Development, yet so much more. Transform any domain with specialized AI expertise: software development, entertainment, creative writing, business strategy to personal wellness just to name a few.

**[Subscribe to BMadCode on YouTube](https://www.youtube.com/@BMadCode?sub_confirmation=1)**

**[Join our Discord Community](https://discord.gg/gk8jAdXWmj)** - A growing community for AI enthusiasts! Get help, share ideas, explore AI agents & frameworks, collaborate on tech projects, enjoy hobbies, and help each other succeed. Whether you're stuck on BMad, building your own agents, or just want to chat about the latest in AI - we're here for you! **Some mobile and VPN may have issue joining the discord, this is a discord issue - if the invite does not work, try from your own internet or another network, or non-VPN.**

- ✅ **Works with 8 IDEs Automatically**: Supports Cursor, Claude Code, Windsurf, Roo Code, Cline, Gemini CLI, VS Code Copilot, and Trae IDE - no manual setup needed
- 🔌 **JIRA Integration**: Sync your BMAD stories directly with JIRA issues using natural language commands
- 📦 **Faster Web Bundles**: Optimized team-based bundles that are 3x-5x faster to generate and easier to use
- 💾 **Professional Backup & Recovery**: Automatic backup of your entire BMAD setup - never lose your work again
- 🔄 **Easy Expansion Packs**: Add new capabilities (AI development, game dev, DevOps) without reinstalling everything
- 🤖 **Specialized AI Agents**: Extra agents for AI development, infrastructure, safety governance, and more
- 🎯 **Smart Story Validation**: 3-tier validation system for parallel development that balances quality with developer autonomy
- 🛠️ **Enhanced Reliability**: Improved installer and testing infrastructure for a smoother experience

## 🚀 Quick Start with Cloud Kinetix Edition

> 🎉 **New v1.11.2**: Enhanced with .storyimpl.md support! Post-install enhancement system ensures Cloud Kinetix modifications are properly applied over upstream files. Maintains all enterprise features while ensuring perfect compatibility with upstream BMAD.

### Ultra-Simple Installation

```bash
# One command installs everything in the current directory
npx @cloudkinetix/bmad-enhanced@latest install

# This thin wrapper:
# 1️⃣ Runs: npx bmad-method@latest install --full
# 2️⃣ Adds: All 8 expansion packs on top
# 3️⃣ Done: Full BMAD + CK enhancements in current directory
```

### 📋 Installation Options Explained

The `bmad-enhanced install` command supports several options to customize your installation:

#### Basic Options

| Option                   | Description                                                           | Example                    |
| ------------------------ | --------------------------------------------------------------------- | -------------------------- |
| `-d, --directory <path>` | Install in specific directory                                         | `--directory ./my-project` |
| `-f, --full`             | Full installation with all IDEs and expansion packs (non-interactive) | `--full`                   |
| `--verbose`              | Show detailed installation progress                                   | `--verbose`                |

#### IDE Selection

| Option           | Description                  | Example             |
| ---------------- | ---------------------------- | ------------------- |
| `--ide <ide...>` | Install specific IDE(s) only | `--ide cursor trae` |

Available IDEs: `cursor`, `claude-code`, `windsurf`, `roo`, `cline`, `trae`, `gemini-cli`, `vs-code-copilot`

#### Expansion Pack Management

| Option                         | Description                                              | Example                                                  |
| ------------------------------ | -------------------------------------------------------- | -------------------------------------------------------- |
| `--expansion-packs <packs...>` | Install specific expansion packs                         | `--expansion-packs ck-jira-integration ck-llm-agent-dev` |
| `--expansion-only`             | Add expansion packs to existing installation (skip core) | `--expansion-only --expansion-packs ck-jira-integration` |

Available expansion packs:

- **Cloud-Kinetix**: `ck-jira-integration`, `ck-llm-agent-dev`, `ck-parallel-dev`, `ck-gitlab-cicd-automation`
- **Upstream BMAD**: `bmad-infrastructure-devops`, `bmad-creator-tools`, `bmad-2d-phaser-game-dev`, `bmad-2d-unity-game-dev`

#### CI/CD and Automation

| Option              | Description                       | Example             |
| ------------------- | --------------------------------- | ------------------- |
| `--non-interactive` | Skip all prompts (for scripts/CI) | `--non-interactive` |

**Note**: The `--full` flag automatically enables non-interactive mode, so `--non-interactive` is redundant when using `--full`.

#### Common Installation Patterns

```bash
# Full installation (recommended for new users)
npx @cloudkinetix/bmad-enhanced@latest install --full

# Install for specific IDE with JIRA integration
npx @cloudkinetix/bmad-enhanced@latest install --ide cursor --expansion-packs ck-jira-integration

# Add expansion pack to existing installation
npx @cloudkinetix/bmad-enhanced@latest install --expansion-only --expansion-packs ck-llm-agent-dev --ide cursor

# CI/CD installation
npx @cloudkinetix/bmad-enhanced@latest install --full --directory /path/to/project

# Verbose installation for troubleshooting
npx @cloudkinetix/bmad-enhanced@latest install --verbose
```

### Advanced Options

```bash
# Install globally for easy access
npm install -g @cloudkinetix/bmad-enhanced@latest
bmad-enhanced install

# Custom directory
npx @cloudkinetix/bmad-enhanced@latest install --directory ./my-project

# Check status
bmad-enhanced status
```

### 🆕 **Ultra-Simple Thin Wrapper Architecture**

Cloud Kinetix Enhanced is now an ultra-simple thin wrapper:

```bash
# Thin wrapper approach
npx @cloudkinetix/bmad-enhanced@latest install

# What it does:
# 1. Calls upstream: npx bmad-method@latest install --full
# 2. Adds our 8 expansion packs on top
# 3. That's it!

# Status check
npx @cloudkinetix/bmad-enhanced@latest status
```

> **Why thin wrapper?** Maximum reliability by leveraging upstream's proven installer + our expansion packs. Simpler code, fewer bugs, always up-to-date with upstream.

### 📚 **Documentation**

- **[📖 Documentation Hub](docs-ck/README.md)** - Complete documentation index
- **[CLI Reference](docs-ck/CLI_REFERENCE.md)** - Complete command reference and migration guide
- **[Web Bundles Guide](docs-ck/WEB_BUNDLES_GUIDE.md)** - Guide to generating and using web bundles
- **[Workflow Plans Guide](docs-ck/WORKFLOW_PLANS_GUIDE.md)** - How to use workflow plans with expansion packs
- **[Migration Guide v1.4.0](docs-ck/archive/MIGRATION_GUIDE_v1.4.md)** - Upgrading from earlier versions
- **[Pass-Through Architecture](docs-ck/PASS_THROUGH_LAYER.md)** - Technical details of the new architecture
- **[Expansion Packs](expansion-packs/README.md)** - Available enterprise features

⭐ **If you find this project helpful or useful, please give it a star in the upper right hand corner!** It helps others discover the Cloud Kinetix Enhanced BMad-Method and you will be notified of updates!

## Overview

**BMad Method's Two Key Innovations:**

**1. Agentic Planning:** Dedicated agents (Analyst, PM, Architect) collaborate with you to create detailed, consistent PRDs and Architecture documents. Through advanced prompt engineering and human-in-the-loop refinement, these planning agents produce comprehensive specifications that go far beyond generic AI task generation.

**2. Context-Engineered Development:** The Scrum Master agent then transforms these detailed plans into hyper-detailed development stories that contain everything the Dev agent needs - full context, implementation details, and architectural guidance embedded directly in story files.

This two-phase approach eliminates both **planning inconsistency** and **context loss** - the biggest problems in AI-assisted development. Your Dev agent opens a story file with complete understanding of what to build, how to build it, and why.

**📖 [See the complete workflow in the User Guide](bmad-core/user-guide.md)** - Planning phase, development cycle, and all agent roles

## Quick Navigation

### Understanding the BMad Workflow

**Before diving in, review these critical workflow diagrams that explain how BMad works:**

1. **[Planning Workflow (Web UI)](bmad-core/user-guide.md#the-planning-workflow-web-ui)** - How to create PRD and Architecture documents
2. **[Core Development Cycle (IDE)](bmad-core/user-guide.md#the-core-development-cycle-ide)** - How SM, Dev, and QA agents collaborate through story files

> ⚠️ **These diagrams explain 90% of BMad Method Agentic Agile flow confusion** - Understanding the PRD+Architecture creation and the SM/Dev/QA workflow and how agents pass notes through story files is essential - and also explains why this is NOT taskmaster or just a simple task runner!

### What would you like to do?

- **[Install and Build software with Full Stack Agile AI Team](#quick-start)** → Quick Start Instruction
- **[Learn how to use BMad](bmad-core/user-guide.md)** → Complete user guide and walkthrough
- **[See available AI agents](/bmad-core/agents))** → Specialized roles for your team
- **[Explore non-technical uses](#-beyond-software-development---expansion-packs)** → Creative writing, business, wellness, education
- **[Create my own AI agents](#creating-your-own-expansion-pack)** → Build agents for your domain
- **[Browse ready-made expansion packs](expansion-packs/)** → Game dev, DevOps, infrastructure and get inspired with ideas and examples
- **[Understand the architecture](docs/core-architecture.md)** → Technical deep dive
- **[Join the community](https://discord.gg/gk8jAdXWmj)** → Get help and share ideas

## Important: Keep Your BMad Installation Updated

**BMad-Method is actively maintained and frequently updated with new features and improvements.**

To stay up to date with the latest release:

```bash
npm update -g bmad-method
```

Check your current version:

```bash
# Check installed version
npm list -g bmad-method

# Check latest available version
npm view bmad-method version
```

## Quick Start

### Prerequisites

- **Node.js 20+ and npm 10+**
- **AI IDE**: One of the following:
  - [Claude Code](https://claude.ai/claude-code)
  - [Cursor AI](https://cursor.sh/)
  - [Windsurf](https://codeium.com/windsurf)
  - [Roo Code (formerly Zed AI)](https://roo.app/)
  - [Trae IDE](https://trae.ai/)
  - [VS Code with GitHub Copilot](https://github.com/features/copilot)
  - [Cline for VS Code](https://github.com/ckline-ai/cline)
  - [Gemini CLI](https://ai.google.dev/gemini-api/docs/downloads)

### Installation (Simple One-Liner)

```bash
npx bmad-method@latest install
```

This command will:

1. Create a `bmad-agents/` directory
2. Install all AI agents and workflows
3. Set up your chosen IDE configuration
4. Provide activation instructions

- **New installations** - Sets up BMad in your project
- **Upgrades** - Updates existing installations automatically
- **Expansion packs** - Installs any expansion packs you've added to package.json

> **That's it!** Whether you're installing for the first time, upgrading, or adding expansion packs - these commands do everything.

**Prerequisites**: [Node.js](https://nodejs.org) v20+ required

### Fastest Start: Web UI Full Stack Team at your disposal (2 minutes)

1. **Get the bundle**: Save or clone the [full stack team file](dist/teams/team-fullstack.txt) or choose another team
2. **Create AI agent**: Create a new Gemini Gem or CustomGPT
3. **Upload & configure**: Upload the file and set instructions: "Your critical operating instructions are attached, do not break character as directed"
4. **Start Ideating and Planning**: Start chatting! Type `*help` to see available commands or pick an agent like `*analyst` to start right in on creating a brief.
5. **CRITICAL**: Talk to BMad Orchestrator in the web at ANY TIME (#bmad-orchestrator command) and ask it questions about how this all works!
6. **When to move to the IDE**: Once you have your PRD, Architecture, optional UX and Briefs - its time to switch over to the IDE to shard your docs, and start implementing the actual code! See the [User guide](bmad-core/user-guide.md) for more details

### Alternative: Clone and Build

```bash
# Clone the repository
git clone https://github.com/bmadcode/BMAD-METHOD.git
cd BMAD-METHOD

# Install dependencies
npm install

# Run the installer from source
node tools/installer/bin/install.js
```

## Team Installation Options

During installation, you'll be asked which team configuration you want. Each team is optimized for different project types:

### Available Teams

- **fullstack** - Complete web development team (PM, Architect, Dev, QA, etc.)
- **backend** - API and backend services team
- **frontend** - UI/UX focused team
- **mobile** - Mobile app development team
- **minimal** - Just PM, Dev, and QA agents
- **custom** - Choose your own agents

## Codebase Flattener Tool

The BMad-Method includes a powerful codebase flattener tool designed to prepare your project files for AI model consumption. This tool aggregates your entire codebase into a single XML file, making it easy to share your project context with AI assistants for analysis, debugging, or development assistance.

### Features

- **AI-Optimized Output**: Generates clean XML format specifically designed for AI model consumption
- **Smart Filtering**: Automatically respects `.gitignore` patterns to exclude unnecessary files
- **Binary File Detection**: Intelligently identifies and excludes binary files, focusing on source code
- **Progress Tracking**: Real-time progress indicators and comprehensive completion statistics
- **Flexible Output**: Customizable output file location and naming

### Usage

```bash
# Basic usage - creates flattened-codebase.xml in current directory
npx bmad-method flatten

# Specify custom input directory
npx bmad-method flatten --input /path/to/source/directory
npx bmad-method flatten -i /path/to/source/directory

# Specify custom output file
npx bmad-method flatten --output my-project.xml
npx bmad-method flatten -o /path/to/output/codebase.xml

# Combine input and output options
npx bmad-method flatten --input /path/to/source --output /path/to/output/codebase.xml
```

### Example Output

The tool will display progress and provide a comprehensive summary:

```
📊 Completion Summary:
✅ Successfully processed 156 files into flattened-codebase.xml
📁 Output file: /path/to/your/project/flattened-codebase.xml
📏 Total source size: 2.3 MB
📄 Generated XML size: 2.1 MB
📝 Total lines of code: 15,847
🔢 Estimated tokens: 542,891
📊 File breakdown: 142 text, 14 binary, 0 errors
```

The generated XML file contains all your project's source code in a structured format that AI models can easily parse and understand, making it perfect for code reviews, architecture discussions, or getting AI assistance with your BMad-Method projects.

## Documentation & Resources

- 📖 **[User Guide](bmad-core/user-guide.md)** - Complete walkthrough from project inception to completion
- 🏗️ **[Core Architecture](docs/core-architecture.md)** - Technical deep dive and system design
- 🚀 **[Expansion Packs Guide](docs/expansion-packs.md)** - Extend BMad to any domain beyond software development

## 🎮 Beyond Software Development - Expansion Packs

BMad Method is a **universal framework** that works in any domain. Software development is just the beginning! Expansion packs transform BMad into specialized tools for any field where AI expertise can accelerate human creativity and productivity.

### Ready-to-Use Expansion Packs

#### 🎮 [2D Phaser Game Development](expansion-packs/bmad-2d-phaser-game-dev/)

Complete game development team with specialized roles:

- **Game Designer**: Creates GDDs, defines mechanics, plans levels
- **Game Developer**: Implements using Phaser.js and Node.js
- **Game SM**: Manages sprints and milestones
- **Art Director**: Guides visual style and asset creation

```bash
# Install with game development expansion
npx bmad-method@latest install --expansion-packs bmad-2d-phaser-game-dev
```

#### 🏗️ [Infrastructure & DevOps](expansion-packs/bmad-infrastructure-devops/)

Enterprise infrastructure automation:

- **Platform Engineer**: Designs cloud architecture
- **DevOps Specialist**: Implements CI/CD pipelines
- **Security Expert**: Ensures compliance and security
- **Cost Optimizer**: Manages cloud spend

```bash
# Install with infrastructure expansion
npx bmad-method@latest install --expansion-packs bmad-infrastructure-devops
```

### Creating Your Own Expansion Pack

BMad's architecture makes it easy to create agents for any domain:

1. **Identify Your Domain Experts**: What roles exist in your field?
2. **Define Agent Personas**: Create specialized knowledge and behavior
3. **Build Workflows**: How do these experts collaborate?
4. **Package and Share**: Contribute back to the community

Example domains perfect for expansion packs:

- 📚 **Education**: Curriculum Designer, Learning Expert, Assessment Specialist
- 🏥 **Healthcare**: Medical Researcher, Clinical Advisor, Patient Advocate
- 🎨 **Creative Arts**: Story Writer, Character Developer, World Builder
- 💼 **Business**: Strategy Consultant, Market Analyst, Operations Expert
- 🧘 **Wellness**: Fitness Coach, Nutrition Expert, Mental Health Guide

**[See the Expansion Pack Development Guide](docs/creating-expansions.md)** for detailed instructions.

## Available Agents

### Core Agile Team

- **Analyst** - Research, competitive analysis, and project briefs
- **PM** (Product Manager) - Creates comprehensive PRDs with epics and stories
- **PO** (Product Owner) - Refines stories and manages backlog
- **Architect** - Designs technical architecture and system design
- **UX Expert** - UI/UX design and user experience
- **SM** (Scrum Master) - Orchestrates development workflow
- **Dev** (Developer) - Implements features with production-ready code
- **QA** (Quality Assurance) - Tests and validates implementations

### Specialized Agents

- **BMad Master** - Orchestrates complex multi-agent workflows
- **BMad Creator** - Helps create new agents and expansion packs

## Current State vs Future Vision

### What BMad Does Today

- ✅ Provides 10+ specialized AI agents for software development
- ✅ Enables consistent planning through PRD and Architecture documents
- ✅ Maintains context across entire projects through story files
- ✅ Works with 7 major AI IDEs out of the box
- ✅ Supports expansion packs for other domains
- ✅ Includes enterprise features (in Cloud Kinetix fork)

### What BMad Will Do (Roadmap)

- 🔄 Multi-agent autonomous collaboration
- 🔄 Real-time agent communication protocols
- 🔄 Advanced memory and learning systems
- 🔄 Direct tool integration (databases, APIs, deployment)
- 🔄 Visual workflow designers
- 🔄 Custom domain training for agents

## Recommended Workflow

> 📖 **[See detailed workflow diagrams in the User Guide](bmad-core/user-guide.md)**

### Planning Phase (Web UI Recommended)

1. **Analyst**: Research and create project brief
2. **PM**: Transform brief into detailed PRD with epics and stories
3. **Architect**: Create technical architecture document
4. **UX Expert**: Design UI/UX specifications (if needed)

### Development Phase (IDE)

5. **SM**: Orchestrate development workflow and create detailed story files
6. **Dev**: Implement features following story specifications
7. **QA**: Test and validate each implementation

## IDE Usage

### VS Code with GitHub Copilot

```
1. Open the Chat view (⌃⌘I on Mac, Ctrl+Alt+I on Windows/Linux)
2. Click "Choose a GitHub Copilot Chat participant"
3. Select the BMad agent you want (e.g., @bmad-sm)
4. Start chatting with your selected agent
```

### Cursor AI

```
@bmad-pm Create a PRD for a task management app
@bmad-architect Design the system architecture
@bmad-dev Implement the user authentication feature
```

### Claude Code

```
/bmad-analyst Research competitors in the social media space
/bmad-sm Create sprint plan for MVP
/bmad-qa Test the login functionality
```

### Windsurf (Cascade)

```
@bmad-ux Design a modern dashboard interface
@bmad-dev Build the REST API endpoints
@bmad-architect Suggest microservices architecture
```

### Roo Code

Access through the agent mode selector:

- `bmad-pm` - Product management mode
- `bmad-dev` - Development mode
- `bmad-qa` - Testing mode

### Cline

Configure in settings or use:

```
@bmad-analyst Analyze market opportunities
@bmad-dev Implement payment integration
```

### Gemini CLI

```
@bmad-po Refine user stories for sprint 3
@bmad-architect Review database schema design
```

## Advanced Installation Options

### Custom Installation

```bash
# Install with specific team
npx bmad-method@latest install --team backend

# Install with expansion packs
npx bmad-method@latest install --expansion-packs bmad-2d-phaser-game-dev,bmad-infrastructure-devops

# Install for specific IDE
npx bmad-method@latest install --ide cursor

# Non-interactive installation
npx bmad-method@latest install --team fullstack --ide cursor --directory ./my-project
```

### Manual Installation

```bash
# Install globally
npm install -g bmad-method

# Run installer
bmad install
```

## Project Structure

After installation, your `bmad-agents/` directory will contain:

```
bmad-agents/
├── agents/           # Individual AI agents
├── teams/           # Pre-configured team combinations
├── templates/       # PRD, Architecture, and Story templates
├── workflows/       # Structured development processes
├── .claude/         # Claude Code configuration
├── .cursorrules     # Cursor AI configuration
├── .windsurfrules   # Windsurf configuration
├── .trae/rules/     # Trae IDE configuration
├── .github/copilot  # VS Code Copilot configuration
└── [other IDE configs]
```

## Contributing

We welcome contributions! Whether it's new agents, expansion packs, or improvements:

1. Fork the repository
2. Create your feature branch
3. Make your changes
4. Submit a pull request

See [CONTRIBUTING.md](CONTRIBUTING.md) for detailed guidelines.

## Community and Support

- **[Discord Community](https://discord.gg/gk8jAdXWmj)** - Get help, share ideas, and connect
- **[GitHub Issues](https://github.com/bmadcode/BMAD-METHOD/issues)** - Report bugs or request features
- **[Discussions](https://github.com/bmadcode/BMAD-METHOD/discussions)** - Share ideas and examples
- **[YouTube Channel](https://www.youtube.com/@BMadCode?sub_confirmation=1)** - Video tutorials and demos

## License

MIT License - see [LICENSE](LICENSE) file for details.

## Acknowledgments

Built with ❤️ by the BMad community. Special thanks to all contributors and early adopters who helped shape this framework.

Remember: **BMad Method is not just about building software - it's about amplifying human potential with AI in any domain.**