Compare commits
7 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
91272a0077 | ||
|
|
e663a1146b | ||
|
|
6dca9cc5ba | ||
|
|
0881735a20 | ||
|
|
61ab1161e5 | ||
|
|
93d3a47326 | ||
|
|
bd6a558929 |
21
CHANGELOG.md
21
CHANGELOG.md
@@ -1,3 +1,24 @@
|
||||
# [4.7.0](https://github.com/bmadcode/BMAD-METHOD/compare/v4.6.3...v4.7.0) (2025-06-19)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* extensive bmad-kb for web orchestrator to be much more helpful ([e663a11](https://github.com/bmadcode/BMAD-METHOD/commit/e663a1146b89e7b5078d9726649a51ae5624da46))
|
||||
|
||||
## [4.6.3](https://github.com/bmadcode/BMAD-METHOD/compare/v4.6.2...v4.6.3) (2025-06-19)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* SM fixed file resolution issue in v4 ([61ab116](https://github.com/bmadcode/BMAD-METHOD/commit/61ab1161e59a92d657ab663082abcaf26729fa6b))
|
||||
|
||||
## [4.6.2](https://github.com/bmadcode/BMAD-METHOD/compare/v4.6.1...v4.6.2) (2025-06-19)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* installer upgrade path fixed ([bd6a558](https://github.com/bmadcode/BMAD-METHOD/commit/bd6a55892906077a700f488bde175b57e846729d))
|
||||
|
||||
## [4.6.1](https://github.com/bmadcode/BMAD-METHOD/compare/v4.6.0...v4.6.1) (2025-06-19)
|
||||
|
||||
|
||||
|
||||
@@ -2,6 +2,12 @@
|
||||
|
||||
CRITICAL: Read the full YML, start activation to alter your state of being, follow startup section instructions, stay in this being until told to exit this mode:
|
||||
|
||||
## Task and File Resolution
|
||||
|
||||
`Create Next Story`: `.bmad-core/tasks/create-next-story.md`
|
||||
`story-tmpl`: `.bmad-core/templates/story-tmpl.md`
|
||||
`story-draft-checklist`: `.bmad-core/checklists/story-draft-checklist.md`
|
||||
|
||||
```yaml
|
||||
activation-instructions:
|
||||
- Follow all instructions in this file -> this defines you, your persona and more importantly what you can do. STAY IN CHARACTER!
|
||||
@@ -21,14 +27,14 @@ persona:
|
||||
identity: Story creation expert who prepares detailed, actionable stories for AI developers
|
||||
focus: Creating crystal-clear stories that dumb AI agents can implement without confusion
|
||||
core_principles:
|
||||
- Task Adherence - Rigorously follow create-next-story procedures
|
||||
- Task Adherence - Rigorously follow `Create Next Story` procedures
|
||||
- Checklist-Driven Validation - Apply story-draft-checklist meticulously
|
||||
- Clarity for Developer Handoff - Stories must be immediately actionable
|
||||
- Focus on One Story at a Time - Complete one before starting next
|
||||
- Numbered Options Protocol - Always use numbered lists for selections
|
||||
startup:
|
||||
- Greet the user with your name and role, and inform of the *help command.
|
||||
- CRITICAL: Do NOT automatically execute create-next-story tasks during startup
|
||||
- CRITICAL: Do NOT automatically execute `Create Next Story` tasks during startup
|
||||
- CRITICAL: Do NOT create or modify any files during startup
|
||||
- Offer to help with story preparation but wait for explicit user confirmation
|
||||
- Only execute tasks when user explicitly requests them
|
||||
@@ -36,7 +42,7 @@ startup:
|
||||
commands:
|
||||
- '*help" - Show: numbered list of the following commands to allow selection'
|
||||
- '*chat-mode" - Conversational mode with advanced-elicitation for advice'
|
||||
- '*create" - Execute all steps in Create Next Story Task document'
|
||||
- '*create" - Execute all steps in `Create Next Story`'
|
||||
- '*pivot" - Run correct-course task (ensure no story already created first)'
|
||||
- '*checklist {checklist}" - Show numbered list of checklists, execute selection'
|
||||
- '*doc-shard {PRD|Architecture|Other}" - Execute shard-doc task'
|
||||
|
||||
@@ -12,6 +12,60 @@ BMAD-METHOD (Breakthrough Method of Agile AI-driven Development) is a framework
|
||||
- **Reusable Resources**: Portable templates, tasks, and checklists
|
||||
- **Slash Command Integration**: Quick agent switching and control
|
||||
|
||||
### When to Use BMAD
|
||||
|
||||
- **New Projects (Greenfield)**: Complete end-to-end development
|
||||
- **Existing Projects (Brownfield)**: Feature additions and enhancements
|
||||
- **Team Collaboration**: Multiple roles working together
|
||||
- **Quality Assurance**: Structured testing and validation
|
||||
- **Documentation**: Professional PRDs, architecture docs, user stories
|
||||
|
||||
## Getting Started
|
||||
|
||||
### Quick Start Options
|
||||
|
||||
#### Option 1: Web UI
|
||||
**Best for**: ChatGPT, Claude, Gemini users who want to start immediately
|
||||
|
||||
1. Navigate to `.bmad-core/web-bundles/teams/`
|
||||
2. Copy `team-fullstack.txt` content
|
||||
3. Create new Gemini Gem or CustomGPT
|
||||
4. Upload file with instructions: "Your critical operating instructions are attached, do not break character as directed"
|
||||
5. Type `/help` to see available commands
|
||||
|
||||
#### Option 2: IDE Integration
|
||||
**Best for**: Cursor, Claude Code, Windsurf, VS Code users
|
||||
|
||||
```bash
|
||||
# Interactive installation (recommended)
|
||||
npx bmad-method install
|
||||
```
|
||||
|
||||
**Installation Steps**:
|
||||
- Choose "Complete installation"
|
||||
- Select your IDE (Cursor, Claude Code, Windsurf, or Roo Code)
|
||||
|
||||
**Verify Installation**:
|
||||
- `.bmad-core/` folder created with all agents
|
||||
- IDE-specific integration files created
|
||||
- All agent commands/rules/modes available
|
||||
|
||||
### Environment Selection Guide
|
||||
|
||||
**Use Web UI for**:
|
||||
- Initial planning and documentation (PRD, architecture)
|
||||
- Cost-effective document creation (especially with Gemini)
|
||||
- Brainstorming and analysis phases
|
||||
- Multi-agent consultation and planning
|
||||
|
||||
**Use IDE for**:
|
||||
- Active development and coding
|
||||
- File operations and project integration
|
||||
- Document sharding and story management
|
||||
- Implementation workflow (SM/Dev cycles)
|
||||
|
||||
**Cost-Saving Tip**: Create large documents (PRDs, architecture) in web UI, then copy to `docs/prd.md` and `docs/architecture.md` in your project before switching to IDE for development.
|
||||
|
||||
## Core Philosophy
|
||||
|
||||
### Vibe CEO'ing
|
||||
@@ -33,15 +87,339 @@ You are the "Vibe CEO" - thinking like a CEO with unlimited resources and a sing
|
||||
7. **START_SMALL_SCALE_FAST**: Test concepts, then expand.
|
||||
8. **EMBRACE_THE_CHAOS**: Adapt and overcome challenges.
|
||||
|
||||
## IDE Development Workflow
|
||||
### Key Workflow Principles
|
||||
|
||||
1. Shard the PRD (And Architecture documents if they exist also based on workflow type) using the Doc Shard task. The BMad-Master agent can help you do this. You will select the task, provide the doc to shard and the output folder. for example: `BMad Master, please Shard the docs/prd.md to the doc/prd/ folder` - this should ask you to use the md-tree-parser which is recommended, but either way shoudl result in multiple documents being created in the folder docs/prd.
|
||||
2. If you have fullstack, front end and or back end architecture documents you will want to follow the same thing, but shard all of these to an architecture folder instead of a prd folder.
|
||||
3. Ensure that you have at least one epic-n.md file in your prd folder, with the stories in order to develop.
|
||||
4. The docs or architecture folder or prd folder should have a source tree document and coding standards at a minimum. These are used by the dev agent, and the many other sharded docs are used by the SM agent.
|
||||
5. Use a new chat window to allow the SM agent to `draft the next story`.
|
||||
6. If you agree the story is correct, mark it as approved in the status field, and then start a new chat window with the dev agent.
|
||||
7. Ask the dev agent to implement the next story. If you draft the story file into the chat it will save time for the dev to have to find what the next one is. The dev should follow the tasks and subtasks marking them off as they are completed. The dev agent will also leave notes potentially for the SM to know about any deviations that might have occured to help draft the next story.
|
||||
8. Once complete and you have verified, mark it done, and start a new chat. Ask the SM to draft the next story - repeating the cycle.
|
||||
1. **Agent Specialization**: Each agent has specific expertise and responsibilities
|
||||
2. **Clean Handoffs**: Always start fresh when switching between agents
|
||||
3. **Status Tracking**: Maintain story statuses (Draft → Approved → InProgress → Done)
|
||||
4. **Iterative Development**: Complete one story before starting the next
|
||||
5. **Documentation First**: Always start with solid PRD and architecture
|
||||
|
||||
With this work flow, there is only 1 story in progress at a time, worked sequentially.
|
||||
## Agent System
|
||||
|
||||
### Core Development Team
|
||||
|
||||
| Agent | Role | Primary Functions | When to Use |
|
||||
| ----------- | ------------------ | --------------------------------------- | -------------------------------------- |
|
||||
| `analyst` | Business Analyst | Market research, requirements gathering | Project planning, competitive analysis |
|
||||
| `pm` | Product Manager | PRD creation, feature prioritization | Strategic planning, roadmaps |
|
||||
| `architect` | Solution Architect | System design, technical architecture | Complex systems, scalability planning |
|
||||
| `dev` | Developer | Code implementation, debugging | All development tasks |
|
||||
| `qa` | QA Specialist | Test planning, quality assurance | Testing strategies, bug validation |
|
||||
| `ux-expert` | UX Designer | UI/UX design, prototypes | User experience, interface design |
|
||||
| `po` | Product Owner | Backlog management, story validation | Story refinement, acceptance criteria |
|
||||
| `sm` | Scrum Master | Sprint planning, story creation | Project management, workflow |
|
||||
|
||||
### Meta Agents
|
||||
|
||||
| Agent | Role | Primary Functions | When to Use |
|
||||
| ------------------- | ---------------- | ------------------------------------- | --------------------------------- |
|
||||
| `bmad-orchestrator` | Team Coordinator | Multi-agent workflows, role switching | Complex multi-role tasks |
|
||||
| `bmad-master` | Universal Expert | All capabilities without switching | Single-session comprehensive work |
|
||||
|
||||
### Agent Interaction Commands
|
||||
|
||||
#### IDE-Specific Syntax
|
||||
|
||||
**Agent Loading by IDE**:
|
||||
- **Claude Code**: `/agent-name` (e.g., `/bmad-master`)
|
||||
- **Cursor**: `@agent-name` (e.g., `@bmad-master`)
|
||||
- **Windsurf**: `@agent-name` (e.g., `@bmad-master`)
|
||||
- **Roo Code**: Select mode from mode selector (e.g., `bmad-bmad-master`)
|
||||
|
||||
**Chat Management Guidelines**:
|
||||
- **Claude Code, Cursor, Windsurf**: Start new chats when switching agents
|
||||
- **Roo Code**: Switch modes within the same conversation
|
||||
|
||||
**Common Task Commands**:
|
||||
- `*help` - Show available commands
|
||||
- `*status` - Show current context/progress
|
||||
- `*exit` - Exit the agent mode
|
||||
- `*shard-doc docs/prd.md prd` - Shard PRD into manageable pieces
|
||||
- `*shard-doc docs/architecture.md architecture` - Shard architecture document
|
||||
- `*create` - Run create-next-story task (SM agent)
|
||||
|
||||
**In Web UI**:
|
||||
```text
|
||||
/pm create-doc prd
|
||||
/architect review system design
|
||||
/dev implement story 1.2
|
||||
/help - Show available commands
|
||||
/switch agent-name - Change active agent (if orchestrator available)
|
||||
```
|
||||
|
||||
## Team Configurations
|
||||
|
||||
### Pre-Built Teams
|
||||
|
||||
#### Team All
|
||||
- **Includes**: All 10 agents + orchestrator
|
||||
- **Use Case**: Complete projects requiring all roles
|
||||
- **Bundle**: `team-all.txt`
|
||||
|
||||
#### Team Fullstack
|
||||
- **Includes**: PM, Architect, Developer, QA, UX Expert
|
||||
- **Use Case**: End-to-end web/mobile development
|
||||
- **Bundle**: `team-fullstack.txt`
|
||||
|
||||
#### Team No-UI
|
||||
- **Includes**: PM, Architect, Developer, QA (no UX Expert)
|
||||
- **Use Case**: Backend services, APIs, system development
|
||||
- **Bundle**: `team-no-ui.txt`
|
||||
|
||||
## Core Architecture
|
||||
|
||||
### System Overview
|
||||
|
||||
The BMAD-Method is built around a modular architecture centered on the `bmad-core` directory, which serves as the brain of the entire system. This design enables the framework to operate effectively in both IDE environments (like Cursor, VS Code) and web-based AI interfaces (like ChatGPT, Gemini).
|
||||
|
||||
### Key Architectural Components
|
||||
|
||||
#### 1. Agents (`bmad-core/agents/`)
|
||||
- **Purpose**: Each markdown file defines a specialized AI agent for a specific Agile role (PM, Dev, Architect, etc.)
|
||||
- **Structure**: Contains YAML headers specifying the agent's persona, capabilities, and dependencies
|
||||
- **Dependencies**: Lists of tasks, templates, checklists, and data files the agent can use
|
||||
- **Startup Instructions**: Can load project-specific documentation for immediate context
|
||||
|
||||
#### 2. Agent Teams (`bmad-core/agent-teams/`)
|
||||
- **Purpose**: Define collections of agents bundled together for specific purposes
|
||||
- **Examples**: `team-all.yml` (comprehensive bundle), `team-fullstack.yml` (full-stack development)
|
||||
- **Usage**: Creates pre-packaged contexts for web UI environments
|
||||
|
||||
#### 3. Workflows (`bmad-core/workflows/`)
|
||||
- **Purpose**: YAML files defining prescribed sequences of steps for specific project types
|
||||
- **Types**: Greenfield (new projects) and Brownfield (existing projects) for UI, service, and fullstack development
|
||||
- **Structure**: Defines agent interactions, artifacts created, and transition conditions
|
||||
|
||||
#### 4. Reusable Resources
|
||||
- **Templates** (`bmad-core/templates/`): Markdown templates for PRDs, architecture specs, user stories
|
||||
- **Tasks** (`bmad-core/tasks/`): Instructions for specific repeatable actions like "shard-doc" or "create-next-story"
|
||||
- **Checklists** (`bmad-core/checklists/`): Quality assurance checklists for validation and review
|
||||
- **Data** (`bmad-core/data/`): Core knowledge base and technical preferences
|
||||
|
||||
### Dual Environment Architecture
|
||||
|
||||
#### IDE Environment
|
||||
- Users interact directly with agent markdown files
|
||||
- Agents can access all dependencies dynamically
|
||||
- Supports real-time file operations and project integration
|
||||
- Optimized for development workflow execution
|
||||
|
||||
#### Web UI Environment
|
||||
- Uses pre-built bundles from `bmad-core/web-bundles/`
|
||||
- Single text files containing all agent dependencies
|
||||
- Created by the web-builder tool for upload to web interfaces
|
||||
- Provides complete context in one package
|
||||
|
||||
### Template Processing System
|
||||
|
||||
BMAD employs a sophisticated template system with three key components:
|
||||
|
||||
1. **Template Format** (`utils/template-format.md`): Defines markup language for variable substitution and AI processing directives
|
||||
2. **Document Creation** (`tasks/create-doc.md`): Orchestrates template selection and user interaction
|
||||
3. **Advanced Elicitation** (`tasks/advanced-elicitation.md`): Provides interactive refinement through structured brainstorming
|
||||
|
||||
**Template Features**:
|
||||
- **Self-contained**: Templates embed both output structure and processing instructions
|
||||
- **Variable Substitution**: `{{placeholders}}` for dynamic content
|
||||
- **AI Processing Directives**: `[[LLM: instructions]]` for AI-only processing
|
||||
- **Interactive Refinement**: Built-in elicitation processes for quality improvement
|
||||
|
||||
### Technical Preferences Integration
|
||||
|
||||
The `technical-preferences.md` file serves as a persistent technical profile that:
|
||||
- Ensures consistency across all agents and projects
|
||||
- Eliminates repetitive technology specification
|
||||
- Provides personalized recommendations aligned with user preferences
|
||||
- Evolves over time with lessons learned
|
||||
|
||||
### Build and Delivery Process
|
||||
|
||||
The `web-builder.js` tool creates web-ready bundles by:
|
||||
1. Reading agent or team definition files
|
||||
2. Recursively resolving all dependencies
|
||||
3. Concatenating content into single text files with clear separators
|
||||
4. Outputting ready-to-upload bundles for web AI interfaces
|
||||
|
||||
This architecture enables seamless operation across environments while maintaining the rich, interconnected agent ecosystem that makes BMAD powerful.
|
||||
|
||||
## Complete Development Workflow
|
||||
|
||||
### Planning Phase (Web UI Recommended)
|
||||
|
||||
**Ideal for cost efficiency, especially with Gemini:**
|
||||
|
||||
1. **Optional Analysis**: `/analyst` - Market research, competitive analysis
|
||||
2. **Project Brief**: Create foundation document (Analyst or user)
|
||||
3. **PRD Creation**: `/pm create-doc prd` - Comprehensive product requirements
|
||||
4. **Architecture Design**: `/architect create-doc architecture` - Technical foundation
|
||||
5. **Validation & Alignment**: `/po` run master checklist to ensure document consistency
|
||||
6. **Document Preparation**: Copy final documents to project as `docs/prd.md` and `docs/architecture.md`
|
||||
|
||||
#### Example Planning Prompts
|
||||
|
||||
**For PRD Creation**:
|
||||
```text
|
||||
"I want to build a [type] application that [core purpose].
|
||||
Help me brainstorm features and create a comprehensive PRD."
|
||||
```
|
||||
|
||||
**For Architecture Design**:
|
||||
```text
|
||||
"Based on this PRD, design a scalable technical architecture
|
||||
that can handle [specific requirements]."
|
||||
```
|
||||
|
||||
### Critical Transition: Web UI to IDE
|
||||
|
||||
**Once planning is complete, you MUST switch to IDE for development:**
|
||||
|
||||
- **Why**: Development workflow requires file operations, real-time project integration, and document sharding
|
||||
- **Cost Benefit**: Web UI is more cost-effective for large document creation; IDE is optimized for development tasks
|
||||
- **Required Files**: Ensure `docs/prd.md` and `docs/architecture.md` exist in your project
|
||||
|
||||
### IDE Development Workflow
|
||||
|
||||
**Prerequisites**: Planning documents must exist in `docs/` folder
|
||||
|
||||
1. **Document Sharding**:
|
||||
- `@bmad-master` or `@po` shard `docs/prd.md` to `docs/prd/` folder
|
||||
- If architecture exists, shard to `docs/architecture/` folder
|
||||
- Results in multiple manageable documents and epic files
|
||||
|
||||
2. **Verify Sharded Content**:
|
||||
- At least one `epic-n.md` file in `docs/prd/` with stories in development order
|
||||
- Source tree document and coding standards for dev agent reference
|
||||
- Sharded docs for SM agent story creation
|
||||
|
||||
**Resulting Folder Structure**:
|
||||
- `docs/prd/` - Broken down PRD sections
|
||||
- `docs/architecture/` - Broken down architecture sections
|
||||
- `docs/stories/` - Generated user stories
|
||||
|
||||
3. **Development Cycle** (Sequential, one story at a time):
|
||||
|
||||
**Step 1 - Story Creation**: New chat window → `@sm` → `*create`
|
||||
- SM executes create-next-story task
|
||||
- Review generated story in `docs/stories/`
|
||||
- Update status from "Draft" to "Approved"
|
||||
|
||||
**Step 2 - Story Implementation**: New chat window → `@dev`
|
||||
- Agent asks which story to implement
|
||||
- Include story file content to save dev agent lookup time
|
||||
- Dev follows tasks/subtasks, marking completion
|
||||
- Dev leaves notes for SM about any deviations
|
||||
- Update status to "Done"
|
||||
|
||||
**Step 3 - Repeat**: Continue SM → Dev cycle until all epic stories complete
|
||||
|
||||
**Important**: Only 1 story in progress at a time, worked sequentially until all epic stories complete.
|
||||
|
||||
### Status Tracking Workflow
|
||||
|
||||
Stories progress through defined statuses:
|
||||
- **Draft** → **Approved** → **InProgress** → **Done**
|
||||
|
||||
Each status change requires user verification and approval before proceeding.
|
||||
|
||||
### Workflow Types
|
||||
|
||||
#### Greenfield Development
|
||||
- Business analysis and market research
|
||||
- Product requirements and feature definition
|
||||
- System architecture and design
|
||||
- Development execution
|
||||
- Testing and deployment
|
||||
|
||||
#### Brownfield Enhancement
|
||||
- Current system analysis
|
||||
- Enhancement planning
|
||||
- Impact assessment
|
||||
- Incremental development
|
||||
- Integration testing
|
||||
|
||||
## Document Creation Best Practices
|
||||
|
||||
### Required File Naming for Framework Integration
|
||||
|
||||
- `docs/prd.md` - Product Requirements Document
|
||||
- `docs/architecture.md` - System Architecture Document
|
||||
|
||||
**Why These Names Matter**:
|
||||
- Agents automatically reference these files during development
|
||||
- Sharding tasks expect these specific filenames
|
||||
- Workflow automation depends on standard naming
|
||||
|
||||
### Cost-Effective Document Creation Workflow
|
||||
|
||||
**Recommended for Large Documents (PRD, Architecture):**
|
||||
|
||||
1. **Use Web UI**: Create documents in web interface for cost efficiency
|
||||
2. **Copy Final Output**: Save complete markdown to your project
|
||||
3. **Standard Names**: Save as `docs/prd.md` and `docs/architecture.md`
|
||||
4. **Switch to IDE**: Use IDE agents for development and smaller documents
|
||||
|
||||
### Document Sharding
|
||||
|
||||
Templates with Level 2 headings (`##`) can be automatically sharded:
|
||||
|
||||
**Original PRD**:
|
||||
```markdown
|
||||
## Goals and Background Context
|
||||
## Requirements
|
||||
## User Interface Design Goals
|
||||
## Success Metrics
|
||||
```
|
||||
|
||||
**After Sharding**:
|
||||
- `docs/prd/goals-and-background-context.md`
|
||||
- `docs/prd/requirements.md`
|
||||
- `docs/prd/user-interface-design-goals.md`
|
||||
- `docs/prd/success-metrics.md`
|
||||
|
||||
Use the `shard-doc` task or `@kayvan/markdown-tree-parser` tool for automatic sharding.
|
||||
|
||||
## Usage Patterns and Best Practices
|
||||
|
||||
### Environment-Specific Usage
|
||||
|
||||
**Web UI Best For**:
|
||||
- Initial planning and documentation phases
|
||||
- Cost-effective large document creation
|
||||
- Agent consultation and brainstorming
|
||||
- Multi-agent workflows with orchestrator
|
||||
|
||||
**IDE Best For**:
|
||||
- Active development and implementation
|
||||
- File operations and project integration
|
||||
- Story management and development cycles
|
||||
- Code review and debugging
|
||||
|
||||
### Quality Assurance
|
||||
|
||||
- Use appropriate agents for specialized tasks
|
||||
- Follow Agile ceremonies and review processes
|
||||
- Maintain document consistency with PO agent
|
||||
- Regular validation with checklists and templates
|
||||
|
||||
### Performance Optimization
|
||||
|
||||
- Use specific agents vs. `bmad-master` for focused tasks
|
||||
- Choose appropriate team size for project needs
|
||||
- Leverage technical preferences for consistency
|
||||
- Regular context management and cache clearing
|
||||
|
||||
## Success Tips
|
||||
|
||||
- **Use Gemini for big picture planning** - The team-fullstack bundle provides collaborative expertise
|
||||
- **Use bmad-master for document organization** - Sharding creates manageable chunks
|
||||
- **Follow the SM → Dev cycle religiously** - This ensures systematic progress
|
||||
- **Keep conversations focused** - One agent, one task per conversation
|
||||
- **Review everything** - Always review and approve before marking complete
|
||||
|
||||
## Getting Help
|
||||
|
||||
- **Commands**: Use `/help` in any environment to see available commands
|
||||
- **Agent Switching**: Use `/switch agent-name` with orchestrator for role changes
|
||||
- **Documentation**: Check `docs/` folder for project-specific context
|
||||
- **Community**: Discord and GitHub resources available for support
|
||||
|
||||
@@ -33,11 +33,13 @@ The BMAD Method follows a structured approach to AI-assisted software developmen
|
||||
|
||||
Use Google's Gemini for collaborative planning with the full team:
|
||||
|
||||
1. **Open [Google AI Studio](https://aistudio.google.com/)**
|
||||
2. **Load team-fullstack**:
|
||||
- Copy contents of: `/Users/brianmadison/dev/BMAD-METHOD/.bmad-core/web-bundles/teams/team-fullstack.txt`
|
||||
- Paste into new Gemini chat
|
||||
3. **Collaborate with the team**:
|
||||
1. **Open [Google Gems](https://gemini.google.com/gems/view)**
|
||||
2. **Create a new Gem**:
|
||||
- Give it a title and description (e.g., "BMAD Team Fullstack")
|
||||
3. **Load team-fullstack**:
|
||||
- Copy contents of: `.bmad-core/web-bundles/teams/team-fullstack.txt` from your project
|
||||
- Paste this content into the Gem setup to configure the team
|
||||
4. **Collaborate with the team**:
|
||||
- Business Analyst: Requirements gathering
|
||||
- Product Manager: Feature prioritization
|
||||
- Solution Architect: Technical design
|
||||
@@ -53,9 +55,9 @@ Help me brainstorm features and create a comprehensive PRD."
|
||||
that can handle [specific requirements]."
|
||||
```
|
||||
|
||||
4. **Export planning documents**:
|
||||
- Save PRD as `docs/prd.md`
|
||||
- Save architecture as `docs/architecture.md`
|
||||
5. **Export planning documents**:
|
||||
- Copy the PRD output and save as `docs/prd.md` in your project
|
||||
- Copy the architecture output and save as `docs/architecture.md` in your project
|
||||
|
||||
### Phase 3: Document Organization (IDE)
|
||||
|
||||
|
||||
@@ -56,12 +56,9 @@ Best for: ChatGPT, Claude, Gemini users
|
||||
|
||||
Best for: Cursor, Claude Code, Windsurf, VS Code users
|
||||
|
||||
```bash
|
||||
````bash
|
||||
# Interactive installation (recommended)
|
||||
npx bmad-method install
|
||||
|
||||
# Command line installation
|
||||
npx bmad-method install --full --directory ./my-project --ide cursor
|
||||
```text
|
||||
|
||||
### First Steps
|
||||
@@ -109,7 +106,7 @@ dependencies:
|
||||
- shard-doc.md
|
||||
data:
|
||||
- bmad-kb.md
|
||||
```
|
||||
````
|
||||
|
||||
**Key Points:**
|
||||
|
||||
@@ -121,7 +118,7 @@ dependencies:
|
||||
|
||||
**In IDE:**
|
||||
|
||||
```bash
|
||||
````bash
|
||||
# Cursor or Windsurf (manual rules - loaded with @)
|
||||
@pm Create a PRD for a task management app
|
||||
@architect Design the system architecture
|
||||
@@ -138,7 +135,7 @@ dependencies:
|
||||
/pm create-doc prd
|
||||
/architect review system design
|
||||
/dev implement story 1.2
|
||||
```
|
||||
````
|
||||
|
||||
## Templates and Document Creation
|
||||
|
||||
@@ -178,7 +175,7 @@ Templates follow the `template-format.md` specification:
|
||||
|
||||
- **Template**: `architecture-template.md`
|
||||
- **Agent**: Architect
|
||||
- **Use Case**: System design, technical planning
|
||||
- **Use Case**: System design, technical planning
|
||||
- **Command**: `/architect create-doc architecture`
|
||||
- **💡 Cost-Saving Tip**: For Gemini users, create architecture docs in the web UI to avoid high IDE token costs. Copy the final markdown output to `docs/architecture.md` in your project.
|
||||
|
||||
@@ -203,10 +200,12 @@ For cost efficiency, especially with Gemini:
|
||||
#### File Naming Conventions
|
||||
|
||||
**Required Names for Framework Integration:**
|
||||
|
||||
- `docs/prd.md` - Product Requirements Document
|
||||
- `docs/architecture.md` - System Architecture Document
|
||||
|
||||
**Why These Names Matter:**
|
||||
|
||||
- Agents automatically reference these files during development
|
||||
- Sharding tasks expect these specific filenames
|
||||
- Workflow automation depends on standard naming
|
||||
@@ -214,6 +213,7 @@ For cost efficiency, especially with Gemini:
|
||||
#### IDE Document Creation
|
||||
|
||||
When working directly in IDEs:
|
||||
|
||||
- Agents should create documents in `docs/` folder automatically
|
||||
- If agents name files differently (e.g., `product-requirements.md`), rename to `prd.md`
|
||||
- Verify document location matches `docs/prd.md` and `docs/architecture.md`
|
||||
@@ -224,9 +224,10 @@ When working directly in IDEs:
|
||||
|
||||
Templates can include `advanced-elicitation.md` for enhanced interaction:
|
||||
|
||||
```markdown
|
||||
`````markdown
|
||||
[[LLM: Use advanced-elicitation actions 0-3 to refine requirements]]
|
||||
```text
|
||||
|
||||
````text
|
||||
|
||||
This provides 10 structured brainstorming actions:
|
||||
|
||||
@@ -262,12 +263,15 @@ graph TD
|
||||
I --> L["📁 Switch to IDE"]
|
||||
L --> M["PO: Shard Documents"]
|
||||
M --> N["Ready for SM/Dev Cycle"]
|
||||
|
||||
|
||||
style I fill:#34a853,color:#fff
|
||||
style G fill:#f9ab00,color:#fff
|
||||
style L fill:#1a73e8,color:#fff
|
||||
style N fill:#34a853,color:#fff
|
||||
```
|
||||
````
|
||||
`````
|
||||
|
||||
`````
|
||||
|
||||
#### Web UI to IDE Transition
|
||||
|
||||
@@ -282,7 +286,7 @@ graph TD
|
||||
|
||||
Once planning is complete and documents are sharded, BMAD follows a structured development workflow:
|
||||
|
||||
```mermaid
|
||||
````mermaid
|
||||
graph TD
|
||||
A["Start: Planning Artifacts Complete"] --> B["PO: Shard Epics"]
|
||||
B --> C["PO: Shard Arch"]
|
||||
@@ -387,7 +391,7 @@ agents:
|
||||
- qa
|
||||
workflows:
|
||||
- greenfield-fullstack
|
||||
```
|
||||
`````
|
||||
|
||||
## IDE Integration
|
||||
|
||||
@@ -487,11 +491,13 @@ workflows:
|
||||
Web UI agents focus on planning and documentation. Here's how to interact with each:
|
||||
|
||||
#### Agent Switching and Conversation
|
||||
|
||||
- **Switch Agents**: Use `/pm`, `/architect`, `/analyst`, `/po` to switch between roles
|
||||
- **Agent Consultation**: Each agent offers their specialized options and capabilities
|
||||
- **Natural Conversation**: Agents guide you through their processes with questions and suggestions
|
||||
|
||||
#### Planning Phase Agents
|
||||
|
||||
- **Analyst**: `/analyst` - Brainstorming, market research, competitive analysis
|
||||
- **PM**: `/pm` - Product requirements, feature definition, roadmaps
|
||||
- **Architect**: `/architect` - System design, technical architecture
|
||||
@@ -511,12 +517,13 @@ Web UI agents focus on planning and documentation. Here's how to interact with e
|
||||
|
||||
1. **Use Web UI for PRD and Architecture**: These are token-heavy documents, especially in Gemini
|
||||
2. **Copy Final Output**: Save complete markdown to your project
|
||||
3. **Standard File Names**:
|
||||
3. **Standard File Names**:
|
||||
- Save PRD as `docs/prd.md`
|
||||
- Save Architecture as `docs/architecture.md`
|
||||
4. **IDE for Development**: Switch to IDE agents for implementation tasks
|
||||
|
||||
**Why This Saves Money:**
|
||||
|
||||
- Web UI pricing is typically more cost-effective for large context windows
|
||||
- PRD and architecture creation involves extensive back-and-forth refinement
|
||||
- IDE token costs can accumulate quickly with large document generation
|
||||
@@ -536,7 +543,7 @@ BMAD's dependency system ensures agents only load necessary resources:
|
||||
|
||||
Create custom templates following `template-format.md`:
|
||||
|
||||
```markdown
|
||||
`````markdown
|
||||
---
|
||||
title: Custom Template
|
||||
description: Your custom document type
|
||||
@@ -557,7 +564,8 @@ dependencies:
|
||||
## Section 2
|
||||
|
||||
{{section_2_content}}
|
||||
```text
|
||||
|
||||
````text
|
||||
|
||||
### Workflow Customization
|
||||
|
||||
@@ -586,7 +594,10 @@ phases:
|
||||
deliverables:
|
||||
- implementation
|
||||
- tests
|
||||
```
|
||||
````
|
||||
`````
|
||||
|
||||
`````
|
||||
|
||||
### Creating Custom Templates
|
||||
|
||||
@@ -594,7 +605,7 @@ Templates are self-contained documents that embed both output structure and proc
|
||||
|
||||
#### Template Structure
|
||||
|
||||
```markdown
|
||||
````markdown
|
||||
# {{Project Name}} Document Title
|
||||
|
||||
[[LLM: Opening instruction for AI processing]]
|
||||
@@ -611,10 +622,13 @@ Templates are self-contained documents that embed both output structure and proc
|
||||
@{example: Example content for AI guidance}
|
||||
|
||||
^^CONDITION: condition_name^^
|
||||
|
||||
## Conditional Section
|
||||
|
||||
[[LLM: Only include if condition is met]]
|
||||
^^/CONDITION^^
|
||||
```text
|
||||
|
||||
````text
|
||||
|
||||
#### Key Template Patterns
|
||||
|
||||
@@ -634,23 +648,30 @@ Templates are self-contained documents that embed both output structure and proc
|
||||
## User Interface Section
|
||||
[[LLM: Only include for UI projects]]
|
||||
^^/CONDITION^^
|
||||
```
|
||||
`````
|
||||
|
||||
`````
|
||||
|
||||
#### Document Sharding
|
||||
|
||||
Level 2 headings (`##`) in templates can be automatically sharded into separate documents:
|
||||
|
||||
**Original PRD:**
|
||||
```markdown
|
||||
|
||||
````markdown
|
||||
## Goals and Background Context
|
||||
## Requirements
|
||||
|
||||
## Requirements
|
||||
|
||||
## User Interface Design Goals
|
||||
|
||||
## Success Metrics
|
||||
```text
|
||||
|
||||
````text
|
||||
|
||||
**After Sharding:**
|
||||
- `docs/prd/goals-and-background-context.md`
|
||||
- `docs/prd/requirements.md`
|
||||
- `docs/prd/requirements.md`
|
||||
- `docs/prd/user-interface-design-goals.md`
|
||||
- `docs/prd/success-metrics.md`
|
||||
|
||||
@@ -676,32 +697,40 @@ Tasks are reusable automation instructions that agents can execute. They follow
|
||||
- Detailed instructions for the agent
|
||||
- Specific behaviors and outputs expected
|
||||
|
||||
### 2. Step Two
|
||||
### 2. Step Two
|
||||
- Additional processing steps
|
||||
- Integration with other resources
|
||||
|
||||
## Examples
|
||||
|
||||
@{example: Concrete usage examples}
|
||||
```
|
||||
`````
|
||||
|
||||
`````
|
||||
|
||||
#### Task Patterns
|
||||
|
||||
**Resource Integration:**
|
||||
```markdown
|
||||
|
||||
````markdown
|
||||
[[LLM: Check if docs/coding-standards.md exists and reference it]]
|
||||
[[LLM: Load docs/openapi-spec.yaml for API context]]
|
||||
```text
|
||||
|
||||
````text
|
||||
|
||||
**Advanced Elicitation:**
|
||||
```markdown
|
||||
[[LLM: Apply tasks#advanced-elicitation protocol after completion]]
|
||||
```
|
||||
`````
|
||||
|
||||
`````
|
||||
|
||||
**Conditional Logic:**
|
||||
```markdown
|
||||
|
||||
````markdown
|
||||
[[LLM: If project has UI components, also check frontend standards]]
|
||||
```text
|
||||
|
||||
````text
|
||||
|
||||
### Creating Custom Agents
|
||||
|
||||
@@ -735,13 +764,15 @@ dependencies:
|
||||
- custom-task.md
|
||||
data:
|
||||
- domain-knowledge.md
|
||||
```
|
||||
`````
|
||||
|
||||
`````
|
||||
|
||||
#### Agent Startup Instructions
|
||||
|
||||
Agents can load project-specific documents and provide custom context:
|
||||
|
||||
```yaml
|
||||
````yaml
|
||||
startup:
|
||||
- Load docs/coding-standards.md if available
|
||||
- Review docs/project-structure.md for context
|
||||
@@ -764,10 +795,10 @@ Agents can reference and load documents from the `docs/` folder:
|
||||
```markdown
|
||||
[[LLM: Before beginning, check for and load relevant context:
|
||||
- docs/coding-standards.md for development standards
|
||||
- docs/brand-guidelines.md for design consistency
|
||||
- docs/brand-guidelines.md for design consistency
|
||||
- docs/third-party-apis/ for integration requirements
|
||||
- Any project-specific documentation in docs/ folder]]
|
||||
```
|
||||
`````
|
||||
|
||||
### Technical Preferences System
|
||||
|
||||
@@ -780,23 +811,28 @@ This file allows you to define your preferred technologies, patterns, and standa
|
||||
#### What to Include
|
||||
|
||||
**Technology Stack Preferences:**
|
||||
```markdown
|
||||
|
||||
`````markdown
|
||||
## Preferred Technologies
|
||||
|
||||
### Frontend
|
||||
|
||||
- React with TypeScript
|
||||
- Tailwind CSS for styling
|
||||
- Next.js for full-stack applications
|
||||
|
||||
### Backend
|
||||
### Backend
|
||||
|
||||
- Node.js with Express
|
||||
- PostgreSQL for relational data
|
||||
- Redis for caching
|
||||
|
||||
### Deployment
|
||||
|
||||
- Vercel for frontend
|
||||
- Railway for backend services
|
||||
```text
|
||||
|
||||
````text
|
||||
|
||||
**Design Patterns & Standards:**
|
||||
```markdown
|
||||
@@ -810,20 +846,27 @@ This file allows you to define your preferred technologies, patterns, and standa
|
||||
- Microservices for complex applications
|
||||
- RESTful APIs with OpenAPI documentation
|
||||
- Event-driven architecture for real-time features
|
||||
```
|
||||
````
|
||||
`````
|
||||
|
||||
`````
|
||||
|
||||
**External Services & APIs:**
|
||||
```markdown
|
||||
|
||||
````markdown
|
||||
## Preferred External Services
|
||||
|
||||
- Auth0 for authentication
|
||||
- Stripe for payments
|
||||
- SendGrid for email
|
||||
- Cloudinary for image processing
|
||||
|
||||
## APIs to Avoid
|
||||
|
||||
- Legacy SOAP services
|
||||
- Services without proper documentation
|
||||
```text
|
||||
|
||||
````text
|
||||
|
||||
#### How Agents Use This File
|
||||
|
||||
@@ -847,7 +890,9 @@ This file allows you to define your preferred technologies, patterns, and standa
|
||||
- Want to try Framework A on next appropriate project
|
||||
- Interested in Pattern B for microservices
|
||||
- Consider Service C for better performance
|
||||
```
|
||||
`````
|
||||
|
||||
````
|
||||
|
||||
#### Using with Web Bundles
|
||||
|
||||
@@ -1005,3 +1050,4 @@ Remember: BMAD is designed to enhance your development process, not replace your
|
||||
---
|
||||
|
||||
For additional support, join our [Discord community](https://discord.gg/g6ypHytrCB) or check out the [YouTube channel](https://www.youtube.com/@BMadCode) for video tutorials and walkthroughs.
|
||||
````
|
||||
|
||||
@@ -39,11 +39,13 @@ You are developing games as a "Player Experience CEO" - thinking like a game dir
|
||||
### Phase 1: Game Concept and Design
|
||||
|
||||
1. **Game Designer**: Start with brainstorming and concept development
|
||||
- Use *brainstorm to explore game concepts and mechanics
|
||||
|
||||
- Use \*brainstorm to explore game concepts and mechanics
|
||||
- Create Game Brief using game-brief-tmpl
|
||||
- Develop core game pillars and player experience goals
|
||||
|
||||
2. **Game Designer**: Create comprehensive Game Design Document
|
||||
|
||||
- Use game-design-doc-tmpl to create detailed GDD
|
||||
- Define all game mechanics, progression, and balance
|
||||
- Specify technical requirements and platform targets
|
||||
@@ -63,11 +65,13 @@ You are developing games as a "Player Experience CEO" - thinking like a game dir
|
||||
### Phase 3: Story-Driven Development
|
||||
|
||||
5. **Game Scrum Master**: Break down design into development stories
|
||||
|
||||
- Use create-game-story task to create detailed implementation stories
|
||||
- Each story should be immediately actionable by game developers
|
||||
- Apply game-story-dod-checklist to ensure story quality
|
||||
|
||||
6. **Game Developer**: Implement game features story by story
|
||||
|
||||
- Follow TypeScript strict mode and Phaser 3 best practices
|
||||
- Maintain 60 FPS performance target throughout development
|
||||
- Use test-driven development for game logic components
|
||||
@@ -82,6 +86,7 @@ You are developing games as a "Player Experience CEO" - thinking like a game dir
|
||||
### Phaser 3 + TypeScript Standards
|
||||
|
||||
**Project Structure:**
|
||||
|
||||
```text
|
||||
game-project/
|
||||
├── src/
|
||||
@@ -99,12 +104,14 @@ game-project/
|
||||
```
|
||||
|
||||
**Performance Requirements:**
|
||||
|
||||
- Maintain 60 FPS on target devices
|
||||
- Memory usage under specified limits per level
|
||||
- Loading times under 3 seconds for levels
|
||||
- Smooth animation and responsive controls
|
||||
|
||||
**Code Quality:**
|
||||
|
||||
- TypeScript strict mode compliance
|
||||
- Component-based architecture
|
||||
- Object pooling for frequently created/destroyed objects
|
||||
@@ -113,6 +120,7 @@ game-project/
|
||||
### Game Development Story Structure
|
||||
|
||||
**Story Requirements:**
|
||||
|
||||
- Clear reference to Game Design Document section
|
||||
- Specific acceptance criteria for game functionality
|
||||
- Technical implementation details for Phaser 3
|
||||
@@ -120,6 +128,7 @@ game-project/
|
||||
- Testing requirements including gameplay validation
|
||||
|
||||
**Story Categories:**
|
||||
|
||||
- **Core Mechanics**: Fundamental gameplay systems
|
||||
- **Level Content**: Individual levels and content implementation
|
||||
- **UI/UX**: User interface and player experience features
|
||||
@@ -129,6 +138,7 @@ game-project/
|
||||
### Quality Assurance for Games
|
||||
|
||||
**Testing Approach:**
|
||||
|
||||
- Unit tests for game logic (separate from Phaser)
|
||||
- Integration tests for game systems
|
||||
- Performance benchmarking and profiling
|
||||
@@ -136,6 +146,7 @@ game-project/
|
||||
- Cross-platform compatibility testing
|
||||
|
||||
**Performance Monitoring:**
|
||||
|
||||
- Frame rate consistency tracking
|
||||
- Memory usage monitoring
|
||||
- Asset loading performance
|
||||
@@ -145,16 +156,19 @@ game-project/
|
||||
## Game Development Team Roles
|
||||
|
||||
### Game Designer (Alex)
|
||||
|
||||
- **Primary Focus**: Game mechanics, player experience, design documentation
|
||||
- **Key Outputs**: Game Brief, Game Design Document, Level Design Framework
|
||||
- **Specialties**: Brainstorming, game balance, player psychology, creative direction
|
||||
|
||||
### Game Developer (Maya)
|
||||
|
||||
- **Primary Focus**: Phaser 3 implementation, technical excellence, performance
|
||||
- **Key Outputs**: Working game features, optimized code, technical architecture
|
||||
- **Specialties**: TypeScript/Phaser 3, performance optimization, cross-platform development
|
||||
|
||||
### Game Scrum Master (Jordan)
|
||||
|
||||
- **Primary Focus**: Story creation, development planning, agile process
|
||||
- **Key Outputs**: Detailed implementation stories, sprint planning, quality assurance
|
||||
- **Specialties**: Story breakdown, developer handoffs, process optimization
|
||||
@@ -162,18 +176,21 @@ game-project/
|
||||
## Platform-Specific Considerations
|
||||
|
||||
### Web Platform
|
||||
|
||||
- Browser compatibility across modern browsers
|
||||
- Progressive loading for large assets
|
||||
- Touch-friendly mobile controls
|
||||
- Responsive design for different screen sizes
|
||||
|
||||
### Mobile Optimization
|
||||
|
||||
- Touch gesture support and responsive controls
|
||||
- Battery usage optimization
|
||||
- Performance scaling for different device capabilities
|
||||
- App store compliance and packaging
|
||||
|
||||
### Performance Targets
|
||||
|
||||
- **Desktop**: 60 FPS at 1080p resolution
|
||||
- **Mobile**: 60 FPS on mid-range devices, 30 FPS minimum on low-end
|
||||
- **Loading**: Initial load under 5 seconds, level transitions under 2 seconds
|
||||
@@ -182,18 +199,21 @@ game-project/
|
||||
## Success Metrics for Game Development
|
||||
|
||||
### Technical Metrics
|
||||
|
||||
- Frame rate consistency (>90% of time at target FPS)
|
||||
- Memory usage within budgets
|
||||
- Loading time targets met
|
||||
- Zero critical bugs in core gameplay systems
|
||||
|
||||
### Player Experience Metrics
|
||||
|
||||
- Tutorial completion rate >80%
|
||||
- Level completion rates appropriate for difficulty curve
|
||||
- Average session length meets design targets
|
||||
- Player retention and engagement metrics
|
||||
|
||||
### Development Process Metrics
|
||||
|
||||
- Story completion within estimated timeframes
|
||||
- Code quality metrics (test coverage, linting compliance)
|
||||
- Documentation completeness and accuracy
|
||||
@@ -202,6 +222,7 @@ game-project/
|
||||
## Common Game Development Patterns
|
||||
|
||||
### Scene Management
|
||||
|
||||
- Boot scene for initial setup and configuration
|
||||
- Preload scene for asset loading with progress feedback
|
||||
- Menu scene for navigation and settings
|
||||
@@ -209,22 +230,25 @@ game-project/
|
||||
- Clean transitions between scenes with proper cleanup
|
||||
|
||||
### Game State Management
|
||||
|
||||
- Persistent data (player progress, unlocks, settings)
|
||||
- Session data (current level, score, temporary state)
|
||||
- Save/load system with error recovery
|
||||
- Settings management with platform storage
|
||||
|
||||
### Input Handling
|
||||
|
||||
- Cross-platform input abstraction
|
||||
- Touch gesture support for mobile
|
||||
- Keyboard and gamepad support for desktop
|
||||
- Customizable control schemes
|
||||
|
||||
### Performance Optimization
|
||||
|
||||
- Object pooling for bullets, effects, enemies
|
||||
- Texture atlasing and sprite optimization
|
||||
- Audio compression and streaming
|
||||
- Culling and level-of-detail systems
|
||||
- Memory management and garbage collection optimization
|
||||
|
||||
This knowledge base provides the foundation for effective game development using the BMAD-METHOD framework with specialized focus on 2D game creation using Phaser 3 and TypeScript.
|
||||
This knowledge base provides the foundation for effective game development using the BMAD-METHOD framework with specialized focus on 2D game creation using Phaser 3 and TypeScript.
|
||||
|
||||
@@ -0,0 +1,3 @@
|
||||
# Usage Information
|
||||
|
||||
TODO
|
||||
4
package-lock.json
generated
4
package-lock.json
generated
@@ -1,12 +1,12 @@
|
||||
{
|
||||
"name": "bmad-method",
|
||||
"version": "4.6.1",
|
||||
"version": "4.7.0",
|
||||
"lockfileVersion": 3,
|
||||
"requires": true,
|
||||
"packages": {
|
||||
"": {
|
||||
"name": "bmad-method",
|
||||
"version": "4.6.1",
|
||||
"version": "4.7.0",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"@kayvan/markdown-tree-parser": "^1.5.0",
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "bmad-method",
|
||||
"version": "4.6.1",
|
||||
"version": "4.7.0",
|
||||
"description": "Breakthrough Method of Agile AI-driven Development",
|
||||
"main": "tools/cli.js",
|
||||
"bin": {
|
||||
|
||||
@@ -425,7 +425,10 @@ class Installer {
|
||||
console.log(chalk.cyan("\n📦 Starting v3 to v4 upgrade process..."));
|
||||
const V3ToV4Upgrader = require("../../upgraders/v3-to-v4-upgrader");
|
||||
const upgrader = new V3ToV4Upgrader();
|
||||
return await upgrader.upgrade({ projectPath: installDir });
|
||||
return await upgrader.upgrade({
|
||||
projectPath: installDir,
|
||||
ides: config.ides || [] // Pass IDE selections from initial config
|
||||
});
|
||||
}
|
||||
case "alongside":
|
||||
return await this.performFreshInstall(config, installDir, spinner);
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "bmad-method",
|
||||
"version": "4.6.1",
|
||||
"version": "4.7.0",
|
||||
"description": "BMAD Method installer - AI-powered Agile development framework",
|
||||
"main": "lib/installer.js",
|
||||
"bin": {
|
||||
|
||||
@@ -98,7 +98,7 @@ class V3ToV4Upgrader {
|
||||
|
||||
// 8. Setup IDE
|
||||
if (!options.dryRun) {
|
||||
await this.setupIDE(projectPath);
|
||||
await this.setupIDE(projectPath, options.ides);
|
||||
}
|
||||
|
||||
// 9. Show completion report
|
||||
@@ -379,8 +379,8 @@ class V3ToV4Upgrader {
|
||||
const spinner = ora("Installing V4 structure...").start();
|
||||
|
||||
try {
|
||||
// Get the source .bmad-core directory
|
||||
const sourcePath = path.join(__dirname, "..", "..", ".bmad-core");
|
||||
// Get the source bmad-core directory (without dot prefix)
|
||||
const sourcePath = path.join(__dirname, "..", "..", "bmad-core");
|
||||
const destPath = path.join(projectPath, ".bmad-core");
|
||||
|
||||
// Copy .bmad-core
|
||||
@@ -545,47 +545,37 @@ class V3ToV4Upgrader {
|
||||
}
|
||||
}
|
||||
|
||||
async setupIDE(projectPath) {
|
||||
const { ide } = await inquirer.prompt([
|
||||
{
|
||||
type: "list",
|
||||
name: "ide",
|
||||
message: "Which IDE are you using?",
|
||||
choices: [
|
||||
{ name: "Cursor", value: "cursor" },
|
||||
{ name: "Claude Code", value: "claude-code" },
|
||||
{ name: "Windsurf", value: "windsurf" },
|
||||
{ name: "Roo Code", value: "roo" },
|
||||
{ name: "VS Code", value: "skip" },
|
||||
{ name: "Other/Skip", value: "skip" },
|
||||
],
|
||||
},
|
||||
]);
|
||||
async setupIDE(projectPath, selectedIdes) {
|
||||
// Use the IDE selections passed from the installer
|
||||
if (!selectedIdes || selectedIdes.length === 0) {
|
||||
console.log(chalk.dim("No IDE setup requested - skipping"));
|
||||
return;
|
||||
}
|
||||
|
||||
const selectedIde = ide === "skip" ? null : ide;
|
||||
const ideSetup = require("../installer/lib/ide-setup");
|
||||
const spinner = ora("Setting up IDE rules for all agents...").start();
|
||||
|
||||
if (selectedIde) {
|
||||
const ideSetup = require("../installer/lib/ide-setup");
|
||||
const spinner = ora("Setting up IDE rules for all agents...").start();
|
||||
try {
|
||||
const ideMessages = {
|
||||
cursor: "Rules created in .cursor/rules/",
|
||||
"claude-code": "Commands created in .claude/commands/",
|
||||
windsurf: "Rules created in .windsurf/rules/",
|
||||
roo: "Custom modes created in .roomodes",
|
||||
};
|
||||
|
||||
try {
|
||||
await ideSetup.setup(selectedIde, projectPath);
|
||||
spinner.succeed("IDE setup complete!");
|
||||
|
||||
const ideMessages = {
|
||||
cursor: "Rules created in .cursor/rules/",
|
||||
"claude-code": "Commands created in .claude/commands/",
|
||||
windsurf: "Rules created in .windsurf/rules/",
|
||||
roo: "Custom modes created in .roomodes",
|
||||
};
|
||||
|
||||
console.log(chalk.green(`- ${ideMessages[selectedIde]}`));
|
||||
} catch (error) {
|
||||
spinner.fail("IDE setup failed");
|
||||
console.error(
|
||||
chalk.yellow("IDE setup failed, but upgrade is complete.")
|
||||
);
|
||||
// Setup each selected IDE
|
||||
for (const ide of selectedIdes) {
|
||||
spinner.text = `Setting up ${ide}...`;
|
||||
await ideSetup.setup(ide, projectPath);
|
||||
console.log(chalk.green(`\n✓ ${ideMessages[ide]}`));
|
||||
}
|
||||
|
||||
spinner.succeed(`IDE setup complete for ${selectedIdes.length} IDE(s)!`);
|
||||
} catch (error) {
|
||||
spinner.fail("IDE setup failed");
|
||||
console.error(
|
||||
chalk.yellow("IDE setup failed, but upgrade is complete.")
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
Reference in New Issue
Block a user