External/BMAD-METHOD
1
0
Fork 0
mirror of https://github.com/bmadcode/BMAD-METHOD.git synced 2025-12-29 16:14:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

folder rename from .bmad to _bmad

Browse Source
This commit is contained in:
Brian Madison
2025-12-13 16:22:34 +08:00
parent 0c873638ab
commit 25c79e3fe5
375 changed files with 1421 additions and 2745 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
docs/agent-customization-guide.md
View File

@@ -9,7 +9,7 @@ Customize BMad agents without modifying core files. All customizations persist t
After installation, find agent customization files in:
```
.bmad/_cfg/agents/
_bmad/_cfg/agents/
├── core-bmad-master.customize.yaml
├── bmm-dev.customize.yaml
├── bmm-pm.customize.yaml
@@ -119,7 +119,7 @@ prompts:
**Example 1: Customize Developer Agent for TDD**
```yaml
# .bmad/_cfg/agents/bmm-dev.customize.yaml
# _bmad/_cfg/agents/bmm-dev.customize.yaml
agent:
metadata:
name: 'TDD Developer'
@@ -135,20 +135,20 @@ critical_actions:
**Example 2: Add Custom Deployment Workflow**
```yaml
# .bmad/_cfg/agents/bmm-dev.customize.yaml
# _bmad/_cfg/agents/bmm-dev.customize.yaml
menu:
- trigger: deploy-staging
workflow: '{project-root}/.bmad/deploy-staging.yaml'
workflow: '{project-root}/_bmad/deploy-staging.yaml'
description: Deploy to staging environment
- trigger: deploy-prod
workflow: '{project-root}/.bmad/deploy-prod.yaml'
workflow: '{project-root}/_bmad/deploy-prod.yaml'
description: Deploy to production (with approval)
```
**Example 3: Multilingual Product Manager**
```yaml
# .bmad/_cfg/agents/bmm-pm.customize.yaml
# _bmad/_cfg/agents/bmm-pm.customize.yaml
persona:
role: 'Bilingual Product Manager'
identity: 'Expert in US and LATAM markets'
@@ -174,7 +174,7 @@ memories:
**Module-Level (Recommended):**
- Customize agents per-project in `.bmad/_cfg/agents/`
- Customize agents per-project in `_bmad/_cfg/agents/`
- Different projects can have different agent behaviors
**Global Config (Coming Soon):**

8
docs/custom-content-installation.md
View File

@@ -135,7 +135,7 @@ The installer presents a unified selection interface:
## Agent Sidecar Support
Agents with sidecar content can store personal data, memories, and working files outside of the `.bmad` directory. This separation keeps personal content separate from BMAD's core files.
Agents with sidecar content can store personal data, memories, and working files outside of the `_bmad` directory. This separation keeps personal content separate from BMAD's core files.
### What is Sidecar Content?
@@ -152,7 +152,7 @@ The sidecar folder location is configured during BMAD core installation:
```
? Where should users' agent sidecar memory folders be stored?
❯ .bmad-user-memory
❯ _bmad-user-memory
```
### How It Works
@@ -175,7 +175,7 @@ my-agent/
### Git Integration
Since sidecar content is stored outside the `.bmad` directory (and typically outside version control), users can:
Since sidecar content is stored outside the `_bmad` directory (and typically outside version control), users can:
- Add the sidecar folder to `.gitignore` to exclude personal data
- Share agent definitions without exposing personal content
@@ -185,7 +185,7 @@ Example `.gitignore` entry:
```
# Exclude agent personal data
.bmad-user-memory/
_bmad-user-memory/
```
## Creating Custom Content with BMAD Builder

2
docs/ide-info/crush.md
View File

@@ -7,7 +7,7 @@ BMAD agents are installed as commands in `.crush/commands/bmad/`.
### How to Use
1. **Open Command Palette**: Use Crush command interface
2. **Navigate**: Browse to `.bmad/{module}/agents/`
2. **Navigate**: Browse to `_bmad/{module}/agents/`
3. **Select Agent**: Choose the agent command
4. **Execute**: Run to activate agent persona

14
docs/ide-info/cursor.md
View File

@@ -6,20 +6,20 @@ BMAD agents are installed in `.cursor/rules/bmad/` as MDC rules.
### How to Use
1. **Reference in Chat**: Use `@.bmad/{module}/agents/{agent-name}`
2. **Include Entire Module**: Use `@.bmad/{module}`
3. **Reference Index**: Use `@.bmad/index` for all available agents
1. **Reference in Chat**: Use `@_bmad/{module}/agents/{agent-name}`
2. **Include Entire Module**: Use `@_bmad/{module}`
3. **Reference Index**: Use `@_bmad/index` for all available agents
### Examples
```
@.bmad/core/agents/dev - Activate dev agent
@.bmad/bmm/agents/architect - Activate architect agent
@.bmad/core - Include all core agents/tasks
@_bmad/core/agents/dev - Activate dev agent
@_bmad/bmm/agents/architect - Activate architect agent
@_bmad/core - Include all core agents/tasks
```
### Notes
- Rules are Manual type - only loaded when explicitly referenced
- No automatic context pollution
- Can combine multiple agents: `@.bmad/core/agents/dev @.bmad/core/agents/test`
- Can combine multiple agents: `@_bmad/core/agents/dev @_bmad/core/agents/test`

6
docs/ide-info/iflow.md
View File

@@ -7,7 +7,7 @@ BMAD agents are installed as commands in `.iflow/commands/bmad/`.
### How to Use
1. **Access Commands**: Use iFlow command interface
2. **Navigate**: Browse to `.bmad/agents/` or `.bmad/tasks/`
2. **Navigate**: Browse to `_bmad/agents/` or `_bmad/tasks/`
3. **Select**: Choose the agent or task command
4. **Execute**: Run to activate
@@ -22,8 +22,8 @@ BMAD agents are installed as commands in `.iflow/commands/bmad/`.
### Examples
```
/.bmad/agents/core-dev - Activate dev agent
/.bmad/tasks/core-setup - Execute setup task
/_bmad/agents/core-dev - Activate dev agent
/_bmad/tasks/core-setup - Execute setup task
```
### Notes

2
docs/ide-info/opencode.md
View File

@@ -14,7 +14,7 @@ BMAD agents are installed as OpenCode agents in `.opencode/agent/BMAD/{module_na
```
/agents - to see a list of agents and switch between them
/.bmad/bmm/workflows/workflow-init - Activate the workflow-init command
/_bmad/bmm/workflows/workflow-init - Activate the workflow-init command
```
### Notes

2
docs/ide-info/rovo-dev.md
View File

@@ -55,7 +55,7 @@ project-root/
│ ├── config.yml (Rovo Dev configuration)
│ ├── prompts.yml (Optional: reusable prompts)
│ └── ...
├── .bmad/ (BMAD installation directory)
├── _bmad/ (BMAD installation directory)
└── ...
```

4
docs/installers-bundlers/ide-injections.md
View File

@@ -158,7 +158,7 @@ src/modules/bmm/
```yaml
injections:
- file: '.bmad/bmm/agents/pm.md'
- file: '_bmad/bmm/agents/pm.md'
point: 'pm-agent-instructions'
requires: 'any' # Injected if ANY subagent is selected
content: |
@@ -166,7 +166,7 @@ injections:
<i>Use 'market-researcher' subagent for analysis</i>
</llm>
- file: '.bmad/bmm/templates/prd.md'
- file: '_bmad/bmm/templates/prd.md'
point: 'prd-goals-context-delegation'
requires: 'market-researcher' # Only if this specific subagent selected
content: |

22
docs/installers-bundlers/installers-modules-platforms-reference.md
View File

@@ -19,7 +19,7 @@ BMad Core is a modular AI agent framework with intelligent installation, platfor
- **Modular Design**: Core + optional modules (BMB, BMM, CIS)
- **Smart Installation**: Interactive configuration with dependency resolution
- **Clean Architecture**: Centralized `.bmad` directory add to project, no source pollution with multiple folders added
- **Clean Architecture**: Centralized `_bmad` directory add to project, no source pollution with multiple folders added
## Architecture
@@ -27,7 +27,7 @@ BMad Core is a modular AI agent framework with intelligent installation, platfor
```
project-root/
├── .bmad/ # Centralized installation
├── _bmad/ # Centralized installation
│ ├── _cfg/ # Configuration
│ │ ├── agents/ # Agent configs
│ │ └── agent-manifest.csv # Agent manifest
@@ -185,7 +185,7 @@ Cline, Roo, Rovo Dev,Auggie, GitHub Copilot, Codex, Gemini, Qwen, Trae, Kilo, Cr
```yaml
injections:
- file: '.bmad/bmm/agents/pm.md'
- file: '_bmad/bmm/agents/pm.md'
point: 'pm-agent-instructions'
content: |
<i>Platform-specific instruction</i>
@@ -273,9 +273,9 @@ Generated in: `bmad/_cfg/agents/{module}-{agent}.md`
| Issue | Solution |
| ----------------------- | ------------------------------------ |
| Existing installation | Use `bmad update` or remove `.bmad/` |
| Existing installation | Use `bmad update` or remove `_bmad/` |
| Module not found | Check `src/modules/` exists |
| Config not applied | Verify `.bmad/{module}/config.yaml` |
| Config not applied | Verify `_bmad/{module}/config.yaml` |
| Missing config.yaml | Fixed: All modules now get configs |
| Agent unavailable | Check for `localskip="true"` |
| module-installer copied | Fixed: Now excluded from copy |
@@ -290,7 +290,7 @@ bmad status -v # Detailed status
### Best Practices
1. Run from project root
2. Backup `.bmad/_cfg/` before updates
2. Backup `_bmad/_cfg/` before updates
3. Use interactive mode for guidance
4. Review generated configs post-install
@@ -298,7 +298,7 @@ bmad status -v # Detailed status
| v4 | v6 |
| ------------------- | -------------------- |
| Scattered files | Centralized `.bmad/` |
| Scattered files | Centralized `_bmad/` |
| Monolithic | Modular |
| Manual config | Interactive setup |
| Limited IDE support | 15+ platforms |
@@ -327,8 +327,8 @@ Agents can specify both `workflow` (source location) and `workflow-install` (des
```yaml
menu:
- trigger: create-story
workflow: '{project-root}/.bmad/bmm/workflows/4-implementation/create-story/workflow.yaml'
workflow-install: '{project-root}/.bmad/bmgd/workflows/4-production/create-story/workflow.yaml'
workflow: '{project-root}/_bmad/bmm/workflows/4-implementation/create-story/workflow.yaml'
workflow-install: '{project-root}/_bmad/bmgd/workflows/4-production/create-story/workflow.yaml'
description: 'Create a game feature story'
```
@@ -348,10 +348,10 @@ menu:
```yaml
# Source workflow (in bmm):
config_source: "{project-root}/.bmad/bmm/config.yaml"
config_source: "{project-root}/_bmad/bmm/config.yaml"
# Vendored workflow (in bmgd):
config_source: "{project-root}/.bmad/bmgd/config.yaml"
config_source: "{project-root}/_bmad/bmgd/config.yaml"
```
**Result**: Modules become completely standalone with their own copies of needed workflows, configured for their specific use case.

52
docs/v4-to-v6-upgrade.md
View File

@@ -10,14 +10,14 @@ BMad v6 represents a complete ground-up rewrite with significant architectural c
When you run `npm run install:bmad` on a project with v4 installed, the installer automatically detects:
- **Legacy folders**: Any folders starting with `.bmad`, `bmad` (lowercase), or `Bmad`
- **Legacy folders**: Any folders starting with `_bmad`, `bmad` (lowercase), or `Bmad`
- **IDE command artifacts**: Legacy bmad folders in IDE configuration directories (`.claude/commands/`, `.cursor/commands/`, etc.)
### What Happens During Detection
1. **Automatic Backup of v4 Modules**: All `.bmad-*` folders are moved to `v4-backup/` in your project root
1. **Automatic Backup of v4 Modules**: All `_bmad-*` folders are moved to `v4-backup/` in your project root
- If a backup already exists, a timestamp is added to avoid conflicts
- Example: `.bmad-core` → `v4-backup/.bmad-core`
- Example: `_bmad-core` → `v4-backup/_bmad-core`
- Your project files and data are NOT affected
2. **IDE Command Cleanup Recommended**: Legacy v4 IDE commands should be manually removed
@@ -34,12 +34,12 @@ When you run `npm run install:bmad` on a project with v4 installed, the installe
| v4 Module | v6 Status |
| ----------------------------- | ------------------------------------------------ |
| `.bmad-2d-phaser-game-dev` | Integrated into BMM |
| `.bmad-2d-unity-game-dev` | Integrated into BMM |
| `.bmad-godot-game-dev` | Integrated into BMM |
| `.bmad-*-game-dev` (any) | Integrated into BMM |
| `.bmad-infrastructure-devops` | Deprecated - New core devops agent coming in BMM |
| `.bmad-creative-writing` | Not adapted - New module releasing soon |
| `_bmad-2d-phaser-game-dev` | Integrated into BMM |
| `_bmad-2d-unity-game-dev` | Integrated into BMM |
| `_bmad-godot-game-dev` | Integrated into BMM |
| `_bmad-*-game-dev` (any) | Integrated into BMM |
| `_bmad-infrastructure-devops` | Deprecated - New core devops agent coming in BMM |
| `_bmad-creative-writing` | Not adapted - New module releasing soon |
**Game Development**: All game development functionality has been consolidated and expanded within the BMM (BMad Method) module. Game-specific workflows now adapt to your game type and engine.
@@ -53,17 +53,17 @@ When you run `npm run install:bmad` on a project with v4 installed, the installe
```
your-project/
├── .bmad-core/ # Was actually the BMad Method
├── .bmad-game-dev/ # Separate expansion packs
├── .bmad-creative-writing/
└── .bmad-infrastructure-devops/
├── _bmad-core/ # Was actually the BMad Method
├── _bmad-game-dev/ # Separate expansion packs
├── _bmad-creative-writing/
└── _bmad-infrastructure-devops/
```
**v6 Unified Structure:**
```
your-project/
└── .bmad/ # Single installation folder, default .bmad
└── _bmad/ # Single installation folder, default _bmad
├── core/ # Real core framework (applies to all modules)
├── bmm/ # BMad Method (software/game dev)
├── bmb/ # BMad Builder (create agents/workflows)
@@ -74,9 +74,9 @@ your-project/
### Key Concept Changes
- **v4 `.bmad-core`**: Was actually the BMad Method
- **v6 `.bmad/core/`**: Is the real universal core framework
- **v6 `.bmad/bmm/`**: Is the BMad Method module
- **v4 `_bmad-core`**: Was actually the BMad Method
- **v6 `_bmad/core/`**: Is the real universal core framework
- **v6 `_bmad/bmm/`**: Is the BMad Method module
- **Module identification**: All modules now have a `config.yaml` file
---
@@ -110,15 +110,15 @@ After running the v6 installer:
### v4 Agent Customization
In v4, you may have modified agent files directly in `.bmad-*` folders.
In v4, you may have modified agent files directly in `_bmad-*` folders.
### v6 Agent Customization
**All customizations** now go in `.bmad/_cfg/agents/` using customize files:
**All customizations** now go in `_bmad/_cfg/agents/` using customize files:
**Example: Renaming an agent and changing communication style**
File: `.bmad/_cfg/agents/bmm-pm.customize.yaml`
File: `_bmad/_cfg/agents/bmm-pm.customize.yaml`
```yaml
# Customize the PM agent
@@ -133,8 +133,8 @@ persona:
**How it works:**
- Base agent: `.bmad/bmm/agents/pm.md`
- Customization: `.bmad/_cfg/agents/bmm-pm.customize.yaml`
- Base agent: `_bmad/bmm/agents/pm.md`
- Customization: `_bmad/_cfg/agents/bmm-pm.customize.yaml`
- Result: Agent uses your custom name and style, but updates don't overwrite your changes
---
@@ -176,7 +176,7 @@ npx bmad-method install
The installer will:
1. Detect v4 installation and offer to backup `.bmad-*` folders
1. Detect v4 installation and offer to backup `_bmad-*` folders
2. Prompt for recommended cleanup (you can skip)
3. Let you select modules (recommend: BMM for software and or game development)
4. Configure core settings (name, language, etc.)
@@ -212,9 +212,9 @@ Since you are migrating an existing project from v4, it's most likely **Level 3
## Post-Migration Checklist
- [ ] v4 folders backed up to `v4-backup/`
- [ ] v6 installed to `.bmad/` folder
- [ ] v6 installed to `_bmad/` folder
- [ ] `workflow-init` run with correct project level selected
- [ ] Agent customizations migrated to `.bmad/_cfg/agents/` if needed
- [ ] Agent customizations migrated to `_bmad/_cfg/agents/` if needed
- [ ] IDE integration working (test by listing agents)
- [ ] For active development: `sprint-planning` workflow executed
@@ -224,4 +224,4 @@ Since you are migrating an existing project from v4, it's most likely **Level 3
- **Discord**: [Join the BMad Community](https://discord.gg/gk8jAdXWmj)
- **Issues**: [GitHub Issue Tracker](https://github.com/bmad-code-org/BMAD-METHOD/issues)
- **Docs**: Check `.bmad/docs/` in your installation for IDE-specific instructions
- **Docs**: Check `_bmad/docs/` in your installation for IDE-specific instructions

2
docs/web-bundles-gemini-gpt-guide.md
View File

@@ -336,7 +336,7 @@ Agents adapt their menus based on project phase and available workflows.
Customize agents using the [Agent Customization Guide](./agent-customization-guide.md):
1. Edit `.bmad/_cfg/agents/<agent>.customize.yaml`
1. Edit `_bmad/_cfg/agents/<agent>.customize.yaml`
2. Rebuild: `npx bmad-method build <agent-name>`
3. Generate bundles: `npm run bundle`