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

refactor(config): replace hardcoded .bmad paths with {bmad_folder} placeholder

Browse Source 
Remove hardcoded .bmad folder references throughout documentation and source files, replacing them with the configurable {bmad_folder} placeholder. This change enables users to customize the BMAD installation folder name via configuration, improving flexibility and reducing coupling to a specific directory structure.

Changes include:
- Update all documentation to reference {bmad_folder} instead of .bmad
- Remove legacy configuration files from .bmad and .claude directories
- Update workflow.xml and CLI documentation with new placeholder syntax
This commit is contained in:
Brian Madison
2025-11-12 20:22:47 -06:00
parent 48cf5c8056
commit 1868477238
154 changed files with 124 additions and 16290 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
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_folder}/_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_folder}/_cfg/agents/bmm-dev.customize.yaml
agent:
metadata:
name: 'TDD Developer'
@@ -135,7 +135,7 @@ critical_actions:
**Example 2: Add Custom Deployment Workflow**
```yaml
# bmad/_cfg/agents/bmm-dev.customize.yaml
# {bmad_folder}/_cfg/agents/bmm-dev.customize.yaml
menu:
- trigger: deploy-staging
workflow: '{project-root}/.bmad-custom/deploy-staging.yaml'
@@ -148,7 +148,7 @@ menu:
**Example 3: Multilingual Product Manager**
```yaml
# bmad/_cfg/agents/bmm-pm.customize.yaml
# {bmad_folder}/_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_folder}/_cfg/agents/`
- Different projects can have different agent behaviors
**Global Config (Coming Soon):**

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_folder}/{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_folder}/{module}/agents/{agent-name}`
2. **Include Entire Module**: Use `@{bmad_folder}/{module}`
3. **Reference Index**: Use `@{bmad_folder}/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_folder}/core/agents/dev - Activate dev agent
@{bmad_folder}/bmm/agents/architect - Activate architect agent
@{bmad_folder}/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_folder}/core/agents/dev @{bmad_folder}/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_folder}/agents/` or `{bmad_folder}/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_folder}/agents/core-dev - Activate dev agent
/{bmad_folder}/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_folder}/bmm/workflows/workflow-init - Activate the workflow-init command
```
### Notes

2
docs/index.md
View File

@@ -214,7 +214,7 @@ BMM adapts to project complexity (Levels 0-4). Documentation is scale-adaptive -
### Update-Safe Customization
All agent customizations go in `bmad/_cfg/agents/` and survive updates. See your IDE guide and module README for details.
All agent customizations go in `{bmad_folder}/_cfg/agents/` and survive updates. See your IDE guide and module README for details.
---

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_folder}/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_folder}/bmm/templates/prd.md'
point: 'prd-goals-context-delegation'
requires: 'market-researcher' # Only if this specific subagent selected
content: |

46
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_folder}` 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_folder}/ # Centralized installation
│ ├── _cfg/ # Configuration
│ │ ├── agents/ # Agent configs
│ │ └── agent-manifest.csv # Agent manifest
@@ -184,7 +184,7 @@ Cline, Roo, Auggie, GitHub Copilot, Codex, Gemini, Qwen, Trae, Kilo, Crush, iFlo
```yaml
injections:
- file: 'bmad/bmm/agents/pm.md'
- file: '{bmad_folder}/bmm/agents/pm.md'
point: 'pm-agent-instructions'
content: |
<i>Platform-specific instruction</i>
@@ -270,14 +270,14 @@ Generated in: `bmad/_cfg/agents/{module}-{agent}.md`
### Common Issues
| Issue | Solution |
| ----------------------- | ----------------------------------- |
| Existing installation | Use `bmad update` or remove `bmad/` |
| Module not found | Check `src/modules/` exists |
| 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 |
| Issue | Solution |
| ----------------------- | -------------------------------------------- |
| Existing installation | Use `bmad update` or remove `{bmad_folder}/` |
| Module not found | Check `src/modules/` exists |
| Config not applied | Verify `{bmad_folder}/{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 |
### Debug Commands
@@ -289,19 +289,19 @@ bmad status -v # Detailed status
### Best Practices
1. Run from project root
2. Backup `bmad/_cfg/` before updates
2. Backup `{bmad_folder}/_cfg/` before updates
3. Use interactive mode for guidance
4. Review generated configs post-install
## Migration from v4
| v4 | v6 |
| ------------------- | ------------------- |
| Scattered files | Centralized `bmad/` |
| Monolithic | Modular |
| Manual config | Interactive setup |
| Limited IDE support | 15+ platforms |
| Source modification | Clean injection |
| v4 | v6 |
| ------------------- | ---------------------------- |
| Scattered files | Centralized `{bmad_folder}/` |
| Monolithic | Modular |
| Manual config | Interactive setup |
| Limited IDE support | 15+ platforms |
| Source modification | Clean injection |
## Technical Notes
@@ -326,8 +326,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_folder}/bmm/workflows/4-implementation/create-story/workflow.yaml'
workflow-install: '{project-root}/{bmad_folder}/bmgd/workflows/4-production/create-story/workflow.yaml'
description: 'Create a game feature story'
```
@@ -347,10 +347,10 @@ menu:
```yaml
# Source workflow (in bmm):
config_source: "{project-root}/bmad/bmm/config.yaml"
config_source: "{project-root}/{bmad_folder}/bmm/config.yaml"
# Vendored workflow (in bmgd):
config_source: "{project-root}/bmad/bmgd/config.yaml"
config_source: "{project-root}/{bmad_folder}/bmgd/config.yaml"
```
**Result**: Modules become completely standalone with their own copies of needed workflows, configured for their specific use case.

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

@@ -63,7 +63,7 @@ your-project/
```
your-project/
└── bmad/ # Single installation folder
└── {bmad_folder}/ # 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)
@@ -75,8 +75,8 @@ 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
- **v6 `{bmad_folder}/core/`**: Is the real universal core framework
- **v6 `{bmad_folder}/bmm/`**: Is the BMad Method module
- **Module identification**: All modules now have a `config.yaml` file
---
@@ -114,11 +114,11 @@ 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_folder}/_cfg/agents/` using customize files:
**Example: Renaming an agent and changing communication style**
File: `bmad/_cfg/agents/bmm-pm.customize.yaml`
File: `{bmad_folder}/_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_folder}/bmm/agents/pm.md`
- Customization: `{bmad_folder}/_cfg/agents/bmm-pm.customize.yaml`
- Result: Agent uses your custom name and style, but updates don't overwrite your changes
---
@@ -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}/` folder
- [ ] `workflow-init` run with correct project level selected
- [ ] Agent customizations migrated to `bmad/_cfg/agents/` if needed
- [ ] Agent customizations migrated to `{bmad_folder}/_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_folder}/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_folder}/_cfg/agents/<agent>.customize.yaml`
2. Rebuild: `npx bmad-method build <agent-name>`
3. Generate bundles: `npm run bundle`