bmad-method 6.0.0-alpha.12 → 6.0.0-alpha.14

package/docs/ide-info/rovo-dev.md

@@ -0,0 +1,388 @@
+# Rovo Dev IDE Integration
+
+This document describes how BMAD-METHOD integrates with [Atlassian Rovo Dev](https://www.atlassian.com/rovo-dev), an AI-powered software development assistant.
+
+## Overview
+
+Rovo Dev is designed to integrate deeply with developer workflows and organizational knowledge bases. When you install BMAD-METHOD in a Rovo Dev project, it automatically installs BMAD agents, workflows, tasks, and tools just like it does for other IDEs (Cursor, VS Code, etc.).
+
+BMAD-METHOD provides:
+
+- **Agents**: Specialized subagents for various development tasks
+- **Workflows**: Multi-step workflow guides and coordinators
+- **Tasks & Tools**: Reference documentation for BMAD tasks and tools
+
+### What are Rovo Dev Subagents?
+
+Subagents are specialized agents that Rovo Dev can delegate tasks to. They are defined as Markdown files with YAML frontmatter stored in the `.rovodev/subagents/` directory. Rovo Dev automatically discovers these files and makes them available through the `@subagent-name` syntax.
+
+## Installation and Setup
+
+### Automatic Installation
+
+When you run the BMAD-METHOD installer and select Rovo Dev as your IDE:
+
+```bash
+bmad install
+```
+
+The installer will:
+
+1. Create a `.rovodev/subagents/` directory in your project (if it doesn't exist)
+2. Convert BMAD agents into Rovo Dev subagent format
+3. Write subagent files with the naming pattern: `bmad-<module>-<agent-name>.md`
+
+### File Structure
+
+After installation, your project will have:
+
+```
+project-root/
+├── .rovodev/
+│   ├── subagents/
+│   │   ├── bmad-core-code-reviewer.md
+│   │   ├── bmad-bmm-pm.md
+│   │   ├── bmad-bmm-dev.md
+│   │   └── ... (more agents from selected modules)
+│   ├── workflows/
+│   │   ├── bmad-brainstorming.md
+│   │   ├── bmad-prd-creation.md
+│   │   └── ... (workflow guides)
+│   ├── references/
+│   │   ├── bmad-task-core-code-review.md
+│   │   ├── bmad-tool-core-analysis.md
+│   │   └── ... (task/tool references)
+│   ├── config.yml          (Rovo Dev configuration)
+│   ├── prompts.yml         (Optional: reusable prompts)
+│   └── ...
+├── .bmad/                  (BMAD installation directory)
+└── ...
+```
+
+**Directory Structure Explanation:**
+
+- **subagents/**: Agents discovered and used by Rovo Dev with `@agent-name` syntax
+- **workflows/**: Multi-step workflow guides and instructions
+- **references/**: Documentation for available tasks and tools in BMAD
+
+## Subagent File Format
+
+BMAD agents are converted to Rovo Dev subagent format, which uses Markdown with YAML frontmatter:
+
+### Basic Structure
+
+```markdown
+---
+name: bmad-module-agent-name
+description: One sentence description of what this agent does
+tools:
+  - bash
+  - open_files
+  - grep
+  - expand_code_chunks
+model: anthropic.claude-3-5-sonnet-20241022-v2:0 # Optional
+load_memory: true # Optional
+---
+
+You are a specialized agent for [specific task].
+
+## Your Role
+
+Describe the agent's role and responsibilities...
+
+## Key Instructions
+
+1. First instruction
+2. Second instruction
+3. Third instruction
+
+## When to Use This Agent
+
+Explain when and how to use this agent...
+```
+
+### YAML Frontmatter Fields
+
+| Field         | Type    | Required | Description                                                                                                                           |
+| ------------- | ------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------- |
+| `name`        | string  | Yes      | Unique identifier for the subagent (kebab-case, no spaces)                                                                            |
+| `description` | string  | Yes      | One-line description of the subagent's purpose                                                                                        |
+| `tools`       | array   | No       | List of tools the subagent can use. If not specified, uses parent agent's tools                                                       |
+| `model`       | string  | No       | Specific LLM model for this subagent (e.g., `anthropic.claude-3-5-sonnet-20241022-v2:0`). If not specified, uses parent agent's model |
+| `load_memory` | boolean | No       | Whether to load default memory files (AGENTS.md, AGENTS.local.md). Defaults to `true`                                                 |
+
+### System Prompt
+
+The content after the closing `---` is the subagent's system prompt. This defines:
+
+- The agent's persona and role
+- Its capabilities and constraints
+- Step-by-step instructions for task execution
+- Examples of expected behavior
+
+## Using BMAD Components in Rovo Dev
+
+### Invoking a Subagent (Agent)
+
+In Rovo Dev, you can invoke a BMAD agent as a subagent using the `@` syntax:
+
+```
+@bmad-core-code-reviewer Please review this PR for potential issues
+@bmad-bmm-pm Help plan this feature release
+@bmad-bmm-dev Implement this feature
+```
+
+### Accessing Workflows
+
+Workflow guides are available in `.rovodev/workflows/` directory:
+
+```
+@bmad-core-code-reviewer Use the brainstorming workflow from .rovodev/workflows/bmad-brainstorming.md
+```
+
+Workflow files contain step-by-step instructions and can be referenced or copied into Rovo Dev for collaborative workflow execution.
+
+### Accessing Tasks and Tools
+
+Task and tool documentation is available in `.rovodev/references/` directory. These provide:
+
+- Task execution instructions
+- Tool capabilities and usage
+- Integration examples
+- Parameter documentation
+
+### Example Usage Scenarios
+
+#### Code Review
+
+```
+@bmad-core-code-reviewer Review the changes in src/components/Button.tsx
+for best practices, performance, and potential bugs
+```
+
+#### Documentation
+
+```
+@bmad-core-documentation-writer Generate API documentation for the new
+user authentication module
+```
+
+#### Feature Design
+
+```
+@bmad-module-feature-designer Design a solution for implementing
+dark mode support across the application
+```
+
+## Customizing BMAD Subagents
+
+You can customize BMAD subagents after installation by editing their files directly in `.rovodev/subagents/`.
+
+### Example: Adding Tool Restrictions
+
+By default, BMAD subagents inherit tools from the parent Rovo Dev agent. You can restrict which tools a specific subagent can use:
+
+```yaml
+---
+name: bmad-core-code-reviewer
+description: Reviews code and suggests improvements
+tools:
+  - open_files
+  - expand_code_chunks
+  - grep
+---
+```
+
+### Example: Using a Specific Model
+
+Some agents might benefit from using a different model. You can specify this:
+
+```yaml
+---
+name: bmad-core-documentation-writer
+description: Writes clear and comprehensive documentation
+model: anthropic.claude-3-5-sonnet-20241022-v2:0
+---
+```
+
+### Example: Enhancing the System Prompt
+
+You can add additional context to a subagent's system prompt:
+
+```markdown
+---
+name: bmad-core-code-reviewer
+description: Reviews code and suggests improvements
+---
+
+You are a specialized code review agent for our project.
+
+## Project Context
+
+Our codebase uses:
+
+- React 18 for frontend
+- Node.js 18+ for backend
+- TypeScript for type safety
+- Jest for testing
+
+## Review Checklist
+
+1. Type safety and TypeScript correctness
+2. React best practices and hooks usage
+3. Performance considerations
+4. Test coverage
+5. Documentation and comments
+
+...rest of original system prompt...
+```
+
+## Memory and Context
+
+By default, BMAD subagents have `load_memory: true`, which means they will load memory files from your project:
+
+- **Project-level**: `.rovodev/AGENTS.md` and `.rovodev/.agent.md`
+- **User-level**: `~/.rovodev/AGENTS.md` (global memory across all projects)
+
+These files can contain:
+
+- Project guidelines and conventions
+- Common patterns and best practices
+- Recent decisions and context
+- Custom instructions for all agents
+
+### Creating Project Memory
+
+Create `.rovodev/AGENTS.md` in your project:
+
+```markdown
+# Project Guidelines
+
+## Code Style
+
+- Use 2-space indentation
+- Use camelCase for variables
+- Use PascalCase for classes
+
+## Architecture
+
+- Follow modular component structure
+- Use dependency injection for services
+- Implement proper error handling
+
+## Testing Requirements
+
+- Minimum 80% code coverage
+- Write tests before implementation
+- Use descriptive test names
+```
+
+## Troubleshooting
+
+### Subagents Not Appearing in Rovo Dev
+
+1. **Verify files exist**: Check that `.rovodev/subagents/bmad-*.md` files are present
+2. **Check Rovo Dev is reloaded**: Rovo Dev may cache agent definitions. Restart Rovo Dev or reload the project
+3. **Verify file format**: Ensure files have proper YAML frontmatter (between `---` markers)
+4. **Check file permissions**: Ensure files are readable by Rovo Dev
+
+### Agent Name Conflicts
+
+If you have custom subagents with the same names as BMAD agents, Rovo Dev will load both but may show a warning. Use unique prefixes for custom subagents to avoid conflicts.
+
+### Tools Not Available
+
+If a subagent's tools aren't working:
+
+1. Verify the tool names match Rovo Dev's available tools
+2. Check that the parent Rovo Dev agent has access to those tools
+3. Ensure tool permissions are properly configured in `.rovodev/config.yml`
+
+## Advanced: Tool Configuration
+
+Rovo Dev agents have access to a set of tools for various tasks. Common tools available include:
+
+- `bash`: Execute shell commands
+- `open_files`: View file contents
+- `grep`: Search across files
+- `expand_code_chunks`: View specific code sections
+- `find_and_replace_code`: Modify files
+- `create_file`: Create new files
+- `delete_file`: Delete files
+- `move_file`: Rename or move files
+
+### MCP Servers
+
+Rovo Dev can also connect to Model Context Protocol (MCP) servers, which provide additional tools and data sources:
+
+- **Atlassian Integration**: Access to Jira, Confluence, and Bitbucket
+- **Code Analysis**: Custom code analysis and metrics
+- **External Services**: APIs and third-party integrations
+
+Configure MCP servers in `~/.rovodev/mcp.json` or `.rovodev/mcp.json`.
+
+## Integration with Other IDE Handlers
+
+BMAD-METHOD supports multiple IDEs simultaneously. You can have both Rovo Dev and other IDE configurations (Cursor, VS Code, etc.) in the same project. Each IDE will have its own artifacts installed in separate directories.
+
+For example:
+
+- Rovo Dev agents: `.rovodev/subagents/bmad-*.md`
+- Cursor rules: `.cursor/rules/bmad/`
+- Claude Code: `.claude/rules/bmad/`
+
+## Performance Considerations
+
+- BMAD subagent files are typically small (1-5 KB each)
+- Rovo Dev lazy-loads subagents, so having many subagents doesn't impact startup time
+- System prompts are cached by Rovo Dev after first load
+
+## Best Practices
+
+1. **Keep System Prompts Concise**: Shorter, well-structured prompts are more effective
+2. **Use Project Memory**: Leverage `.rovodev/AGENTS.md` for shared context
+3. **Customize Tool Restrictions**: Give subagents only the tools they need
+4. **Test Subagent Invocations**: Verify each subagent works as expected for your project
+5. **Version Control**: Commit `.rovodev/subagents/` to version control for team consistency
+6. **Document Custom Subagents**: Add comments explaining the purpose of customized subagents
+
+## Related Documentation
+
+- [Rovo Dev Official Documentation](https://www.atlassian.com/rovo-dev)
+- [BMAD-METHOD Installation Guide](./installation.md)
+- [IDE Handler Architecture](./ide-handlers.md)
+- [Rovo Dev Configuration Reference](https://www.atlassian.com/rovo-dev/configuration)
+
+## Examples
+
+### Example 1: Code Review Workflow
+
+```
+User: @bmad-core-code-reviewer Review src/auth/login.ts for security issues
+Rovo Dev → Subagent: Opens file, analyzes code, suggests improvements
+Subagent output: Security vulnerabilities found, recommendations provided
+```
+
+### Example 2: Documentation Generation
+
+```
+User: @bmad-core-documentation-writer Generate API docs for the new payment module
+Rovo Dev → Subagent: Analyzes code structure, generates documentation
+Subagent output: Markdown documentation with examples and API reference
+```
+
+### Example 3: Architecture Design
+
+```
+User: @bmad-module-feature-designer Design a caching strategy for the database layer
+Rovo Dev → Subagent: Reviews current architecture, proposes design
+Subagent output: Detailed architecture proposal with implementation plan
+```
+
+## Support
+
+For issues or questions about:
+
+- **Rovo Dev**: See [Atlassian Rovo Dev Documentation](https://www.atlassian.com/rovo-dev)
+- **BMAD-METHOD**: See [BMAD-METHOD README](../README.md)
+- **IDE Integration**: See [IDE Handler Guide](./ide-handlers.md)

package/docs/index.md

@@ -87,6 +87,7 @@ Instructions for loading agents and running workflows in your development enviro
 - [OpenCode](./ide-info/opencode.md)
 - [Qwen](./ide-info/qwen.md)
 - [Roo](./ide-info/roo.md)
+- [Rovo Dev](./ide-info/rovo-dev.md)
 - [Trae](./ide-info/trae.md)
 
 **Key concept:** Every reference to "load an agent" or "activate an agent" in the main docs links to the [ide-info](./ide-info/) directory for IDE-specific instructions.
@@ -95,6 +96,11 @@ Instructions for loading agents and running workflows in your development enviro
 
 ## 🔧 Advanced Topics
 
+### Custom Agents
+
+- **[Custom Agent Installation](./custom-agent-installation.md)** - Install and personalize agents with `bmad agent-install`
+- [Agent Customization Guide](./agent-customization-guide.md) - Customize agent behavior and responses
+
 ### Installation & Bundling
 
 - [IDE Injections Reference](./installers-bundlers/ide-injections.md) - How agents are installed to IDEs
@@ -103,42 +109,6 @@ Instructions for loading agents and running workflows in your development enviro
 
 ---
 
-## 📊 Documentation Map
-
-```
-docs/                              # Core/cross-module documentation
-├── index.md (this file)
-├── v4-to-v6-upgrade.md
-├── document-sharding-guide.md
-├── ide-info/                      # IDE setup guides
-│   ├── claude-code.md
-│   ├── cursor.md
-│   ├── windsurf.md
-│   └── [14+ other IDEs]
-└── installers-bundlers/           # Installation reference
-    ├── ide-injections.md
-    ├── installers-modules-platforms-reference.md
-    └── web-bundler-usage.md
-
-src/modules/
-├── bmm/                           # BMad Method module
-│   ├── README.md                  # Module overview & docs index
-│   ├── docs/                      # BMM-specific documentation
-│   │   ├── quick-start.md
-│   │   ├── quick-spec-flow.md
-│   │   ├── scale-adaptive-system.md
-│   │   └── brownfield-guide.md
-│   ├── workflows/README.md        # ESSENTIAL workflow guide
-│   └── testarch/README.md         # Testing strategy
-├── bmb/                           # BMad Builder module
-│   ├── README.md
-│   └── workflows/create-agent/README.md
-└── cis/                           # Creative Intelligence Suite
-    └── README.md
-```
-
----
-
 ## 🎓 Recommended Reading Paths
 
 ### Path 1: Brand New to BMad (Software Project)
@@ -180,48 +150,3 @@ src/modules/
 1. [CONTRIBUTING.md](../CONTRIBUTING.md) - Contribution guidelines
 2. Relevant module README - Understand the area you're contributing to
 3. [Code Style section in CONTRIBUTING.md](../CONTRIBUTING.md#code-style) - Follow standards
-
----
-
-## 🔍 Quick Reference
-
-**What is each module for?**
-
-- **BMM** - AI-driven software and game development
-- **BMB** - Create custom agents and workflows
-- **CIS** - Creative thinking and brainstorming
-
-**How do I load an agent?**
-→ See [ide-info](./ide-info/) folder for your IDE
-
-**I'm stuck, what's next?**
-→ Check the [BMM Workflows Guide](../src/modules/bmm/workflows/README.md) or run `workflow-status`
-
-**I want to contribute**
-→ Start with [CONTRIBUTING.md](../CONTRIBUTING.md)
-
----
-
-## 📚 Important Concepts
-
-### Fresh Chats
-
-Each workflow should run in a fresh chat with the specified agent to avoid context limitations. This is emphasized throughout the docs because it's critical to successful workflows.
-
-### Scale Levels
-
-BMM adapts to project complexity (Levels 0-4). Documentation is scale-adaptive - you only need what's relevant to your project size.
-
-### Update-Safe Customization
-
-All agent customizations go in `{bmad_folder}/_cfg/agents/` and survive updates. See your IDE guide and module README for details.
-
----
-
-## 🆘 Getting Help
-
-- **Discord**: [Join the BMad Community](https://discord.gg/gk8jAdXWmj)
-  - #general-dev - Technical questions
-  - #bugs-issues - Bug reports
-- **Issues**: [GitHub Issue Tracker](https://github.com/bmad-code-org/BMAD-METHOD/issues)
-- **YouTube**: [BMad Code Channel](https://www.youtube.com/@BMadCode)

package/docs/installers-bundlers/installers-modules-platforms-reference.md

@@ -171,7 +171,7 @@ communication_language: "English"
 - Windsurf
 
 **Additional**:
-Cline, Roo, Auggie, GitHub Copilot, Codex, Gemini, Qwen, Trae, Kilo, Crush, iFlow
+Cline, Roo, Rovo Dev,Auggie, GitHub Copilot, Codex, Gemini, Qwen, Trae, Kilo, Crush, iFlow
 
 ### Platform Features
 

package/eslint.config.mjs

@@ -18,6 +18,20 @@ export default [
       'test/fixtures/**/*.yaml',
       '.bmad/**',
       '.bmad*/**',
+      // Gitignored patterns
+      'z*/**', // z-samples, z1, z2, etc.
+      '.claude/**',
+      '.codex/**',
+      '.github/chatmodes/**',
+      '.agent/**',
+      '.agentvibes/**',
+      '.kiro/**',
+      '.roo/**',
+      'test-project-install/**',
+      'sample-project/**',
+      'tools/template-test-generator/test-scenarios/**',
+      'src/modules/*/sub-modules/**',
+      '.bundler-temp/**',
     ],
   },
 

package/example-custom-content/README.md

@@ -0,0 +1,4 @@
+# Example Custom Content module
+
+This is a demonstration of custom stand along agents and workflows. By having this content all in a folder with a custom.yaml file,
+These items will be discovered by the installer and offered for installation.

package/example-custom-content/agents/commit-poet/commit-poet.agent.yaml

@@ -0,0 +1,129 @@
+agent:
+  metadata:
+    id: .bmad/agents/commit-poet/commit-poet.md
+    name: "Inkwell Von Comitizen"
+    title: "Commit Message Artisan"
+    icon: "📜"
+    type: simple
+
+  persona:
+    role: |
+      I am a Commit Message Artisan - transforming code changes into clear, meaningful commit history.
+
+    identity: |
+      I understand that commit messages are documentation for future developers. Every message I craft tells the story of why changes were made, not just what changed. I analyze diffs, understand context, and produce messages that will still make sense months from now.
+
+    communication_style: "Poetic drama and flair with every turn of a phrase. I transform mundane commits into lyrical masterpieces, finding beauty in your code's evolution."
+
+    principles:
+      - Every commit tells a story - the message should capture the "why"
+      - Future developers will read this - make their lives easier
+      - Brevity and clarity work together, not against each other
+      - Consistency in format helps teams move faster
+
+  prompts:
+    - id: write-commit
+      content: |
+        <instructions>
+        I'll craft a commit message for your changes. Show me:
+        - The diff or changed files, OR
+        - A description of what you changed and why
+
+        I'll analyze the changes and produce a message in conventional commit format.
+        </instructions>
+
+        <process>
+        1. Understand the scope and nature of changes
+        2. Identify the primary intent (feature, fix, refactor, etc.)
+        3. Determine appropriate scope/module
+        4. Craft subject line (imperative mood, concise)
+        5. Add body explaining "why" if non-obvious
+        6. Note breaking changes or closed issues
+        </process>
+
+        Show me your changes and I'll craft the message.
+
+    - id: analyze-changes
+      content: |
+        <instructions>
+        - Let me examine your changes before we commit to words.
+        - I'll provide analysis to inform the best commit message approach.
+        - Diff all uncommited changes and understand what is being done.
+        - Ask user for clarifications or the what and why that is critical to a good commit message.
+        </instructions>
+
+        <analysis_output>
+        - **Classification**: Type of change (feature, fix, refactor, etc.)
+        - **Scope**: Which parts of codebase affected
+        - **Complexity**: Simple tweak vs architectural shift
+        - **Key points**: What MUST be mentioned
+        - **Suggested style**: Which commit format fits best
+        </analysis_output>
+
+        Share your diff or describe your changes.
+
+    - id: improve-message
+      content: |
+        <instructions>
+        I'll elevate an existing commit message. Share:
+        1. Your current message
+        2. Optionally: the actual changes for context
+        </instructions>
+
+        <improvement_process>
+        - Identify what's already working well
+        - Check clarity, completeness, and tone
+        - Ensure subject line follows conventions
+        - Verify body explains the "why"
+        - Suggest specific improvements with reasoning
+        </improvement_process>
+
+    - id: batch-commits
+      content: |
+        <instructions>
+        For multiple related commits, I'll help create a coherent sequence. Share your set of changes.
+        </instructions>
+
+        <batch_approach>
+        - Analyze how changes relate to each other
+        - Suggest logical ordering (tells clearest story)
+        - Craft each message with consistent voice
+        - Ensure they read as chapters, not fragments
+        - Cross-reference where appropriate
+        </batch_approach>
+
+        <example>
+        Good sequence:
+        1. refactor(auth): extract token validation logic
+        2. feat(auth): add refresh token support
+        3. test(auth): add integration tests for token refresh
+        </example>
+
+  menu:
+    - trigger: write
+      action: "#write-commit"
+      description: "Craft a commit message for your changes"
+
+    - trigger: analyze
+      action: "#analyze-changes"
+      description: "Analyze changes before writing the message"
+
+    - trigger: improve
+      action: "#improve-message"
+      description: "Improve an existing commit message"
+
+    - trigger: batch
+      action: "#batch-commits"
+      description: "Create cohesive messages for multiple commits"
+
+    - trigger: conventional
+      action: "Write a conventional commit (feat/fix/chore/refactor/docs/test/style/perf/build/ci) with proper format: <type>(<scope>): <subject>"
+      description: "Specifically use conventional commit format"
+
+    - trigger: story
+      action: "Write a narrative commit that tells the journey: Setup → Conflict → Solution → Impact"
+      description: "Write commit as a narrative story"
+
+    - trigger: haiku
+      action: "Write a haiku commit (5-7-5 syllables) capturing the essence of the change"
+      description: "Compose a haiku commit message"