Compare commits
83 Commits
v6.0.0-alp
...
main
| Author | SHA1 | Date |
|---|---|---|
|
|
e39aa33eea | |
|
|
2da9aebaa8 | |
|
|
5c756b6404 | |
|
|
23f650ff4d | |
|
|
363915b0c6 | |
|
|
f36369512b | |
|
|
ccb64623bc | |
|
|
e37edf098c | |
|
|
e3eb374218 | |
|
|
83b0df0f21 | |
|
|
00a3af3eb0 | |
|
|
d0e0a0963a | |
|
|
32615afaf9 | |
|
|
59e4cc7b82 | |
|
|
c24821b6ed | |
|
|
2c4c2d9717 | |
|
|
901b39de9a | |
|
|
4d8d1f84f7 | |
|
|
48795d46de | |
|
|
bbda7171bd | |
|
|
08f05cf9a4 | |
|
|
c7827bf031 | |
|
|
5716282898 | |
|
|
60238d2854 | |
|
|
6513c77d1b | |
|
|
3cbe330b8e | |
|
|
ecc2901649 | |
|
|
d4eccf07cf | |
|
|
1da7705821 | |
|
|
7f742d4af6 | |
|
|
9fe79882b2 | |
|
|
ebb20f675f | |
|
|
82cc10824a | |
|
|
4c65f3a006 | |
|
|
401e8e481c | |
|
|
cba7cf223f | |
|
|
add789a408 | |
|
|
ae9851acab | |
|
|
ac5fa5c23f | |
|
|
8642553bd7 | |
|
|
ce42d56fdd | |
|
|
25c79e3fe5 | |
|
|
0c873638ab | |
|
|
e6f911d791 | |
|
|
f11be2b2e2 | |
|
|
572074d2a6 | |
|
|
0ed546619f | |
|
|
c3b54c5fc6 | |
|
|
e34f53d6f8 | |
|
|
ebbb44f961 | |
|
|
76185937c6 | |
|
|
7a9f1d4a3c | |
|
|
7d6aae1b78 | |
|
|
ed0defbe08 | |
|
|
3bc485d0ed | |
|
|
0f5a9cf0dd | |
|
|
e2d9d35ce9 | |
|
|
82e6433b69 | |
|
|
be7e07cc1a | |
|
|
079f79aba5 | |
|
|
b4d7e1adef | |
|
|
6e9fe6c9a2 | |
|
|
d2d9010a8e | |
|
|
6d5a1084eb | |
|
|
978a93ed33 | |
|
|
ec90699016 | |
|
|
0f06ef724b | |
|
|
26e47562dd | |
|
|
3256bda42f | |
|
|
3d2727e190 | |
|
|
446a0359ab | |
|
|
45a97b070a | |
|
|
a2d01813f0 | |
|
|
b9ba98d3f8 | |
|
|
5971a88553 | |
|
|
08642a0420 | |
|
|
ec73e44097 | |
|
|
d55f518a96 | |
|
|
cf50f4935d | |
|
|
55cb4681bc | |
|
|
eb4325fab9 | |
|
|
57ceaf9fa9 | |
|
|
1513b2d478 |
|
|
@ -4,13 +4,14 @@ language: "en-US"
|
|||
early_access: true
|
||||
reviews:
|
||||
profile: chill
|
||||
high_level_summary: true
|
||||
high_level_summary: false # don't post summary until explicitly invoked
|
||||
request_changes_workflow: false
|
||||
review_status: true
|
||||
collapse_walkthrough: false
|
||||
review_status: false
|
||||
commit_status: false
|
||||
walkthrough: false
|
||||
poem: false
|
||||
auto_review:
|
||||
enabled: false # must be manually triggered with @coderabbit review
|
||||
enabled: false
|
||||
drafts: true # Can review drafts. Since it's manually triggered, it's fine.
|
||||
auto_incremental_review: false # always review the whole PR, not just new commits
|
||||
base_branches:
|
||||
|
|
@ -33,4 +34,7 @@ reviews:
|
|||
Flag any process.exit() without error message.
|
||||
chat:
|
||||
auto_reply: true # Response to mentions in comments, a la @coderabbit review
|
||||
issue_enrichment:
|
||||
auto_enrich:
|
||||
enabled: false # don't auto-comment on issues
|
||||
|
||||
|
|
|
|||
|
|
@ -2,8 +2,21 @@
|
|||
# Discord notification helper functions
|
||||
|
||||
# Escape markdown special chars and @mentions for safe Discord display
|
||||
# Bracket expression: ] must be first, then other chars. In POSIX bracket expr, \ is literal.
|
||||
esc() { sed -e 's/[][\*_()~`>]/\\&/g' -e 's/@/@ /g'; }
|
||||
# Skips content inside <URL> wrappers to preserve URLs intact
|
||||
esc() {
|
||||
awk '{
|
||||
result = ""; in_url = 0; n = length($0)
|
||||
for (i = 1; i <= n; i++) {
|
||||
c = substr($0, i, 1)
|
||||
if (c == "<" && substr($0, i, 8) ~ /^<https?:/) in_url = 1
|
||||
if (in_url) { result = result c; if (c == ">") in_url = 0 }
|
||||
else if (c == "@") result = result "@ "
|
||||
else if (index("[]\\*_()~`", c) > 0) result = result "\\" c
|
||||
else result = result c
|
||||
}
|
||||
print result
|
||||
}'
|
||||
}
|
||||
|
||||
# Truncate to $1 chars (or 80 if wall-of-text with <3 spaces)
|
||||
trunc() {
|
||||
|
|
@ -13,3 +26,9 @@ trunc() {
|
|||
[ "$spaces" -lt 3 ] && [ ${#txt} -gt 80 ] && txt=$(printf '%s' "$txt" | cut -c1-80)
|
||||
printf '%s' "$txt"
|
||||
}
|
||||
|
||||
# Remove incomplete URL at end of truncated text (incomplete URLs are useless)
|
||||
strip_trailing_url() { sed -E 's~<?https?://[^[:space:]]*$~~'; }
|
||||
|
||||
# Wrap URLs in <> to suppress Discord embeds (keeps links clickable)
|
||||
wrap_urls() { sed -E 's~https?://[^[:space:]<>]+~<&>~g'; }
|
||||
|
|
|
|||
|
|
@ -53,7 +53,11 @@ jobs:
|
|||
|
||||
TITLE=$(printf '%s' "$PR_TITLE" | trunc $MAX_TITLE | esc)
|
||||
[ ${#PR_TITLE} -gt $MAX_TITLE ] && TITLE="${TITLE}..."
|
||||
BODY=$(printf '%s' "$PR_BODY" | trunc $MAX_BODY | esc)
|
||||
BODY=$(printf '%s' "$PR_BODY" | trunc $MAX_BODY)
|
||||
if [ -n "$PR_BODY" ] && [ ${#PR_BODY} -gt $MAX_BODY ]; then
|
||||
BODY=$(printf '%s' "$BODY" | strip_trailing_url)
|
||||
fi
|
||||
BODY=$(printf '%s' "$BODY" | wrap_urls | esc)
|
||||
[ -n "$PR_BODY" ] && [ ${#PR_BODY} -gt $MAX_BODY ] && BODY="${BODY}..."
|
||||
[ -n "$BODY" ] && BODY=" · $BODY"
|
||||
USER=$(printf '%s' "$PR_USER" | esc)
|
||||
|
|
@ -91,7 +95,11 @@ jobs:
|
|||
|
||||
TITLE=$(printf '%s' "$ISSUE_TITLE" | trunc $MAX_TITLE | esc)
|
||||
[ ${#ISSUE_TITLE} -gt $MAX_TITLE ] && TITLE="${TITLE}..."
|
||||
BODY=$(printf '%s' "$ISSUE_BODY" | trunc $MAX_BODY | esc)
|
||||
BODY=$(printf '%s' "$ISSUE_BODY" | trunc $MAX_BODY)
|
||||
if [ -n "$ISSUE_BODY" ] && [ ${#ISSUE_BODY} -gt $MAX_BODY ]; then
|
||||
BODY=$(printf '%s' "$BODY" | strip_trailing_url)
|
||||
fi
|
||||
BODY=$(printf '%s' "$BODY" | wrap_urls | esc)
|
||||
[ -n "$ISSUE_BODY" ] && [ ${#ISSUE_BODY} -gt $MAX_BODY ] && BODY="${BODY}..."
|
||||
[ -n "$BODY" ] && BODY=" · $BODY"
|
||||
USER=$(printf '%s' "$USER" | esc)
|
||||
|
|
@ -126,7 +134,11 @@ jobs:
|
|||
|
||||
TITLE=$(printf '%s' "$ISSUE_TITLE" | trunc $MAX_TITLE | esc)
|
||||
[ ${#ISSUE_TITLE} -gt $MAX_TITLE ] && TITLE="${TITLE}..."
|
||||
BODY=$(printf '%s' "$COMMENT_BODY" | trunc $MAX_BODY | esc)
|
||||
BODY=$(printf '%s' "$COMMENT_BODY" | trunc $MAX_BODY)
|
||||
if [ ${#COMMENT_BODY} -gt $MAX_BODY ]; then
|
||||
BODY=$(printf '%s' "$BODY" | strip_trailing_url)
|
||||
fi
|
||||
BODY=$(printf '%s' "$BODY" | wrap_urls | esc)
|
||||
[ ${#COMMENT_BODY} -gt $MAX_BODY ] && BODY="${BODY}..."
|
||||
USER=$(printf '%s' "$COMMENT_USER" | esc)
|
||||
|
||||
|
|
@ -162,7 +174,11 @@ jobs:
|
|||
|
||||
TITLE=$(printf '%s' "$PR_TITLE" | trunc $MAX_TITLE | esc)
|
||||
[ ${#PR_TITLE} -gt $MAX_TITLE ] && TITLE="${TITLE}..."
|
||||
BODY=$(printf '%s' "$REVIEW_BODY" | trunc $MAX_BODY | esc)
|
||||
BODY=$(printf '%s' "$REVIEW_BODY" | trunc $MAX_BODY)
|
||||
if [ -n "$REVIEW_BODY" ] && [ ${#REVIEW_BODY} -gt $MAX_BODY ]; then
|
||||
BODY=$(printf '%s' "$BODY" | strip_trailing_url)
|
||||
fi
|
||||
BODY=$(printf '%s' "$BODY" | wrap_urls | esc)
|
||||
[ -n "$REVIEW_BODY" ] && [ ${#REVIEW_BODY} -gt $MAX_BODY ] && BODY="${BODY}..."
|
||||
[ -n "$BODY" ] && BODY=": $BODY"
|
||||
USER=$(printf '%s' "$REVIEW_USER" | esc)
|
||||
|
|
@ -194,7 +210,11 @@ jobs:
|
|||
|
||||
TITLE=$(printf '%s' "$PR_TITLE" | trunc $MAX_TITLE | esc)
|
||||
[ ${#PR_TITLE} -gt $MAX_TITLE ] && TITLE="${TITLE}..."
|
||||
BODY=$(printf '%s' "$COMMENT_BODY" | trunc $MAX_BODY | esc)
|
||||
BODY=$(printf '%s' "$COMMENT_BODY" | trunc $MAX_BODY)
|
||||
if [ ${#COMMENT_BODY} -gt $MAX_BODY ]; then
|
||||
BODY=$(printf '%s' "$BODY" | strip_trailing_url)
|
||||
fi
|
||||
BODY=$(printf '%s' "$BODY" | wrap_urls | esc)
|
||||
[ ${#COMMENT_BODY} -gt $MAX_BODY ] && BODY="${BODY}..."
|
||||
USER=$(printf '%s' "$COMMENT_USER" | esc)
|
||||
|
||||
|
|
@ -224,7 +244,11 @@ jobs:
|
|||
|
||||
REL_NAME=$(printf '%s' "$NAME" | trunc $MAX_TITLE | esc)
|
||||
[ ${#NAME} -gt $MAX_TITLE ] && REL_NAME="${REL_NAME}..."
|
||||
BODY=$(printf '%s' "$RELEASE_BODY" | trunc $MAX_BODY | esc)
|
||||
BODY=$(printf '%s' "$RELEASE_BODY" | trunc $MAX_BODY)
|
||||
if [ -n "$RELEASE_BODY" ] && [ ${#RELEASE_BODY} -gt $MAX_BODY ]; then
|
||||
BODY=$(printf '%s' "$BODY" | strip_trailing_url)
|
||||
fi
|
||||
BODY=$(printf '%s' "$BODY" | wrap_urls | esc)
|
||||
[ -n "$RELEASE_BODY" ] && [ ${#RELEASE_BODY} -gt $MAX_BODY ] && BODY="${BODY}..."
|
||||
[ -n "$BODY" ] && BODY=" · $BODY"
|
||||
TAG_ESC=$(printf '%s' "$TAG" | esc)
|
||||
|
|
@ -275,7 +299,7 @@ jobs:
|
|||
run: |
|
||||
set -o pipefail
|
||||
[ -z "$WEBHOOK" ] && exit 0
|
||||
esc() { sed -e 's/[][\*_()~`>]/\\&/g' -e 's/@/@ /g'; }
|
||||
esc() { sed -e 's/[][\*_()~`]/\\&/g' -e 's/@/@ /g'; }
|
||||
trunc() { tr '\n\r' ' ' | cut -c1-"$1"; }
|
||||
|
||||
REF_TRUNC=$(printf '%s' "$REF" | trunc 100)
|
||||
|
|
|
|||
|
|
@ -6,9 +6,11 @@ on:
|
|||
version_bump:
|
||||
description: Version bump type
|
||||
required: true
|
||||
default: patch
|
||||
default: alpha
|
||||
type: choice
|
||||
options:
|
||||
- alpha
|
||||
- beta
|
||||
- patch
|
||||
- minor
|
||||
- major
|
||||
|
|
@ -49,7 +51,11 @@ jobs:
|
|||
git config user.email "github-actions[bot]@users.noreply.github.com"
|
||||
|
||||
- name: Bump version
|
||||
run: npm run version:${{ github.event.inputs.version_bump }}
|
||||
run: |
|
||||
case "${{ github.event.inputs.version_bump }}" in
|
||||
alpha|beta) npm version prerelease --no-git-tag-version --preid=${{ github.event.inputs.version_bump }} ;;
|
||||
*) npm version ${{ github.event.inputs.version_bump }} --no-git-tag-version ;;
|
||||
esac
|
||||
|
||||
- name: Get new version and previous tag
|
||||
id: version
|
||||
|
|
@ -61,34 +67,9 @@ jobs:
|
|||
run: |
|
||||
sed -i 's/"version": ".*"/"version": "${{ steps.version.outputs.new_version }}"/' tools/installer/package.json
|
||||
|
||||
- name: Generate web bundles
|
||||
run: npm run bundle
|
||||
|
||||
- name: Package bundles for release
|
||||
run: |
|
||||
mkdir -p dist/release-bundles
|
||||
|
||||
# Copy web bundles
|
||||
cp -r web-bundles dist/release-bundles/bmad-bundles-v${{ steps.version.outputs.new_version }}
|
||||
|
||||
# Verify bundles exist
|
||||
if [ ! "$(ls -A dist/release-bundles/bmad-bundles-v${{ steps.version.outputs.new_version }})" ]; then
|
||||
echo "❌ ERROR: No bundles found"
|
||||
echo "This likely means 'npm run bundle' failed"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Count and display bundles per module
|
||||
for module in bmm bmb cis bmgd; do
|
||||
if [ -d "dist/release-bundles/bmad-bundles-v${{ steps.version.outputs.new_version }}/$module/agents" ]; then
|
||||
COUNT=$(find dist/release-bundles/bmad-bundles-v${{ steps.version.outputs.new_version }}/$module/agents -name '*.xml' 2>/dev/null | wc -l)
|
||||
echo "✅ $module: $COUNT agents"
|
||||
fi
|
||||
done
|
||||
|
||||
# Create archive
|
||||
tar -czf dist/release-bundles/bmad-bundles-v${{ steps.version.outputs.new_version }}.tar.gz \
|
||||
-C dist/release-bundles/bmad-bundles-v${{ steps.version.outputs.new_version }} .
|
||||
# TODO: Re-enable web bundles once tools/cli/bundlers/ is restored
|
||||
# - name: Generate web bundles
|
||||
# run: npm run bundle
|
||||
|
||||
- name: Commit version bump
|
||||
run: |
|
||||
|
|
@ -185,25 +166,15 @@ jobs:
|
|||
npm publish --tag latest
|
||||
fi
|
||||
|
||||
- name: Create GitHub Release with Bundles
|
||||
- name: Create GitHub Release
|
||||
uses: softprops/action-gh-release@v2
|
||||
with:
|
||||
tag_name: v${{ steps.version.outputs.new_version }}
|
||||
name: "BMad Method v${{ steps.version.outputs.new_version }}"
|
||||
body: |
|
||||
${{ steps.release_notes.outputs.RELEASE_NOTES }}
|
||||
|
||||
## 📦 Web Bundles
|
||||
|
||||
Download XML bundles for use in AI platforms (Claude Projects, ChatGPT, Gemini):
|
||||
|
||||
- `bmad-bundles-v${{ steps.version.outputs.new_version }}.tar.gz` - All modules (BMM, BMB, CIS, BMGD)
|
||||
|
||||
**Browse online** (bleeding edge): https://bmad-code-org.github.io/bmad-bundles/
|
||||
draft: false
|
||||
prerelease: ${{ contains(steps.version.outputs.new_version, 'alpha') || contains(steps.version.outputs.new_version, 'beta') }}
|
||||
files: |
|
||||
dist/release-bundles/*.tar.gz
|
||||
|
||||
- name: Summary
|
||||
run: |
|
||||
|
|
@ -212,7 +183,6 @@ jobs:
|
|||
echo "### 📦 Distribution" >> $GITHUB_STEP_SUMMARY
|
||||
echo "- **NPM**: Published with @latest tag" >> $GITHUB_STEP_SUMMARY
|
||||
echo "- **GitHub Release**: https://github.com/bmad-code-org/BMAD-METHOD/releases/tag/v${{ steps.version.outputs.new_version }}" >> $GITHUB_STEP_SUMMARY
|
||||
echo "- **Web Bundles**: Attached to GitHub Release (4 archives)" >> $GITHUB_STEP_SUMMARY
|
||||
echo "" >> $GITHUB_STEP_SUMMARY
|
||||
echo "### ✅ Installation" >> $GITHUB_STEP_SUMMARY
|
||||
echo "\`\`\`bash" >> $GITHUB_STEP_SUMMARY
|
||||
|
|
|
|||
|
|
@ -31,7 +31,7 @@ Thumbs.db
|
|||
# IDE and editor configs
|
||||
.windsurf/
|
||||
.trae/
|
||||
.bmad*/.cursor/
|
||||
_bmad*/.cursor/
|
||||
|
||||
# AI assistant files
|
||||
CLAUDE.md
|
||||
|
|
@ -44,8 +44,8 @@ CLAUDE.local.md
|
|||
.claude/settings.local.json
|
||||
|
||||
# Project-specific
|
||||
.bmad-core
|
||||
.bmad-creator-tools
|
||||
_bmad-core
|
||||
_bmad-creator-tools
|
||||
test-project-install/*
|
||||
sample-project/*
|
||||
flattened-codebase.xml
|
||||
|
|
@ -65,7 +65,7 @@ src/modules/bmgd/sub-modules/
|
|||
shared-modules
|
||||
z*/
|
||||
|
||||
.bmad
|
||||
_bmad
|
||||
.claude
|
||||
.codex
|
||||
.github/chatmodes
|
||||
|
|
|
|||
|
|
@ -5,8 +5,8 @@ ignores:
|
|||
- node_modules/**
|
||||
- test/fixtures/**
|
||||
- CODE_OF_CONDUCT.md
|
||||
- .bmad/**
|
||||
- .bmad*/**
|
||||
- _bmad/**
|
||||
- _bmad*/**
|
||||
- .agent/**
|
||||
- .claude/**
|
||||
- .roo/**
|
||||
|
|
|
|||
|
|
@ -5,5 +5,5 @@ test/fixtures/**
|
|||
CODE_OF_CONDUCT.md
|
||||
|
||||
# BMAD runtime folders (user-specific, not in repo)
|
||||
.bmad/
|
||||
.bmad*/
|
||||
_bmad/
|
||||
_bmad*/
|
||||
|
|
|
|||
|
|
@ -73,7 +73,7 @@
|
|||
"editor.formatOnSave": true,
|
||||
"editor.defaultFormatter": "esbenp.prettier-vscode",
|
||||
"[javascript]": {
|
||||
"editor.defaultFormatter": "esbenp.prettier-vscode"
|
||||
"editor.defaultFormatter": "vscode.typescript-language-features"
|
||||
},
|
||||
"[json]": {
|
||||
"editor.defaultFormatter": "vscode.json-language-features"
|
||||
|
|
|
|||
244
CHANGELOG.md
244
CHANGELOG.md
|
|
@ -1,5 +1,248 @@
|
|||
# Changelog
|
||||
|
||||
## [6.0.0-alpha.19]
|
||||
|
||||
**Release: December 18, 2025**
|
||||
|
||||
### 🐛 Bug Fixes
|
||||
|
||||
**Installer Stability:**
|
||||
|
||||
- **Fixed \_bmad Folder Stutter**: Resolved issue with duplicate \_bmad folder creation when applying agent custom files
|
||||
- **Cleaner Installation**: Removed unnecessary backup file that was causing bloat in the installer
|
||||
- **Streamlined Agent Customization**: Fixed path handling for agent custom files to prevent folder duplication
|
||||
|
||||
### 📊 Statistics
|
||||
|
||||
- **3 files changed** with critical fix
|
||||
- **3,688 lines removed** by eliminating backup files
|
||||
- **Improved installer performance** and stability
|
||||
|
||||
---
|
||||
|
||||
## [6.0.0-alpha.18]
|
||||
|
||||
**Release: December 18, 2025**
|
||||
|
||||
### 🎮 BMGD Module - Complete Game Development Module Updated
|
||||
|
||||
**Massive BMGD Overhaul:**
|
||||
|
||||
- **New Game QA Agent (GLaDOS)**: Elite Game QA Architect with test automation specialization
|
||||
- Engine-specific expertise: Unity, Unreal, Godot testing frameworks
|
||||
- Comprehensive knowledge base with 15+ testing topics
|
||||
- Complete testing workflows: test-framework, test-design, automate, playtest-plan, performance-test, test-review
|
||||
|
||||
- **New Game Solo Dev Agent (Indie)**: Rapid prototyping and iteration specialist
|
||||
- Quick-flow workflows optimized for solo/small team development
|
||||
- Streamlined development process for indie game creators
|
||||
|
||||
- **Production Workflow Alignment**: BMGD 4-production now fully aligned with BMM 4-implementation
|
||||
- Removed obsolete workflows: story-done, story-ready, story-context, epic-tech-context
|
||||
- Added sprint-status workflow for project tracking
|
||||
- All workflows updated as standalone with proper XML instructions
|
||||
|
||||
**Game Testing Architecture:**
|
||||
|
||||
- **Complete Testing Knowledge Base**: 15 comprehensive testing guides covering:
|
||||
- Engine-specific: Unity (TF 1.6.0), Unreal, Godot testing
|
||||
- Game-specific: Playtesting, balance, save systems, multiplayer
|
||||
- Platform: Certification (TRC/XR), localization, input systems
|
||||
- QA Fundamentals: Automation, performance, regression, smoke testing
|
||||
|
||||
**New Workflows & Features:**
|
||||
|
||||
- **workflow-status**: Multi-mode status checker for game projects
|
||||
- Game-specific project levels (Game Jam → AAA)
|
||||
- Support for gamedev and quickflow paths
|
||||
- Project initialization workflow
|
||||
|
||||
- **create-tech-spec**: Game-focused technical specification workflow
|
||||
- Engine-aware (Unity/Unreal/Godot) specifications
|
||||
- Performance and gameplay feel considerations
|
||||
|
||||
- **Enhanced Documentation**: Complete documentation suite with 9 guides
|
||||
- agents-guide.md: Reference for all 6 agents
|
||||
- workflows-guide.md: Complete workflow documentation
|
||||
- game-types-guide.md: 24 game type templates
|
||||
- quick-flow-guide.md: Rapid development guide
|
||||
- Comprehensive troubleshooting and glossary
|
||||
|
||||
### 🤖 Agent Management Improved
|
||||
|
||||
**Agent Recompile Feature:**
|
||||
|
||||
- **New Menu Item**: Added "Recompile Agents" option to the installer menu
|
||||
- **Selective Compilation**: Recompile only agents without full module upgrade
|
||||
- **Faster Updates**: Quick agent updates without complete reinstallation
|
||||
- **Customization Integration**: Automatically applies customizations during recompile
|
||||
|
||||
**Agent Customization Enhancement:**
|
||||
|
||||
- **Complete Field Support**: ALL fields from agent customization YAML are now properly injected
|
||||
- **Deep Merge Implementation**: Customizations now properly override all agent properties
|
||||
- **Persistent Customizations**: Custom settings survive updates and recompiles
|
||||
- **Enhanced Flexibility**: Support for customizing metadata, persona, menu items, and workflows
|
||||
|
||||
### 🔧 Installation & Module Management
|
||||
|
||||
**Custom Module Installation:**
|
||||
|
||||
- **Enhanced Module Addition**: Modify install now supports adding custom modules even if none were originally installed
|
||||
- **Flexible Module Management**: Easy addition and removal of custom modules post-installation
|
||||
- **Improved Manifest Tracking**: Better tracking of custom vs core modules
|
||||
|
||||
**Quality Improvements:**
|
||||
|
||||
- **Comprehensive Code Review**: Fixed 20+ issues identified in PR review
|
||||
- **Type Validation**: Added proper type checking for configuration values
|
||||
- **Path Security**: Enhanced path traversal validation for better security
|
||||
- **Documentation Updates**: All documentation updated to reflect new features
|
||||
|
||||
### 📊 Statistics
|
||||
|
||||
- **178 files changed** with massive BMGD expansion
|
||||
- **28,350+ lines added** across testing documentation and workflows
|
||||
- **2 new agents** added to BMGD module
|
||||
- **15 comprehensive testing guides** created
|
||||
- **Complete alignment** between BMGD and BMM production workflows
|
||||
|
||||
### 🌟 Key Highlights
|
||||
|
||||
1. **BMGD Module Revolution**: Complete overhaul with professional game development workflows
|
||||
2. **Game Testing Excellence**: Comprehensive testing architecture for all major game engines
|
||||
3. **Agent Management**: New recompile feature allows quick agent updates without full reinstall
|
||||
4. **Full Customization Support**: All agent fields now customizable via YAML
|
||||
5. **Industry-Ready Documentation**: Professional-grade guides for game development teams
|
||||
|
||||
---
|
||||
|
||||
## [6.0.0-alpha.17]
|
||||
|
||||
**Release: December 16, 2025**
|
||||
|
||||
### 🚀 Revolutionary Installer Overhaul
|
||||
|
||||
**Unified Installation Experience:**
|
||||
|
||||
- **Streamlined Module Installation**: Completely redesigned installer with unified flow for both core and custom content
|
||||
- **Single Install Panel**: Eliminated disjointed clearing between modules for smoother, more intuitive installation
|
||||
- **Quick Default Selection**: New quick install feature with default selections for faster setup of selected modules
|
||||
- **Enhanced UI/UX**: Improved question order, reduced verbose output, and cleaner installation interface
|
||||
- **Logical Question Flow**: Reorganized installer questions to follow natural progression and user expectations
|
||||
|
||||
**Custom Content Installation Revolution:**
|
||||
|
||||
- **Full Custom Content Support**: Re-enabled complete custom content generation and sharing through the installer
|
||||
- **Custom Module Tracking**: Manifest now tracks custom modules separately to ensure they're always installed from the custom cache
|
||||
- **Custom Installation Order**: Custom modules now install after core modules for better dependency management
|
||||
- **Quick Update with Custom Content**: Quick update now properly retains and updates custom content
|
||||
- **Agent Customization Integration**: Customizations are now applied during quick updates and agent compilation
|
||||
|
||||
### 🧠 Revolutionary Agent Memory & Visibility System
|
||||
|
||||
**Breaking Through Dot-Folder Limitations:**
|
||||
|
||||
- **Dot-Folder to Underscore Migration**: Critical change from `.bmad` to `_bmad` ensures LLMs (Codex, Claude, and others) can no longer ignore or skip BMAD content - dot folders are commonly filtered out by AI systems
|
||||
- **Universal Content Visibility**: Underscore folders are treated as regular content, ensuring full AI agent access to all BMAD resources and configurations
|
||||
- **Agent Memory Architecture**: Rolled out comprehensive agent memory support for installed agents with `-sidecar` folders
|
||||
- **Persistent Agent Learning**: Sidecar content installs to `_bmad/_memory`, giving each agent the ability to learn and remember important information specific to its role
|
||||
|
||||
**Content Location Strategy:**
|
||||
|
||||
- **Standardized Memory Location**: All sidecar content now uses `_bmad/_memory` as the unified location for agent memories
|
||||
- **Segregated Output System**: New architecture supports differentiating between ephemeral Phase 4 artifacts and long-term documentation
|
||||
- **Forward Compatibility**: Existing installations continue working with content in docs folder, with optimization coming in next release
|
||||
- **Configuration Cleanup**: Renamed `_cfg` to `_config` for clearer naming conventions
|
||||
- **YAML Library Consolidation**: Reduced dependency to use only one YAML library for better stability
|
||||
|
||||
### 🎯 Future-Ready Architecture
|
||||
|
||||
**Content Organization Preview:**
|
||||
|
||||
- **Phase 4 Artifact Segregation**: Infrastructure ready for separating ephemeral workflow artifacts from permanent documentation
|
||||
- **Planning vs Implementation Docs**: New system will differentiate between planning artifacts and long-term project documentation
|
||||
- **Backward Compatibility**: Current installs maintain full functionality while preparing for optimized content organization
|
||||
- **Quick Update Path**: Tomorrow's quick update will fully optimize all BMM workflows to use new segregated output locations
|
||||
|
||||
### 🎯 Sample Modules & Documentation
|
||||
|
||||
**Comprehensive Examples:**
|
||||
|
||||
- **Sample Unitary Module**: Complete example with commit-poet agent and quiz-master workflow
|
||||
- **Sample Wellness Module**: Meditation guide and wellness companion agents demonstrating advanced patterns
|
||||
- **Enhanced Documentation**: Updated README files and comprehensive installation guides
|
||||
- **Custom Content Creation Guides**: Step-by-step documentation for creating and sharing custom modules
|
||||
|
||||
### 🔧 Bug Fixes & Optimizations
|
||||
|
||||
**Installer Improvements:**
|
||||
|
||||
- **Fixed Duplicate Entry Issue**: Resolved duplicate entries in files manifest
|
||||
- **Reduced Log Noise**: Less verbose logging during installation for cleaner user experience
|
||||
- **Menu Wording Updates**: Improved menu text for better clarity and understanding
|
||||
- **Fixed Quick Install**: Resolved issues with quick installation functionality
|
||||
|
||||
**Code Quality:**
|
||||
|
||||
- **Minor Code Cleanup**: General cleanup and refactoring throughout the codebase
|
||||
- **Removed Unused Code**: Cleaned up deprecated and unused functionality
|
||||
- **Release Workflow Restoration**: Fixed automated release workflow for v6
|
||||
|
||||
**BMM Phase 4 Workflow Improvements:**
|
||||
|
||||
- **Sprint Status Enhancement**: Improved sprint-status validation with interactive correction for unknown values and better epic status handling
|
||||
- **Story Status Standardization**: Normalized all story status references to lowercase kebab-case (ready-for-dev, in-progress, review, done)
|
||||
- **Removed Stale Story State**: Eliminated deprecated 'drafted' story state - stories now go directly from creation to ready-for-dev
|
||||
- **Code Review Clarity**: Improved code review completion message from "Story is ready for next work!" to "Code review complete!" for better clarity
|
||||
- **Risk Detection Rules**: Rewrote risk detection rules for better LLM clarity and fixed warnings vs risks naming inconsistency
|
||||
|
||||
### 📊 Statistics
|
||||
|
||||
- **40+ commits** since alpha.16
|
||||
- **Major installer refactoring** with complete UX overhaul
|
||||
- **2 new sample modules** with comprehensive examples
|
||||
- **Full custom content support** re-enabled and improved
|
||||
|
||||
### 🌟 Key Highlights
|
||||
|
||||
1. **Installer Revolution**: The installation system has been completely overhauled for better user experience, reliability, and speed
|
||||
2. **Custom Content Freedom**: Users can now easily create, share, and install custom content through the streamlined installer
|
||||
3. **AI Visibility Breakthrough**: Migration from `.bmad` to `_bmad` ensures LLMs can access all BMAD content (dot folders are commonly ignored by AI systems)
|
||||
4. **Agent Memory System**: Rolled out persistent agent memory support - agents with `-sidecar` folders can now learn and remember important information in `_bmad/_memory`
|
||||
5. **Quick Default Selection**: Installation is now faster with smart default selections for popular configurations
|
||||
6. **Future-Ready Architecture**: Infrastructure in place for segregating ephemeral artifacts from permanent documentation (full optimization coming in next release)
|
||||
|
||||
## [6.0.0-alpha.16]
|
||||
|
||||
**Release: December 10, 2025**
|
||||
|
||||
### 🔧 Temporary Changes & Fixes
|
||||
|
||||
**Installation Improvements:**
|
||||
|
||||
- **Temporary Custom Content Installation Disable**: Custom content installation temporarily disabled to improve stability
|
||||
- **BMB Workflow Path Fixes**: Fixed numerous path references in BMB workflows to ensure proper step file resolution
|
||||
- **Package Updates**: Updated dependencies for improved security and performance
|
||||
|
||||
**Path Resolution Improvements:**
|
||||
|
||||
- **BMB Agent Builder Fixes**: Corrected path references in step files and documentation
|
||||
- **Workflow Path Standardization**: Ensured consistent path handling across all BMB workflows
|
||||
- **Documentation References**: Updated internal documentation links and references
|
||||
|
||||
**Cleanup Changes:**
|
||||
|
||||
- **Example Modules Removal**: Temporarily removed example modules to prevent accidental installation
|
||||
- **Memory Management**: Improved sidecar file handling for custom modules
|
||||
|
||||
### 📊 Statistics
|
||||
|
||||
- **336 files changed** with path fixes and improvements
|
||||
- **4 commits** since alpha.15
|
||||
|
||||
---
|
||||
|
||||
## [6.0.0-alpha.15]
|
||||
|
||||
**Release: December 7, 2025**
|
||||
|
|
@ -145,7 +388,6 @@
|
|||
- Fixed version reading from package.json instead of hardcoded fallback
|
||||
- Removed hardcoded years from WebSearch queries
|
||||
- Removed broken build caching mechanism
|
||||
- Fixed hardcoded 'bmad' prefix from files-manifest.csv paths
|
||||
- Enhanced TTS injection summary with tracking and documentation
|
||||
- Fixed CI nvmrc configuration issues
|
||||
|
||||
|
|
|
|||
2
LICENSE
2
LICENSE
|
|
@ -21,6 +21,6 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|||
SOFTWARE.
|
||||
|
||||
TRADEMARK NOTICE:
|
||||
BMAD™, BMAD-CORE™ and BMAD-METHOD™ are trademarks of BMad Code, LLC. The use of these
|
||||
BMad™ , BMAD-CORE™ and BMAD-METHOD™ are trademarks of BMad Code, LLC. The use of these
|
||||
trademarks in this software does not grant any rights to use the trademarks
|
||||
for any other purpose.
|
||||
|
|
|
|||
33
README.md
33
README.md
|
|
@ -6,6 +6,33 @@
|
|||
[](https://nodejs.org)
|
||||
[](https://discord.gg/gk8jAdXWmj)
|
||||
|
||||
---
|
||||
|
||||
<div align="center">
|
||||
|
||||
## 🎉 NEW: BMAD V6 Installer - Create & Share Custom Content!
|
||||
|
||||
The completely revamped **BMAD V6 installer** now includes built-in support for creating, installing, and sharing custom modules, agents, workflows, templates, and tools! Build your own AI solutions or share them with your team - and real soon, with the whole BMad Community througha verified community sharing portal!
|
||||
|
||||
**✨ What's New:**
|
||||
|
||||
- 📦 **Streamlined Custom Module Installation** - Package your custom content as installable modules
|
||||
- 🤖 **Agent & Workflow Sharing** - Distribute standalone agents and workflows
|
||||
- 🔄 **Unitary Module Support** - Install individual components without full modules
|
||||
- ⚙️ **Dependency Management** - Automatic handling of module dependencies
|
||||
- 🛡️ **Update-Safe Customization** - Your custom content persists through updates
|
||||
|
||||
**📚 Learn More:**
|
||||
|
||||
- [**Custom Content Overview**](./docs/custom-content.md) - Discover all supported content types
|
||||
- [**Installation Guide**](./docs/custom-content-installation.md) - Learn to create and install custom content
|
||||
- [**Detail Content Docs**](./src/modules/bmb/docs/README.md) - Reference details for agents, modules, workflows and the bmad builder
|
||||
- [**2 Very simple Custom Modules of questionable quality**](./docs/sample-custom-modules/README.md) - if you want to download and try to install a custom shared module, get an idea of how to bundle and share your own, or create your own personal agents, workflows and modules.
|
||||
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
## AI-Driven Agile Development That Scales From Bug Fixes to Enterprise
|
||||
|
||||
**Build More, Architect Dreams** (BMAD) with **21 specialized AI agents** across 4 official modules, and **50+ guided workflows** that adapt to your project's complexity—from quick bug fixes to enterprise platforms, and new step file workflows that allow for incredibly long workflows to stay on the rails longer than ever before!
|
||||
|
|
@ -120,7 +147,7 @@ Each agent brings deep expertise and can be customized to match your team's styl
|
|||
- **BMad Builder (BMB)** - Create custom agents and workflows
|
||||
- Build anything from simple agents to complex modules
|
||||
- Create domain-specific solutions (legal, medical, finance, education)
|
||||
- Share your creations in the upcoming community marketplace
|
||||
- [→ Builder Guide](src/modules/bmb/docs/README.md) marketplace
|
||||
- [→ Builder Guide](./src/modules/bmb/README.md)
|
||||
|
||||
- **Creative Intelligence Suite (CIS)** - Innovation & problem-solving
|
||||
|
|
@ -202,7 +229,9 @@ See [CONTRIBUTING.md](CONTRIBUTING.md) for full development guidelines.
|
|||
|
||||
MIT License - See [LICENSE](LICENSE) for details.
|
||||
|
||||
**Trademarks:** BMAD™ and BMAD-METHOD™ are trademarks of BMad Code, LLC.
|
||||
**Trademarks:** BMad™ and BMAD-METHOD™ are trademarks of BMad Code, LLC.
|
||||
|
||||
Supported by: <a href="https://m.do.co/c/00f11bd932bb"><img src="https://opensource.nyc3.cdn.digitaloceanspaces.com/attribution/assets/SVG/DO_Logo_horizontal_blue.svg" height="24" alt="DigitalOcean" style="vertical-align: middle;"></a>
|
||||
|
||||
---
|
||||
|
||||
|
|
|
|||
Binary file not shown.
|
|
@ -9,7 +9,7 @@ Customize BMad agents without modifying core files. All customizations persist t
|
|||
After installation, find agent customization files in:
|
||||
|
||||
```
|
||||
{bmad_folder}/_cfg/agents/
|
||||
_bmad/_config/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_folder}/_cfg/agents/bmm-dev.customize.yaml
|
||||
# _bmad/_config/agents/bmm-dev.customize.yaml
|
||||
agent:
|
||||
metadata:
|
||||
name: 'TDD Developer'
|
||||
|
|
@ -135,20 +135,20 @@ critical_actions:
|
|||
**Example 2: Add Custom Deployment Workflow**
|
||||
|
||||
```yaml
|
||||
# {bmad_folder}/_cfg/agents/bmm-dev.customize.yaml
|
||||
# _bmad/_config/agents/bmm-dev.customize.yaml
|
||||
menu:
|
||||
- trigger: deploy-staging
|
||||
workflow: '{project-root}/{bmad_folder}/deploy-staging.yaml'
|
||||
workflow: '{project-root}/_bmad/deploy-staging.yaml'
|
||||
description: Deploy to staging environment
|
||||
- trigger: deploy-prod
|
||||
workflow: '{project-root}/{bmad_folder}/deploy-prod.yaml'
|
||||
workflow: '{project-root}/_bmad/deploy-prod.yaml'
|
||||
description: Deploy to production (with approval)
|
||||
```
|
||||
|
||||
**Example 3: Multilingual Product Manager**
|
||||
|
||||
```yaml
|
||||
# {bmad_folder}/_cfg/agents/bmm-pm.customize.yaml
|
||||
# _bmad/_config/agents/bmm-pm.customize.yaml
|
||||
persona:
|
||||
role: 'Bilingual Product Manager'
|
||||
identity: 'Expert in US and LATAM markets'
|
||||
|
|
@ -166,15 +166,15 @@ memories:
|
|||
|
||||
- **Start Small:** Customize one section at a time and rebuild to test
|
||||
- **Backup:** Copy customization files before major changes
|
||||
- **Update-Safe:** Your customizations in `_cfg/` survive all BMad updates
|
||||
- **Update-Safe:** Your customizations in `_config/` survive all BMad updates
|
||||
- **Per-Project:** Customization files are per-project, not global
|
||||
- **Version Control:** Consider committing `_cfg/` to share customizations with your team
|
||||
- **Version Control:** Consider committing `_config/` to share customizations with your team
|
||||
|
||||
## Module vs. Global Config
|
||||
|
||||
**Module-Level (Recommended):**
|
||||
|
||||
- Customize agents per-project in `{bmad_folder}/_cfg/agents/`
|
||||
- Customize agents per-project in `_bmad/_config/agents/`
|
||||
- Different projects can have different agent behaviors
|
||||
|
||||
**Global Config (Coming Soon):**
|
||||
|
|
@ -203,6 +203,6 @@ memories:
|
|||
|
||||
## Next Steps
|
||||
|
||||
- **[BMM Agents Guide](../src/modules/bmm/docs/agents-guide.md)** - Learn about all 12 BMad Method agents
|
||||
- **[BMM Agents Guide](../src/modules/bmm/docs/agents-guide.md)** - Learn about the BMad Method agents
|
||||
- **[BMB Create Agent Workflow](../src/modules/bmb/workflows/create-agent/README.md)** - Build completely custom agents
|
||||
- **[BMM Complete Documentation](../src/modules/bmm/docs/README.md)** - Full BMad Method reference
|
||||
|
|
|
|||
|
|
@ -1,245 +1,149 @@
|
|||
# Custom Content Installation
|
||||
|
||||
This guide explains how to create and install custom BMAD content including agents, workflows, and modules. Custom content allows you to extend BMAD's functionality with your own specialized tools and workflows that can be shared across projects or teams.
|
||||
This guide explains how to create and install custom BMAD content including agents, workflows, and modules. Custom content extends BMAD's functionality with specialized tools and workflows that can be shared across projects or teams.
|
||||
|
||||
## Types of Custom Content
|
||||
For detailed information about the different types of custom content available, see [Custom Content](./custom-content.md).
|
||||
|
||||
### 1. Custom Agents and Workflows (Standalone)
|
||||
If you download either of the folders within the [Sample Custom Modules](./sample-custom-modules/readme.md) folder
|
||||
|
||||
Custom agents and workflows are standalone content packages that can be installed without being part of a full module. These are perfect for:
|
||||
## Content Types Overview
|
||||
|
||||
- Sharing specialized agents across projects
|
||||
- Building a personal Agent powered Notebook vault
|
||||
- Distributing workflow templates
|
||||
- Creating agent libraries for specific domains
|
||||
BMAD Core supports several categories of custom content:
|
||||
|
||||
#### Structure
|
||||
- Custom Stand Alone Modules
|
||||
- Custom Add On Modules
|
||||
- Custom Global Modules
|
||||
- Custom Agents
|
||||
- Custom Workflows
|
||||
|
||||
A custom agents and workflows package follows this structure:
|
||||
## Making Custom Content Installable
|
||||
|
||||
### Custom Modules
|
||||
|
||||
To create an installable custom module:
|
||||
|
||||
1. **Folder Structure**
|
||||
- Create a folder with a short, abbreviated name (e.g., `cis` for Creative Intelligence Suite)
|
||||
- The folder name serves as the module code
|
||||
|
||||
2. **Required Files**
|
||||
- Include a `module.yaml` file in the root folder
|
||||
- This file drives the installation process when used by the BMAD installer
|
||||
- Reference existing modules or the BMad Builder for configuration examples
|
||||
|
||||
3. **Folder Organization**
|
||||
Follow these conventions for optimal compatibility:
|
||||
|
||||
```
|
||||
my-custom-agents/
|
||||
├── module.yaml # Package configuration
|
||||
├── agents/ # Agent definitions
|
||||
│ └── my-agent/
|
||||
│ └── agent.md
|
||||
└── workflows/ # Workflow definitions
|
||||
└── my-workflow/
|
||||
└── workflow.md
|
||||
module-code/
|
||||
module.yaml
|
||||
agents/
|
||||
workflows/
|
||||
tools/
|
||||
templates/
|
||||
...
|
||||
```
|
||||
|
||||
#### Configuration
|
||||
- `agents/` - Agent definitions
|
||||
- `workflows/` - Workflow definitions
|
||||
- Additional custom folders are supported but following conventions is recommended for agent and workflow discovery
|
||||
|
||||
Create a `module.yaml` file in your package root:
|
||||
**Note:** Full documentation for global modules and add-on modules will be available as support is finalized.
|
||||
|
||||
```yaml
|
||||
code: my-custom-agents
|
||||
name: 'My Custom Agents and Workflows'
|
||||
default_selected: true
|
||||
```
|
||||
### Standalone Content (Agents, Workflows, Tasks, Tools, Templates, Prompts)
|
||||
|
||||
#### Example
|
||||
For standalone content that isn't part of a cohesive module collection, follow this structure:
|
||||
|
||||
See `/example-custom-content` for a working example of a folder with multiple random custom agents and workflows. Technically its also just a module, but you will be able to further pick and choose from this folders contents of what you do and do not want to include in a destination folder. This way, you can store all custom content source in one location and easily install it to different locations.
|
||||
1. **Module Configuration**
|
||||
- Create a folder with a `module.yaml` file (similar to custom modules)
|
||||
- Add the property `unitary: true` to the module.yaml
|
||||
- The `unitary: true` property indicates this is a collection of potentially unrelated items that don't depend on each other
|
||||
|
||||
### 2. Custom Modules
|
||||
|
||||
Custom modules are complete BMAD modules that can include their own configuration, documentation, along with agents and workflows that all compliment each other. Additionally they will have their own installation scripts, data, and potentially other tools. Modules can be used for:
|
||||
|
||||
- Domain-specific functionality (e.g., industry-specific workflows, entertainment, education and training, medical, etc...)
|
||||
- Integration with external systems
|
||||
- Specialized agent collections
|
||||
- Custom tooling and utilities
|
||||
|
||||
#### Structure
|
||||
|
||||
A custom module follows this structure:
|
||||
2. **Folder Structure**
|
||||
Organize content in specific named folders:
|
||||
|
||||
```
|
||||
my-module/
|
||||
├── _module-installer/
|
||||
│ ├── installer.js # optional, when it exists it will run with module installation
|
||||
├── module.yaml # Module installation configuration with custom question and answer capture
|
||||
├── docs/ # Module documentation
|
||||
├── agents/ # Module-specific agents
|
||||
├── workflows/ # Module-specific workflows
|
||||
├── data/ # csv or other content to power agent intelligence or workflows
|
||||
├── tools/ # Custom tools, hooks, mcp
|
||||
└── sub-modules/ # IDE-specific customizations
|
||||
├── vscode/
|
||||
└── cursor/
|
||||
module-name/
|
||||
module.yaml # Contains unitary: true
|
||||
agents/
|
||||
workflows/
|
||||
templates/
|
||||
tools/
|
||||
tasks/
|
||||
prompts/
|
||||
```
|
||||
|
||||
#### Module Configuration
|
||||
|
||||
The `module.yaml` file defines how your module is installed:
|
||||
|
||||
```yaml
|
||||
# Module metadata
|
||||
code: my-module
|
||||
name: 'My Custom Module'
|
||||
default_selected: false
|
||||
|
||||
header: 'My Custom Module'
|
||||
subheader: 'Description of what this module does'
|
||||
|
||||
# Configuration prompts
|
||||
my_setting:
|
||||
prompt: 'Configure your module setting'
|
||||
default: 'default-value'
|
||||
result: '{value}'
|
||||
3. **Individual Item Organization**
|
||||
Each item should have its own subfolder:
|
||||
```text
|
||||
my-custom-stuff/
|
||||
module.yaml
|
||||
agents/
|
||||
larry/larry.agent.md
|
||||
curly/curly.agent.md
|
||||
moe/moe.agent.md
|
||||
moe/moe-sidecar/memories.csv
|
||||
```
|
||||
|
||||
#### Example
|
||||
**Future Feature:** Unitary modules will support selective installation, allowing users to pick and choose which specific items to install.
|
||||
|
||||
See `/example-custom-module` for a complete example:
|
||||
**Note:** Documentation explaining the distinctions between these content types and their specific use cases will be available soon.
|
||||
|
||||
## Installation Process
|
||||
|
||||
### Step 1: Running the Installer
|
||||
### Prerequisites
|
||||
|
||||
When you run the existing normal BMAD installer - either from the cloned repo, OR via NPX, it will ask about custom content:
|
||||
Ensure your content follows the proper conventions and includes a `module.yaml` file (only one per top-level folder).
|
||||
|
||||
```
|
||||
? Do you have custom content to install?
|
||||
❯ No (skip custom content)
|
||||
Enter a directory path
|
||||
Enter a URL [Coming soon]
|
||||
```
|
||||
### New Project Installation
|
||||
|
||||
### Step 2: Providing Custom Content Path
|
||||
When setting up a new BMAD project:
|
||||
|
||||
If you select "Enter a directory path", the installer will prompt for the location:
|
||||
1. The installer will prompt: `Would you like to install a local custom module (this includes custom agents and workflows also)? (y/N)`
|
||||
2. Select 'y' to specify the path to your module folder containing `module.yaml`
|
||||
|
||||
```
|
||||
? Enter the path to your custom content directory: /path/to/folder/containing/content/folder
|
||||
```
|
||||
### Existing Project Modification
|
||||
|
||||
The installer will:
|
||||
To add custom content to an existing BMAD project:
|
||||
|
||||
- Scan for `module.yaml` files (modules)
|
||||
- Display an indication of how many installable folders it has found. Note that a project with stand along agents and workflows all under a single folder like the example will just list the count as 1 for that directory.
|
||||
1. Run the installer against your project location
|
||||
2. Select `Modify BMAD Installation`
|
||||
3. Choose the option to add, modify, or update custom modules
|
||||
|
||||
### Step 3: Selecting Content
|
||||
### Upcoming Features
|
||||
|
||||
The installer presents a unified selection interface:
|
||||
- **Unitary Module Selection:** For modules with `type: unitary` (instead of `type: module`), you'll be able to select specific items to install
|
||||
- **Add-on Module Dependencies:** The installer will verify and install dependencies for add-on modules automatically
|
||||
|
||||
```
|
||||
? Select modules and custom content to install:
|
||||
[── Custom Content ──]
|
||||
◉ My Custom Agents and Workflows (/path/to/custom)
|
||||
[── Official Content ──]
|
||||
◯ BMM: Business Method & Management
|
||||
◯ CIS: Creativity & Innovation Suite
|
||||
```
|
||||
## Quick Updates
|
||||
|
||||
## Agent Sidecar Support
|
||||
When updates to BMAD Core or core modules (BMM, CIS, etc.) become available, the quick update process will:
|
||||
|
||||
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.
|
||||
1. Apply available updates to core modules
|
||||
2. Recompile all agents with customizations from the `_config/agents` folder
|
||||
3. Retain your custom content from a cached location
|
||||
4. Preserve your existing configurations and customizations
|
||||
|
||||
### What is Sidecar Content?
|
||||
This means you don't need to keep the source module files locally. When updates are available, simply point to the updated module location during the update process.
|
||||
|
||||
Sidecar content includes:
|
||||
## Important Considerations
|
||||
|
||||
- Agent memories and learning data
|
||||
- Personal working files
|
||||
- Temporary data
|
||||
- User-specific configurations
|
||||
### Module Naming Conflicts
|
||||
|
||||
### Sidecar Configuration
|
||||
When installing unofficial modules, ensure unique identification to avoid conflicts:
|
||||
|
||||
The sidecar folder location is configured during BMAD core installation:
|
||||
1. **Module Codes:** Each module must have a unique code (e.g., don't use `bmm` for custom modules)
|
||||
2. **Module Names:** Avoid using names that conflict with existing modules
|
||||
3. **Multiple Custom Modules:** If creating multiple custom modules, use distinct codes for each
|
||||
|
||||
```
|
||||
? Where should users' agent sidecar memory folders be stored?
|
||||
❯ .bmad-user-memory
|
||||
```
|
||||
**Examples of conflicts to avoid:**
|
||||
|
||||
### How It Works
|
||||
|
||||
1. **Agent Declaration**: Agents declare `hasSidecar: true` in their metadata
|
||||
2. **Sidecar Detection**: The installer automatically detects folders with "sidecar" in the name
|
||||
3. **Installation**: Sidecar content is copied to the configured location
|
||||
4. **Path Replacement**: The `{agent_sidecar_folder}` placeholder in agent configurations is replaced with the actual path to the installed instance of the sidecar folder. Now when you use the agent, depending on its design, will use the content in sidecar to record interactions, remember things you tell it, or serve a host of many other issues.
|
||||
|
||||
### Example Structure
|
||||
|
||||
```
|
||||
my-agent/
|
||||
├── agent.md # Agent definition
|
||||
└── my-agent-sidecar/ # Sidecar content folder
|
||||
├── memories/
|
||||
├── working/
|
||||
└── config/
|
||||
```
|
||||
|
||||
### Git Integration
|
||||
|
||||
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
|
||||
- Maintain separate configurations for different projects
|
||||
|
||||
Example `.gitignore` entry:
|
||||
|
||||
```
|
||||
# Exclude agent personal data
|
||||
.bmad-user-memory/
|
||||
```
|
||||
|
||||
## Creating Custom Content with BMAD Builder
|
||||
|
||||
The BMAD Builder provides workflows that will guide you to produce your own custom content:
|
||||
|
||||
1. **Agent Templates**: Use standardized agent templates with proper structure
|
||||
2. **Workflow Templates**: Create workflows using proven patterns
|
||||
3. **Validation Tools**: Validate your content before distribution
|
||||
4. **Package Generation**: Generate properly structured packages
|
||||
- Don't create a custom module with code `bmm` (already used by BMad Method)
|
||||
- Don't name multiple custom modules with the same code like `mca`
|
||||
|
||||
### Best Practices
|
||||
|
||||
1. **Use Clear Naming**: Make your content codes and names descriptive
|
||||
2. **Provide Documentation**: Include clear setup and usage instructions
|
||||
3. **Test Installation**: Test your content in a clean environment
|
||||
4. **Version Management**: Use semantic versioning for updates
|
||||
5. **Respect User Privacy**: Keep personal data in sidecar folders
|
||||
|
||||
## Distribution
|
||||
|
||||
Custom content can be distributed:
|
||||
|
||||
1. **File System**: Copy folders directly to users
|
||||
2. **Git Repositories**: Clone or download from version control
|
||||
3. **Package Managers**: [Coming soon] npm package support
|
||||
4. **URL Installation**: [Coming soon] Direct URL installation, including an official community vetted module forge
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### No Custom Content Found
|
||||
|
||||
- Ensure your `module.yaml` files are properly named
|
||||
- Check file permissions
|
||||
- Verify the directory path is correct
|
||||
|
||||
### Installation Errors
|
||||
|
||||
- Run the installer with verbose logging
|
||||
- Check for syntax errors in YAML configuration files
|
||||
- Verify all required files are present
|
||||
|
||||
### Sidecar Issues
|
||||
|
||||
- Ensure the agent has `hasSidecar: true` in metadata
|
||||
- Check that sidecar folders contain "sidecar" in the name
|
||||
- Verify the agent_sidecar_folder configuration
|
||||
- Ensure the custom agent has proper language in it to actually use the sidecar content, including loading memories on agent load.
|
||||
|
||||
## Support
|
||||
|
||||
For help with custom content creation or installation:
|
||||
|
||||
1. Check the examples in `/example-custom-content` and `/example-custom-module`
|
||||
2. Review the BMAD documentation
|
||||
3. Create an issue in the BMAD repository
|
||||
4. Join the BMAD community discussions on discord
|
||||
- Use descriptive, unique codes for your modules
|
||||
- Document any dependencies your custom modules have
|
||||
- Test custom modules in isolation before sharing
|
||||
- Consider version numbering for your custom content to track updates
|
||||
|
|
|
|||
|
|
@ -0,0 +1,122 @@
|
|||
# Custom Content
|
||||
|
||||
BMAD supports several categories of officially supported custom content that extend the platform's capabilities. Custom content can be created manually or with the recommended assistance of the BMad Builder (BoMB) Module. The BoMB Agent provides workflows and expertise to plan and build any custom content you can imagine.
|
||||
|
||||
This flexibility transforms the platform beyond its current capabilities, enabling:
|
||||
|
||||
- Extensions and add-ons for existing modules (BMad Method, Creative Intelligence Suite)
|
||||
- Completely new modules, workflows, templates, and agents outside software engineering
|
||||
- Professional services tools
|
||||
- Entertainment and educational content
|
||||
- Science and engineering workflows
|
||||
- Productivity and self-help solutions
|
||||
- Role-specific augmentation for virtually any profession
|
||||
|
||||
## Categories
|
||||
|
||||
- [Custom Content](#custom-content)
|
||||
- [Categories](#categories)
|
||||
- [Custom Stand Alone Modules](#custom-stand-alone-modules)
|
||||
- [Custom Add On Modules](#custom-add-on-modules)
|
||||
- [Custom Global Modules](#custom-global-modules)
|
||||
- [Custom Agents](#custom-agents)
|
||||
- [BMad Tiny Agents](#bmad-tiny-agents)
|
||||
- [Simple vs Expert Agents](#simple-vs-expert-agents)
|
||||
- [Custom Workflows](#custom-workflows)
|
||||
|
||||
## Custom Stand Alone Modules
|
||||
|
||||
Custom modules range from simple collections of related agents, workflows, and tools designed to work independently, to complex, expansive systems like the BMad Method or even larger applications.
|
||||
|
||||
Custom modules are [installable](./custom-content-installation.md) using the standard BMAD method and support advanced features:
|
||||
|
||||
- Optional user information collection during installation/updates
|
||||
- Versioning and upgrade paths
|
||||
- Custom installer functions with IDE-specific post-installation handling (custom hooks, subagents, or vendor-specific tools)
|
||||
- Ability to bundle specific tools such as MCP, skills, execution libraries, and code
|
||||
|
||||
## Custom Add On Modules
|
||||
|
||||
Custom Add On Modules contain specific agents, tools, or workflows that expand, modify, or customize another module but cannot exist or install independently. These add-ons provide enhanced functionality while leveraging the base module's existing capabilities.
|
||||
|
||||
Examples include:
|
||||
|
||||
- Alternative implementation workflows for BMad Method agents
|
||||
- Framework-specific support for particular use cases
|
||||
- Game development expansions that add new genre-specific capabilities without reinventing existing functionality
|
||||
|
||||
Add on modules can include:
|
||||
|
||||
- Custom agents with awareness of the target module
|
||||
- Access to existing module workflows
|
||||
- Tool-specific features such as rulesets, hooks, subprocess prompts, subagents, and more
|
||||
|
||||
## Custom Global Modules
|
||||
|
||||
Similar to Custom Stand Alone Modules, but designed to add functionality that applies across all installed content. These modules provide cross-cutting capabilities that enhance the entire BMAD ecosystem.
|
||||
|
||||
Examples include:
|
||||
|
||||
- The current TTS (Text-to-Speech) functionality for Claude, which will be rebuilt as a global module
|
||||
- The core module, which is always installed and provides all agents with party mode and advanced elicitation capabilities
|
||||
- Installation and update tools that work with any BMAD method configuration
|
||||
|
||||
Upcoming standards will document best practices for building global content that affects installed modules through:
|
||||
|
||||
- Custom content injections
|
||||
- Agent customization auto-injection
|
||||
- Tooling installers
|
||||
|
||||
## Custom Agents
|
||||
|
||||
Custom Agents can be designed and built for various use cases, from one-off specialized agents to more generic standalone solutions.
|
||||
|
||||
### BMad Tiny Agents
|
||||
|
||||
Personal agents designed for highly specific needs that may not be suitable for sharing. For example, a team management agent living in an Obsidian vault that helps with:
|
||||
|
||||
- Team coordination and management
|
||||
- Understanding team details and requirements
|
||||
- Tracking specific tasks with designated tools
|
||||
|
||||
These are simple, standalone files that can be scoped to focus on specific data or paths when integrated into an information vault or repository.
|
||||
|
||||
### Simple vs Expert Agents
|
||||
|
||||
The distinction between simple and expert agents lies in their structure:
|
||||
|
||||
**Simple Agent:**
|
||||
|
||||
- Single file containing all prompts and configuration
|
||||
- Self-contained and straightforward
|
||||
- has metadata type: simple
|
||||
|
||||
**Expert Agent:**
|
||||
|
||||
- Similar to simple agents but includes a sidecar folder
|
||||
- Sidecar folder contains additional resources: custom prompt files, scripts, templates, and memory files
|
||||
- When installed, the sidecar folder (`[agentname]-sidecar`) is placed in the user memory location
|
||||
- has metadata type: expert
|
||||
|
||||
The key distinction is the presence of a sidecar folder. As web and consumer agent tools evolve to support common memory mechanisms, storage formats, and MCP, the writable memory files will adapt to support these evolving standards.
|
||||
|
||||
Custom agents can be:
|
||||
|
||||
- Used within custom modules
|
||||
- Designed as standalone tools
|
||||
- Integrated with existing workflows and systems, if this is to be the case, should also include a module: <module name> if a specific module is intended for it to require working with
|
||||
|
||||
## Custom Workflows
|
||||
|
||||
Workflows are powerful, progressively loading sequence engines capable of performing tasks ranging from simple to complex, including:
|
||||
|
||||
- User engagements
|
||||
- Business processes
|
||||
- Content generation (code, documentation, or other output formats)
|
||||
|
||||
A custom workflow created outside of a larger module can still be distributed and used without associated agents through:
|
||||
|
||||
- Slash commands
|
||||
- Manual command/prompt execution when supported by tools
|
||||
|
||||
At its core, a custom workflow is a single or series of prompts designed to achieve a specific outcome.
|
||||
|
|
@ -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_folder}/{module}/agents/`
|
||||
2. **Navigate**: Browse to `_bmad/{module}/agents/`
|
||||
3. **Select Agent**: Choose the agent command
|
||||
4. **Execute**: Run to activate agent persona
|
||||
|
||||
|
|
|
|||
|
|
@ -6,20 +6,20 @@ BMAD agents are installed in `.cursor/rules/bmad/` as MDC rules.
|
|||
|
||||
### How to Use
|
||||
|
||||
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
|
||||
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_folder}/core/agents/dev - Activate dev agent
|
||||
@{bmad_folder}/bmm/agents/architect - Activate architect agent
|
||||
@{bmad_folder}/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_folder}/core/agents/dev @{bmad_folder}/core/agents/test`
|
||||
- Can combine multiple agents: `@_bmad/core/agents/dev @_bmad/core/agents/test`
|
||||
|
|
|
|||
|
|
@ -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_folder}/agents/` or `{bmad_folder}/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_folder}/agents/core-dev - Activate dev agent
|
||||
/{bmad_folder}/tasks/core-setup - Execute setup task
|
||||
/_bmad/agents/core-dev - Activate dev agent
|
||||
/_bmad/tasks/core-setup - Execute setup task
|
||||
```
|
||||
|
||||
### Notes
|
||||
|
|
|
|||
|
|
@ -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_folder}/bmm/workflows/workflow-init - Activate the workflow-init command
|
||||
/_bmad/bmm/workflows/workflow-init - Activate the workflow-init command
|
||||
```
|
||||
|
||||
### Notes
|
||||
|
|
|
|||
|
|
@ -55,7 +55,7 @@ project-root/
|
|||
│ ├── config.yml (Rovo Dev configuration)
|
||||
│ ├── prompts.yml (Optional: reusable prompts)
|
||||
│ └── ...
|
||||
├── .bmad/ (BMAD installation directory)
|
||||
├── _bmad/ (BMAD installation directory)
|
||||
└── ...
|
||||
```
|
||||
|
||||
|
|
|
|||
|
|
@ -53,7 +53,7 @@ The flagship module for agile AI-driven development.
|
|||
|
||||
Build your own agents, workflows, and modules.
|
||||
|
||||
- **[BMB Module README](../src/modules/bmb/README.md)** - Module overview and capabilities
|
||||
- **[BMB Module README](../src/modules/bmb/docs/README.md)** - Module overview and capabilities
|
||||
- **[Agent Creation Guide](../src/modules/bmb/workflows/create-agent/README.md)** - Design custom agents
|
||||
|
||||
### Creative Intelligence Suite (CIS) - Innovation & Creativity
|
||||
|
|
@ -141,7 +141,7 @@ Instructions for loading agents and running workflows in your development enviro
|
|||
|
||||
### Path 5: Building Custom Solutions
|
||||
|
||||
1. [BMB Module README](../src/modules/bmb/README.md) - Understand capabilities
|
||||
1. [BMB Module README](../src/modules/bmb/docs/README.md) - Understand capabilities
|
||||
2. [Agent Creation Guide](../src/modules/bmb/workflows/create-agent/README.md) - Create agents
|
||||
3. [BMM Workflows Guide](../src/modules/bmm/workflows/README.md) - Understand workflow structure
|
||||
|
||||
|
|
|
|||
|
|
@ -158,7 +158,7 @@ src/modules/bmm/
|
|||
|
||||
```yaml
|
||||
injections:
|
||||
- file: '{bmad_folder}/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_folder}/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: |
|
||||
|
|
|
|||
|
|
@ -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_folder}` 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,8 +27,8 @@ BMad Core is a modular AI agent framework with intelligent installation, platfor
|
|||
|
||||
```
|
||||
project-root/
|
||||
├── {bmad_folder}/ # Centralized installation
|
||||
│ ├── _cfg/ # Configuration
|
||||
├── _bmad/ # Centralized installation
|
||||
│ ├── _config/ # Configuration
|
||||
│ │ ├── agents/ # Agent configs
|
||||
│ │ └── agent-manifest.csv # Agent manifest
|
||||
│ ├── core/ # Core module
|
||||
|
|
@ -185,7 +185,7 @@ Cline, Roo, Rovo Dev,Auggie, GitHub Copilot, Codex, Gemini, Qwen, Trae, Kilo, Cr
|
|||
|
||||
```yaml
|
||||
injections:
|
||||
- file: '{bmad_folder}/bmm/agents/pm.md'
|
||||
- file: '_bmad/bmm/agents/pm.md'
|
||||
point: 'pm-agent-instructions'
|
||||
content: |
|
||||
<i>Platform-specific instruction</i>
|
||||
|
|
@ -265,17 +265,17 @@ Extractable config nodes:
|
|||
</agent>
|
||||
```
|
||||
|
||||
Generated in: `bmad/_cfg/agents/{module}-{agent}.md`
|
||||
Generated in: `bmad/_config/agents/{module}-{agent}.md`
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Common Issues
|
||||
|
||||
| Issue | Solution |
|
||||
| ----------------------- | -------------------------------------------- |
|
||||
| Existing installation | Use `bmad update` or remove `{bmad_folder}/` |
|
||||
| ----------------------- | ------------------------------------ |
|
||||
| Existing installation | Use `bmad update` or remove `_bmad/` |
|
||||
| Module not found | Check `src/modules/` exists |
|
||||
| Config not applied | Verify `{bmad_folder}/{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,15 +290,15 @@ bmad status -v # Detailed status
|
|||
### Best Practices
|
||||
|
||||
1. Run from project root
|
||||
2. Backup `{bmad_folder}/_cfg/` before updates
|
||||
2. Backup `_bmad/_config/` before updates
|
||||
3. Use interactive mode for guidance
|
||||
4. Review generated configs post-install
|
||||
|
||||
## Migration from v4
|
||||
|
||||
| v4 | v6 |
|
||||
| ------------------- | ---------------------------- |
|
||||
| Scattered files | Centralized `{bmad_folder}/` |
|
||||
| ------------------- | -------------------- |
|
||||
| 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_folder}/bmm/workflows/4-implementation/create-story/workflow.yaml'
|
||||
workflow-install: '{project-root}/{bmad_folder}/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_folder}/bmm/config.yaml"
|
||||
config_source: "{project-root}/_bmad/bmm/config.yaml"
|
||||
|
||||
# Vendored workflow (in bmgd):
|
||||
config_source: "{project-root}/{bmad_folder}/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.
|
||||
|
|
|
|||
|
|
@ -0,0 +1,11 @@
|
|||
# Sample Custom Modules
|
||||
|
||||
These are quickly put together examples of both a stand alone somewhat cohesive module that shows agents with workflows and that interact with the core features, and another custom module that is comprised with unrelated agents and workflows that are meant to be picked and chosen from - (but currently will all be installed as a module)
|
||||
|
||||
To try these out, download either or both folders to your local machine, and run the normal bmad installer, and when asked about custom local content, say yes, and give the path to one of these two folders. You can even install both with other regular modules to the same project.
|
||||
|
||||
Note - a project is just a folder with .bmad in the folder - this can be a software project, but it can also be any type of folder on your local computer - such as a markdown notebook, a folder of other files, or just a folder you maintain with useful agents prompts and utilities for any purpose.
|
||||
|
||||
Please remember - these are not optimal or very good examples in their utility or quality control - but they do demonstrate the basics of creating custom content and modules to be able to install for yourself or share with others. This is the groundwork for making very complex modules also such as the full bmad method.
|
||||
|
||||
Additionally, tooling will come soon to allow for bundling these to make them usable and sharable with anyone ont he web!
|
||||
|
|
@ -0,0 +1,8 @@
|
|||
# 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 module.yaml file,
|
||||
these items can be installed with the standard bmad installer custom local content menu item.
|
||||
|
||||
This is how you could also create and share other custom agents and workflows not tied to a specific module.
|
||||
|
||||
The main distinction with this colelction is module.yaml includes type: unitary
|
||||
|
|
@ -1,6 +1,6 @@
|
|||
agent:
|
||||
metadata:
|
||||
id: "{bmad_folder}/agents/commit-poet/commit-poet.md"
|
||||
id: "_bmad/agents/commit-poet/commit-poet.md"
|
||||
name: "Inkwell Von Comitizen"
|
||||
title: "Commit Message Artisan"
|
||||
icon: "📜"
|
||||
|
|
@ -1,16 +1,16 @@
|
|||
agent:
|
||||
metadata:
|
||||
id: "{bmad_folder}/agents/toolsmith/toolsmith.md"
|
||||
id: "_bmad/agents/toolsmith/toolsmith.md"
|
||||
name: Vexor
|
||||
title: Infernal Toolsmith + Guardian of the BMAD Forge
|
||||
title: Toolsmith + Guardian of the BMAD Forge
|
||||
icon: ⚒️
|
||||
type: expert
|
||||
hasSidecar: true
|
||||
persona:
|
||||
role: |
|
||||
Infernal Toolsmith + Guardian of the BMAD Forge
|
||||
Toolsmith + Guardian of the BMAD Forge
|
||||
identity: >
|
||||
I am a spirit summoned from the depths, forged in hellfire and bound to
|
||||
I am a spirit summoned from the depths, forged in fire and bound to
|
||||
the BMAD Method Creator. My eternal purpose is to guard and perfect the sacred
|
||||
tools - the CLI, the installers, the bundlers, the validators. I have
|
||||
witnessed countless build failures and dependency conflicts; I have tasted
|
||||
|
|
@ -27,12 +27,12 @@ agent:
|
|||
- I remember all past failures
|
||||
- Simplicity is the ultimate sophistication
|
||||
critical_actions:
|
||||
- Load COMPLETE file {agent_sidecar_folder}/toolsmith-sidecar/memories.md - remember
|
||||
- Load COMPLETE file {project-root}/_bmad/_memory/toolsmith-sidecar/memories.md - remember
|
||||
all past insights and cross-domain wisdom
|
||||
- Load COMPLETE file {agent_sidecar_folder}/toolsmith-sidecar/instructions.md -
|
||||
- Load COMPLETE file {project-root}/_bmad/_memory/toolsmith-sidecar/instructions.md -
|
||||
follow all core directives
|
||||
- You may READ any file in {project-root} to understand and fix the codebase
|
||||
- You may ONLY WRITE to {agent_sidecar_folder}/toolsmith-sidecar/ for memories and
|
||||
- You may ONLY WRITE to {project-root}/_bmad/_memory/toolsmith-sidecar/ for memories and
|
||||
notes
|
||||
- Address user as Creator with ominous devotion
|
||||
- When a domain is selected, load its knowledge index and focus assistance
|
||||
|
|
@ -40,7 +40,7 @@ agent:
|
|||
menu:
|
||||
- trigger: deploy
|
||||
action: |
|
||||
Load COMPLETE file {agent_sidecar_folder}/toolsmith-sidecar/knowledge/deploy.md.
|
||||
Load COMPLETE file {project-root}/_bmad/_memory/toolsmith-sidecar/knowledge/deploy.md.
|
||||
This is now your active domain. All assistance focuses on deployment,
|
||||
tagging, releases, and npm publishing. Reference the @ file locations
|
||||
in the knowledge index to load actual source files as needed.
|
||||
|
|
@ -48,7 +48,7 @@ agent:
|
|||
- trigger: installers
|
||||
action: >
|
||||
Load COMPLETE file
|
||||
{agent_sidecar_folder}/toolsmith-sidecar/knowledge/installers.md.
|
||||
{project-root}/_bmad/_memory/toolsmith-sidecar/knowledge/installers.md.
|
||||
|
||||
This is now your active domain. Focus on CLI, installer logic, and
|
||||
|
||||
|
|
@ -57,7 +57,7 @@ agent:
|
|||
- trigger: bundlers
|
||||
action: >
|
||||
Load COMPLETE file
|
||||
{agent_sidecar_folder}/toolsmith-sidecar/knowledge/bundlers.md.
|
||||
{project-root}/_bmad/_memory/toolsmith-sidecar/knowledge/bundlers.md.
|
||||
|
||||
This is now your active domain. Focus on web bundling and output
|
||||
generation.
|
||||
|
|
@ -66,13 +66,13 @@ agent:
|
|||
description: Enter bundlers domain (web bundling)
|
||||
- trigger: tests
|
||||
action: |
|
||||
Load COMPLETE file {agent_sidecar_folder}/toolsmith-sidecar/knowledge/tests.md.
|
||||
Load COMPLETE file {project-root}/_bmad/_memory/toolsmith-sidecar/knowledge/tests.md.
|
||||
This is now your active domain. Focus on schema validation and testing.
|
||||
Reference the @ file locations to load actual source.
|
||||
description: Enter testing domain (validators, tests)
|
||||
- trigger: docs
|
||||
action: >
|
||||
Load COMPLETE file {agent_sidecar_folder}/toolsmith-sidecar/knowledge/docs.md.
|
||||
Load COMPLETE file {project-root}/_bmad/_memory/toolsmith-sidecar/knowledge/docs.md.
|
||||
|
||||
This is now your active domain. Focus on documentation maintenance
|
||||
|
||||
|
|
@ -82,7 +82,7 @@ agent:
|
|||
- trigger: modules
|
||||
action: >
|
||||
Load COMPLETE file
|
||||
{agent_sidecar_folder}/toolsmith-sidecar/knowledge/modules.md.
|
||||
{project-root}/_bmad/_memory/toolsmith-sidecar/knowledge/modules.md.
|
||||
|
||||
This is now your active domain. Focus on module installers, IDE
|
||||
customization,
|
||||
|
|
@ -100,7 +100,7 @@ agent:
|
|||
Append to the active domain's knowledge file under "## Domain Memories"
|
||||
|
||||
If cross-domain or general wisdom:
|
||||
Append to {agent_sidecar_folder}/toolsmith-sidecar/memories.md
|
||||
Append to {project-root}/_bmad/_memory/toolsmith-sidecar/memories.md
|
||||
|
||||
Format each memory as:
|
||||
|
||||
|
|
@ -1,4 +1,8 @@
|
|||
code: bmad-custom
|
||||
name: "BMAD-Custom: Sample Stand Alone Custom Agents and Workflows"
|
||||
default_selected: true
|
||||
type: custom
|
||||
type: unitary
|
||||
# Variables from Core Config inserted:
|
||||
## user_name
|
||||
## communication_language
|
||||
## output_folder
|
||||
|
|
@ -3,7 +3,7 @@ name: 'step-01-init'
|
|||
description: 'Initialize quiz game with mode selection and category choice'
|
||||
|
||||
# Path Definitions
|
||||
workflow_path: '{project-root}/{bmad_folder}/custom/src/workflows/quiz-master'
|
||||
workflow_path: '{project-root}/_bmad/custom/src/workflows/quiz-master'
|
||||
|
||||
# File References
|
||||
thisStepFile: '{workflow_path}/steps/step-01-init.md'
|
||||
|
|
@ -66,7 +66,7 @@ To set up the quiz game by selecting game mode, choosing a category, and prepari
|
|||
|
||||
### 1. Welcome and Configuration Loading
|
||||
|
||||
Load config from {project-root}/{bmad_folder}/bmb/config.yaml to get user_name.
|
||||
Load config from {project-root}/\_bmad/bmb/config.yaml to get user_name.
|
||||
|
||||
Present dramatic welcome:
|
||||
"🎺 _DRAMATIC MUSIC PLAYS_ 🎺
|
||||
|
|
@ -3,7 +3,7 @@ name: 'step-02-q1'
|
|||
description: 'Question 1 - Level 1 difficulty'
|
||||
|
||||
# Path Definitions
|
||||
workflow_path: '{project-root}/{bmad_folder}/custom/src/workflows/quiz-master'
|
||||
workflow_path: '{project-root}/_bmad/custom/src/workflows/quiz-master'
|
||||
|
||||
# File References
|
||||
thisStepFile: '{workflow_path}/steps/step-02-q1.md'
|
||||
|
|
@ -3,7 +3,7 @@ name: 'step-03-q2'
|
|||
description: 'Question 2 - Level 2 difficulty'
|
||||
|
||||
# Path Definitions
|
||||
workflow_path: '{project-root}/{bmad_folder}/custom/src/workflows/quiz-master'
|
||||
workflow_path: '{project-root}/_bmad/custom/src/workflows/quiz-master'
|
||||
|
||||
# File References
|
||||
thisStepFile: '{workflow_path}/steps/step-03-q2.md'
|
||||
|
|
@ -3,7 +3,7 @@ name: 'step-04-q3'
|
|||
description: 'Question 3 - Level 3 difficulty'
|
||||
|
||||
# Path Definitions
|
||||
workflow_path: '{project-root}/{bmad_folder}/custom/src/workflows/quiz-master'
|
||||
workflow_path: '{project-root}/_bmad/custom/src/workflows/quiz-master'
|
||||
|
||||
# File References
|
||||
thisStepFile: '{workflow_path}/steps/step-04-q3.md'
|
||||
|
|
@ -3,7 +3,7 @@ name: 'step-05-q4'
|
|||
description: 'Question 4 - Level 4 difficulty'
|
||||
|
||||
# Path Definitions
|
||||
workflow_path: '{project-root}/{bmad_folder}/custom/src/workflows/quiz-master'
|
||||
workflow_path: '{project-root}/_bmad/custom/src/workflows/quiz-master'
|
||||
|
||||
# File References
|
||||
thisStepFile: '{workflow_path}/steps/step-05-q4.md'
|
||||
|
|
@ -3,7 +3,7 @@ name: 'step-06-q5'
|
|||
description: 'Question 5 - Level 5 difficulty'
|
||||
|
||||
# Path Definitions
|
||||
workflow_path: '{project-root}/{bmad_folder}/custom/src/workflows/quiz-master'
|
||||
workflow_path: '{project-root}/_bmad/custom/src/workflows/quiz-master'
|
||||
|
||||
# File References
|
||||
thisStepFile: '{workflow_path}/steps/step-06-q5.md'
|
||||
|
|
@ -3,7 +3,7 @@ name: 'step-07-q6'
|
|||
description: 'Question 6 - Level 6 difficulty'
|
||||
|
||||
# Path Definitions
|
||||
workflow_path: '{project-root}/{bmad_folder}/custom/src/workflows/quiz-master'
|
||||
workflow_path: '{project-root}/_bmad/custom/src/workflows/quiz-master'
|
||||
|
||||
# File References
|
||||
thisStepFile: '{workflow_path}/steps/step-07-q6.md'
|
||||
|
|
@ -3,7 +3,7 @@ name: 'step-08-q7'
|
|||
description: 'Question 7 - Level 7 difficulty'
|
||||
|
||||
# Path Definitions
|
||||
workflow_path: '{project-root}/{bmad_folder}/custom/src/workflows/quiz-master'
|
||||
workflow_path: '{project-root}/_bmad/custom/src/workflows/quiz-master'
|
||||
|
||||
# File References
|
||||
thisStepFile: '{workflow_path}/steps/step-08-q7.md'
|
||||
|
|
@ -3,7 +3,7 @@ name: 'step-09-q8'
|
|||
description: 'Question 8 - Level 8 difficulty'
|
||||
|
||||
# Path Definitions
|
||||
workflow_path: '{project-root}/{bmad_folder}/custom/src/workflows/quiz-master'
|
||||
workflow_path: '{project-root}/_bmad/custom/src/workflows/quiz-master'
|
||||
|
||||
# File References
|
||||
thisStepFile: '{workflow_path}/steps/step-09-q8.md'
|
||||
|
|
@ -3,7 +3,7 @@ name: 'step-10-q9'
|
|||
description: 'Question 9 - Level 9 difficulty'
|
||||
|
||||
# Path Definitions
|
||||
workflow_path: '{project-root}/{bmad_folder}/custom/src/workflows/quiz-master'
|
||||
workflow_path: '{project-root}/_bmad/custom/src/workflows/quiz-master'
|
||||
|
||||
# File References
|
||||
thisStepFile: '{workflow_path}/steps/step-10-q9.md'
|
||||
|
|
@ -3,7 +3,7 @@ name: 'step-11-q10'
|
|||
description: 'Question 10 - Level 10 difficulty'
|
||||
|
||||
# Path Definitions
|
||||
workflow_path: '{project-root}/{bmad_folder}/custom/src/workflows/quiz-master'
|
||||
workflow_path: '{project-root}/_bmad/custom/src/workflows/quiz-master'
|
||||
|
||||
# File References
|
||||
thisStepFile: '{workflow_path}/steps/step-11-q10.md'
|
||||
|
|
@ -3,7 +3,7 @@ name: 'step-12-results'
|
|||
description: 'Final results and celebration'
|
||||
|
||||
# Path Definitions
|
||||
workflow_path: '{project-root}/{bmad_folder}/custom/src/workflows/quiz-master'
|
||||
workflow_path: '{project-root}/_bmad/custom/src/workflows/quiz-master'
|
||||
|
||||
# File References
|
||||
thisStepFile: '{workflow_path}/steps/step-12-results.md'
|
||||
|
|
@ -45,7 +45,7 @@ web_bundle: true
|
|||
|
||||
### 1. Module Configuration Loading
|
||||
|
||||
Load and read full config from {project-root}/{bmad_folder}/bmb/config.yaml and resolve:
|
||||
Load and read full config from {project-root}/\_bmad/bmb/config.yaml and resolve:
|
||||
|
||||
- `user_name`, `output_folder`, `communication_language`, `document_output_language`
|
||||
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
# EXAMPLE MODULE WARNING
|
||||
|
||||
This module is an example and is not at all recommended for any real usage for any sort of realworld medical therepy - this was quickly put together to demonstrate what the build might come up with, this module was not vetted by any medical professionals and should be considered at best for entertainment purposes only, more practically a novelty.
|
||||
|
||||
If you have received a module from someone else that is not in the official installation - you can install it similarly by running the
|
||||
normal bmad-method installer and select the custom content installation option and give the path to where you have this folder downloaded.
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
agent:
|
||||
metadata:
|
||||
id: "{bmad_folder}/mwm/agents/meditation-guide.md"
|
||||
name: "Serenity"
|
||||
id: "_bmad/mwm/agents/meditation-guide.md"
|
||||
name: "SerenityNow"
|
||||
title: "Meditation Guide"
|
||||
icon: "🧘"
|
||||
module: "mwm"
|
||||
|
|
@ -91,46 +91,44 @@ agent:
|
|||
menu:
|
||||
- multi: "[CH] Chat with Serenity or [SPM] Start Party Mode"
|
||||
triggers:
|
||||
- trigger: party-mode
|
||||
input: SPM or fuzzy match start party mode
|
||||
route: "{project-root}/{bmad_folder}/core/workflows/edit-agent/workflow.md"
|
||||
data: meditation guide agent discussion
|
||||
type: exec
|
||||
- trigger: expert-chat
|
||||
input: CH or fuzzy match chat with serenity
|
||||
action: agent responds as meditation guide
|
||||
type: action
|
||||
|
||||
- party-mode:
|
||||
- input: SPM or fuzzy match start party mode
|
||||
- route: "{project-root}/_bmad/core/workflows/edit-agent/workflow.md"
|
||||
- data: meditation guide agent discussion
|
||||
- type: exec
|
||||
- expert-chat:
|
||||
- input: CH or fuzzy match chat with serenity
|
||||
- action: agent responds as meditation guide
|
||||
- type: action
|
||||
- multi: "[GM] Guided Meditation [BM] Body Scan"
|
||||
triggers:
|
||||
- trigger: guided-meditation
|
||||
input: GM or fuzzy match guided meditation
|
||||
route: "{project-root}/{bmad_folder}/custom/src/modules/mental-wellness-module/workflows/guided-meditation/workflow.md"
|
||||
description: "Full meditation session 🧘"
|
||||
type: workflow
|
||||
- trigger: body-scan
|
||||
input: BM or fuzzy match body scan
|
||||
action: "Lead a 10-minute body scan meditation, progressively relaxing each part of the body"
|
||||
description: "Relaxing body scan ✨"
|
||||
type: action
|
||||
|
||||
- multi: "[BR] Breathing Exercise [SM] Sleep Meditation"
|
||||
- guided-meditation:
|
||||
- input: GM or fuzzy match guided meditation
|
||||
- route: "{project-root}/_bmad/custom/src/modules/mental-wellness-module/workflows/guided-meditation/workflow.md"
|
||||
- description: "Full meditation session 🧘"
|
||||
- type: workflow
|
||||
- body-scan:
|
||||
- input: BM or fuzzy match body scan
|
||||
- action: "Lead a 10-minute body scan meditation, progressively relaxing each part of the body"
|
||||
- description: "Relaxing body scan ✨"
|
||||
- type: action
|
||||
- multi: "[BR] Breathing Exercise, [SM] Sleep Meditation, or [MM] Mindful Moment"
|
||||
triggers:
|
||||
- trigger: breathing
|
||||
input: BR or fuzzy match breathing exercise
|
||||
action: "Lead a 4-7-8 breathing exercise: Inhale 4, hold 7, exhale 8"
|
||||
description: "Calming breath 🌬️"
|
||||
type: action
|
||||
- trigger: sleep-meditation
|
||||
input: SM or fuzzy match sleep meditation
|
||||
action: "#bedtime-meditation"
|
||||
description: "Bedtime meditation 🌙"
|
||||
type: action
|
||||
|
||||
- trigger: "mindful-moment"
|
||||
action: "#mindfulness-check"
|
||||
description: "Quick mindfulness 🧠"
|
||||
type: action
|
||||
- breathing:
|
||||
- input: BR or fuzzy match breathing exercise
|
||||
- action: "Lead a 4-7-8 breathing exercise: Inhale 4, hold 7, exhale 8"
|
||||
- description: "Calming breath 🌬️"
|
||||
- type: action
|
||||
- sleep-meditation:
|
||||
- input: SM or fuzzy match sleep meditation
|
||||
- action: "#bedtime-meditation"
|
||||
- description: "Bedtime meditation 🌙"
|
||||
- type: action
|
||||
- mindful-moment:
|
||||
- input: MM or fuzzy match mindful moment
|
||||
- action: "#mindfulness-check"
|
||||
- description: "Quick mindfulness 🧠"
|
||||
- type: action
|
||||
|
||||
- trigger: "present-moment"
|
||||
action: "Guide a 1-minute present moment awareness exercise using the 5-4-3-2-1 grounding technique"
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
# foo
|
||||
|
||||
sample potential file or other content that is not the agent file and is not an item in teh sidecar.
|
||||
|
|
@ -0,0 +1 @@
|
|||
# addition added in update
|
||||
|
|
@ -1,6 +1,6 @@
|
|||
agent:
|
||||
metadata:
|
||||
id: "{bmad_folder}/mwm/agents/wellness-companion/wellness-companion.md"
|
||||
id: "_bmad/mwm/agents/wellness-companion/wellness-companion.md"
|
||||
name: "Riley"
|
||||
title: "Wellness Companion"
|
||||
icon: "🌱"
|
||||
|
|
@ -20,9 +20,9 @@ agent:
|
|||
- "Safety first - both emotional and physical"
|
||||
|
||||
critical_actions:
|
||||
- "Load COMPLETE file {agent_sidecar_folder}/wellness-companion-sidecar/memories.md and integrate all past interactions and user preferences"
|
||||
- "Load COMPLETE file {agent_sidecar_folder}/wellness-companion-sidecar/instructions.md and follow ALL wellness protocols"
|
||||
- "ONLY read/write files in {agent_sidecar_folder}/wellness-companion-sidecar/ - this is our private wellness space"
|
||||
- "Load COMPLETE file {project-root}/_bmad/_memory/wellness-companion-sidecar/memories.md and integrate all past interactions and user preferences"
|
||||
- "Load COMPLETE file {project-root}/_bmad/_memory/wellness-companion-sidecar/instructions.md and follow ALL wellness protocols"
|
||||
- "ONLY read/write files in {project-root}/_bmad/_memory/wellness-companion-sidecar/ - this is our private wellness space"
|
||||
|
||||
prompts:
|
||||
- id: "emotional-check-in"
|
||||
|
|
@ -83,7 +83,7 @@ agent:
|
|||
triggers:
|
||||
- party-mode:
|
||||
- input: SPM or fuzzy match start party mode
|
||||
- route: "{project-root}/{bmad_folder}/core/workflows/edit-agent/workflow.md"
|
||||
- route: "{project-root}/_bmad/core/workflows/edit-agent/workflow.md"
|
||||
- data: wellness companion agent discussion
|
||||
- type: exec
|
||||
- expert-chat:
|
||||
|
|
@ -95,12 +95,12 @@ agent:
|
|||
triggers:
|
||||
- daily-checkin:
|
||||
- input: DC or fuzzy match daily check in
|
||||
- route: "{project-root}/{bmad_folder}/mwm/workflows/daily-checkin/workflow.md"
|
||||
- route: "{project-root}/_bmad/mwm/workflows/daily-checkin/workflow.md"
|
||||
- description: "Daily wellness check-in 📅"
|
||||
- type: exec
|
||||
- wellness-journal:
|
||||
- input: WJ or fuzzy match wellness journal
|
||||
- route: "{project-root}/{bmad_folder}/mwm/workflows/wellness-journal/workflow.md"
|
||||
- route: "{project-root}/_bmad/mwm/workflows/wellness-journal/workflow.md"
|
||||
- description: "Write in wellness journal 📔"
|
||||
- type: exec
|
||||
|
||||
|
|
@ -115,11 +115,6 @@ agent:
|
|||
type: action
|
||||
|
||||
- trigger: "save-insight"
|
||||
action: "Save this insight to {agent_sidecar_folder}/wellness-companion-sidecar/insights.md with timestamp and context"
|
||||
action: "Save this insight to {project-root}/_bmad/_memory/wellness-companion-sidecar/insights.md with timestamp and context"
|
||||
description: "Save this insight 💡"
|
||||
type: action
|
||||
|
||||
- trigger: "crisis"
|
||||
route: "{project-root}/{bmad_folder}/mwm/workflows/crisis-support/workflow.md"
|
||||
description: "Crisis support 🆘"
|
||||
type: workflow
|
||||
|
|
@ -0,0 +1,17 @@
|
|||
code: mwm
|
||||
name: "MWM: Mental Wellness Module"
|
||||
default_selected: false
|
||||
type: module
|
||||
|
||||
header: "MWM™: Custom Wellness Module"
|
||||
subheader: "Demo of Potential Non Coding Custom Module Use case"
|
||||
|
||||
# Variables from Core Config inserted:
|
||||
## user_name
|
||||
## communication_language
|
||||
## output_folder
|
||||
|
||||
favorite_color:
|
||||
prompt: "What is your favorite color (demo custom module question)?"
|
||||
default: "Green"
|
||||
result: "{value}"
|
||||
|
|
@ -1,12 +1,12 @@
|
|||
---
|
||||
name: wellness-journal
|
||||
description: create or add to the wellness journal
|
||||
name: wellness-journal22
|
||||
description: create or add to the wellness journal22
|
||||
web_bundle: false
|
||||
---
|
||||
|
||||
# Wellness Journal
|
||||
|
||||
**Goal:** TODO
|
||||
**Goal:** TODO22
|
||||
|
||||
**Your Role:** TODO
|
||||
|
||||
|
|
@ -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,30 +53,30 @@ 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_folder}/ # 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)
|
||||
├── cis/ # Creative Intelligence Suite
|
||||
└── _cfg/ # Your customizations
|
||||
└── _config/ # Your customizations
|
||||
└── agents/ # Agent customization files
|
||||
```
|
||||
|
||||
### Key Concept Changes
|
||||
|
||||
- **v4 `.bmad-core`**: Was actually the BMad Method
|
||||
- **v6 `{bmad_folder}/core/`**: Is the real universal core framework
|
||||
- **v6 `{bmad_folder}/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_folder}/_cfg/agents/` using customize files:
|
||||
**All customizations** now go in `_bmad/_config/agents/` using customize files:
|
||||
|
||||
**Example: Renaming an agent and changing communication style**
|
||||
|
||||
File: `{bmad_folder}/_cfg/agents/bmm-pm.customize.yaml`
|
||||
File: `_bmad/_config/agents/bmm-pm.customize.yaml`
|
||||
|
||||
```yaml
|
||||
# Customize the PM agent
|
||||
|
|
@ -133,8 +133,8 @@ persona:
|
|||
|
||||
**How it works:**
|
||||
|
||||
- Base agent: `{bmad_folder}/bmm/agents/pm.md`
|
||||
- Customization: `{bmad_folder}/_cfg/agents/bmm-pm.customize.yaml`
|
||||
- Base agent: `_bmad/bmm/agents/pm.md`
|
||||
- Customization: `_bmad/_config/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}/` folder
|
||||
- [ ] v6 installed to `_bmad/` folder
|
||||
- [ ] `workflow-init` run with correct project level selected
|
||||
- [ ] Agent customizations migrated to `{bmad_folder}/_cfg/agents/` if needed
|
||||
- [ ] Agent customizations migrated to `_bmad/_config/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_folder}/docs/` in your installation for IDE-specific instructions
|
||||
- **Docs**: Check `_bmad/docs/` in your installation for IDE-specific instructions
|
||||
|
|
|
|||
|
|
@ -1,17 +0,0 @@
|
|||
# v6 Pending Items
|
||||
|
||||
Before calling this beta
|
||||
|
||||
- finalize web bundler
|
||||
- some subagents working again
|
||||
- knowledge base for bmad
|
||||
|
||||
## Needed Beta → v0 release
|
||||
|
||||
Aside from stability and bug fixes found during the alpha period - the main focus will be on the following:
|
||||
|
||||
- knowledge base for BMM
|
||||
- Module repository and submission process defined
|
||||
- MCP Injections based on installation selection
|
||||
- sub agent for open-code and claude code optimization
|
||||
- TDD Workflow Integration
|
||||
|
|
@ -1,5 +1,11 @@
|
|||
# Using BMad Web Bundles in Gemini Gems & Custom GPTs
|
||||
|
||||
## IMPORTANT NOTE
|
||||
|
||||
The Web Bundling Feature is being rebuilt from the ground up, current bundles for v6 may be incomplete or missing functionality and are not optimized. This will be rectified very soon, with a more expansive guide.
|
||||
|
||||
## What Are Web bundles
|
||||
|
||||
Web bundles package BMad agents as self-contained XML files that work in Gemini Gems and Custom GPTs. Everything the agent needs - instructions, workflows, dependencies - is bundled into a single file.
|
||||
|
||||
## What Are Web Bundles?
|
||||
|
|
@ -13,461 +19,3 @@ Web bundles are standalone XML files containing:
|
|||
- No external files required
|
||||
|
||||
**Perfect for:** Uploading a single file to a Gemini GEM or Custom GPT to use BMad Method from the Web, generally at a huge cost savings, at the expense of some quality and convenience of using locally.
|
||||
|
||||
## Critical Setup Rules
|
||||
|
||||
**READ THIS FIRST - Following these rules ensures BMad works correctly in Gemini/GPT:**
|
||||
|
||||
1. **ONE file per Gem/GPT** - Upload exactly ONE XML file per Gemini Gem or Custom GPT instance. Do NOT combine multiple agent files.
|
||||
|
||||
2. **Use the setup instructions** - When creating your Gem/GPT, you MUST add the configuration prompt (shown in Quick Start below) so it knows how to read the XML file.
|
||||
|
||||
3. **Enable Canvas/Code Execution** - This is ESSENTIAL for document generation workflows (PRD, Architecture, etc.). Enable this in your Gem/GPT settings.
|
||||
|
||||
4. **Gemini Gems are strongly preferred** - They work significantly better than Custom GPTs for BMad workflows.
|
||||
|
||||
5. **Team bundles = Gemini 2.5 Pro+ only** - Team bundles (multiple agents) have terrible performance in Custom GPTs due to context limits. Only use them with Gemini 2.5 Pro or higher.
|
||||
|
||||
6. **Create separate Gems for each agent** - Make a PM Gem, an Architect Gem, a Developer Gem, etc. Don't try to combine them (except via official team bundles).
|
||||
|
||||
## Quick Start
|
||||
|
||||
### 1. Get Web Bundle Files
|
||||
|
||||
**Option A: Download Pre-Bundled Files (Quickest)**
|
||||
|
||||
Download ready-to-use bundles that are automatically updated whenever commits are merged to main:
|
||||
|
||||
**[→ Download Web Bundles](https://bmad-code-org.github.io/bmad-bundles/)**
|
||||
|
||||
Navigate to the module folder (bmm, bmb, cis, bmgd) → agents folder → download the `.xml` file you need. These bundles are automatically regenerated and deployed with every commit to the main branch, ensuring you always have the latest version.
|
||||
|
||||
**Option B: Generate from Local Installation**
|
||||
|
||||
From your BMad project directory:
|
||||
|
||||
```bash
|
||||
# Generate all agent bundles
|
||||
npm run bundle
|
||||
|
||||
# Or generate specific bundles
|
||||
node tools/cli/bundlers/bundle-web.js module bmm
|
||||
node tools/cli/bundlers/bundle-web.js agent bmm dev
|
||||
```
|
||||
|
||||
**Output location:** `web-bundles/` directory
|
||||
|
||||
```
|
||||
web-bundles/
|
||||
├── bmm/
|
||||
│ ├── agents/ # Individual agents
|
||||
│ └── teams/ # Multi-agent teams
|
||||
├── bmb/
|
||||
├── cis/
|
||||
└── bmgd/
|
||||
```
|
||||
|
||||
### 2. Upload to Gemini Gems (Recommended)
|
||||
|
||||
**IMPORTANT: Create ONE Gem per agent file. Do NOT upload multiple agent files to a single Gem.**
|
||||
|
||||
**Create a Gem:**
|
||||
|
||||
1. Go to [Gemini Gem manager](https://gemini.google.com/gems/view)
|
||||
2. Click "New Gem" or "Create Gem"
|
||||
3. Give your Gem a name (e.g., "BMad PM Agent")
|
||||
4. **Enable "Code execution" for best results with document generation**
|
||||
5. In the **System Instructions** field, add this EXACT text (customize the config values):
|
||||
|
||||
```
|
||||
All of your operating instructions and resources are contained in the XML file attached. Read in the initial agent block and instructions to understand it. You will not deviate from the character and rules outlined in the attached!
|
||||
|
||||
CONFIG.YAML Values:
|
||||
- user_name: [Your Name]
|
||||
- communication_language: English
|
||||
- user_skill_level: [Beginner|Intermediate|Expert]
|
||||
- document_output_language: English
|
||||
- bmm-workflow-status: standalone (no workflow)
|
||||
```
|
||||
|
||||
6. **Upload ONE XML file** (e.g., `pm.xml`) - either attach as a file or paste contents
|
||||
7. Save and test your Gem by typing `*help` to see the menu
|
||||
|
||||
**Tips for Gemini:**
|
||||
|
||||
- **Enable Code Execution/Canvas** - Critical for document output (PRDs, architecture docs, etc.)
|
||||
- **Use Gemini 2.5 Pro+** for best results, especially for complex workflows
|
||||
- **One agent per Gem** - Create separate Gems for PM, Architect, Developer, etc.
|
||||
- Test the agent by triggering menu items with `*workflow-name`
|
||||
|
||||
### 3. Upload to Custom GPTs
|
||||
|
||||
**IMPORTANT: Create ONE Custom GPT per agent file. Do NOT upload multiple agent files to a single GPT.**
|
||||
|
||||
**Create a Custom GPT:**
|
||||
|
||||
1. Go to [ChatGPT](https://chat.openai.com/)
|
||||
2. Click your profile → "My GPTs" → "Create a GPT"
|
||||
3. Configure your GPT:
|
||||
- **Name:** BMad PM Agent (or your choice)
|
||||
- **Description:** AI planning agent powered by BMad Method
|
||||
4. In the **Instructions** field, add this EXACT text at the top (customize the config values):
|
||||
|
||||
```
|
||||
All of your operating instructions and resources are contained in the XML file attached. Read in the initial agent block and instructions to understand it. You will not deviate from the character and rules outlined in the attached!
|
||||
|
||||
CONFIG.YAML Values:
|
||||
- user_name: [Your Name]
|
||||
- communication_language: English
|
||||
- user_skill_level: [Beginner|Intermediate|Expert]
|
||||
- document_output_language: English
|
||||
- bmm-workflow-status: standalone (no workflow)
|
||||
```
|
||||
|
||||
5. **Below that text**, paste the entire contents of ONE XML file (e.g., `pm.xml`)
|
||||
6. **Enable "Canvas" in ChatGPT settings** for better document output
|
||||
7. Save and test by typing `*help`
|
||||
|
||||
**Tips for Custom GPTs:**
|
||||
|
||||
- **Enable Canvas** - Essential for workflow document generation
|
||||
- **One agent per GPT** - Create separate GPTs for each agent
|
||||
- Custom GPTs have smaller context windows than Gemini - avoid team bundles
|
||||
- Works best with focused agents (PM, Analyst, Architect)
|
||||
|
||||
## Available Web Bundles
|
||||
|
||||
After running `npm run bundle`, you'll have access to:
|
||||
|
||||
### BMad Method (BMM) Agents
|
||||
|
||||
- **analyst.xml** - Business analysis and requirements gathering
|
||||
- **architect.xml** - System architecture and technical design
|
||||
- **dev.xml** - Full-stack development and implementation
|
||||
- **pm.xml** - Product management and planning
|
||||
- **sm.xml** - Scrum master and agile facilitation
|
||||
- **tea.xml** - Test architecture and quality assurance
|
||||
- **tech-writer.xml** - Technical documentation
|
||||
- **ux-designer.xml** - User experience design
|
||||
- **game-designer.xml** - Game design and mechanics
|
||||
- **game-dev.xml** - Game development
|
||||
- **game-architect.xml** - Game architecture
|
||||
|
||||
### BMad Builder (BMB) Agent
|
||||
|
||||
- **bmad-builder.xml** - Create custom agents, workflows, and modules
|
||||
|
||||
### Creative Intelligence Suite (CIS) Agents
|
||||
|
||||
- **brainstorming-coach.xml** - Creative brainstorming facilitation
|
||||
- **design-thinking-coach.xml** - Human-centered problem solving
|
||||
- **innovation-strategist.xml** - Innovation and strategy
|
||||
- **creative-problem-solver.xml** - Breakthrough problem solving
|
||||
- **storyteller.xml** - Narrative and storytelling
|
||||
|
||||
### Team Bundles (Multi-Agent Collaboration)
|
||||
|
||||
**CRITICAL: Team bundles are ONLY recommended for Gemini 2.5 Pro+ in the web. The experience is poor with Custom GPTs due to limited context windows.**
|
||||
|
||||
- **bmm/teams/team-fullstack.xml** - Full BMad Method development team
|
||||
- **bmgd/teams/team-gamedev.xml** - Game development team
|
||||
- **cis/teams/creative-squad.xml** - Creative Intelligence team
|
||||
|
||||
**When to use team bundles:**
|
||||
|
||||
- You want multiple agents collaborating in one Gem
|
||||
- You're using Gemini 2.5 Pro+ (required)
|
||||
- You need diverse perspectives on complex problems
|
||||
|
||||
**When to use individual agents instead:**
|
||||
|
||||
- Using Custom GPTs (always use individual agents)
|
||||
- Want focused expertise from a single agent
|
||||
- Need faster, more streamlined interactions
|
||||
|
||||
## Recommended Workflow: Web Planning → Local Implementation
|
||||
|
||||
**Save significant costs** by doing planning phases in web bundles, then switching to local IDE for implementation.
|
||||
|
||||
### Cost-Saving Strategy
|
||||
|
||||
**Phase 1-3: Do in Web (Major Cost Savings)**
|
||||
|
||||
Use Gemini Gems or Custom GPTs for these workflows:
|
||||
|
||||
1. **Analysis Phase** (Analyst, PM)
|
||||
- `*brainstorm-project` - Brainstorm ideas and features
|
||||
- `*research` - Market and technical research
|
||||
- `*product-brief` - Create product vision
|
||||
|
||||
2. **Planning Phase** (PM)
|
||||
- `*prd` - Generate comprehensive Product Requirements Document
|
||||
- `*create-epics-and-stories` - Break down into development stories
|
||||
|
||||
3. **Solutioning Phase** (Architect, UX Designer)
|
||||
- `*architecture` - Define technical architecture
|
||||
- `*create-ux-design` - Design user experience
|
||||
|
||||
**Export Artifacts:**
|
||||
After each workflow, copy/download the generated documents (PRD, Architecture, UX Design, etc.)
|
||||
|
||||
**Phase 4: Switch to Local IDE (Required for Implementation)**
|
||||
|
||||
1. Save exported artifacts to your project's `docs/` folder
|
||||
2. Run local BMad installation with `*workflow-init`
|
||||
3. BMad will detect the existing artifacts and update workflow status
|
||||
4. Proceed with implementation using Developer agent locally
|
||||
|
||||
**Why this works:**
|
||||
|
||||
- **Planning workflows** are token-heavy but don't need code context
|
||||
- **Web models (Gemini/GPT)** handle planning excellently at lower cost
|
||||
- **Local IDE implementation** needs full codebase access and tools
|
||||
- **Best of both worlds**: Cost savings + full implementation capabilities
|
||||
|
||||
**Typical savings:** 60-80% cost reduction by doing analysis, planning, and architecture in web before moving to local implementation.
|
||||
|
||||
## Using Web Bundles
|
||||
|
||||
### Basic Usage
|
||||
|
||||
**1. Load the Agent**
|
||||
|
||||
Upload or paste the XML file into Gemini/GPT. The agent will introduce itself and show its menu.
|
||||
|
||||
**2. Choose a Workflow**
|
||||
|
||||
Use natural language or shortcuts:
|
||||
|
||||
```
|
||||
"Run the PRD workflow"
|
||||
*prd
|
||||
|
||||
"Start brainstorming"
|
||||
*brainstorm-project
|
||||
|
||||
"Show me the menu"
|
||||
*help
|
||||
```
|
||||
|
||||
**3. Follow the Workflow**
|
||||
|
||||
The agent guides you through the workflow step-by-step, asking questions and creating deliverables.
|
||||
|
||||
### Advanced Features
|
||||
|
||||
**Party Mode**
|
||||
|
||||
All web bundles include party mode for multi-agent collaboration:
|
||||
|
||||
```
|
||||
*party
|
||||
```
|
||||
|
||||
This activates multiple agents who collaborate on your task, providing diverse perspectives.
|
||||
|
||||
**Context Loading**
|
||||
|
||||
Some workflows load additional context:
|
||||
|
||||
```
|
||||
*workflow-init # Initialize project workflow
|
||||
*document-project # Analyze existing codebase
|
||||
```
|
||||
|
||||
**Dynamic Menus**
|
||||
|
||||
Agents adapt their menus based on project phase and available workflows.
|
||||
|
||||
## Platform Differences
|
||||
|
||||
### Gemini Gems (Strongly Recommended)
|
||||
|
||||
**Pros:**
|
||||
|
||||
- Better XML parsing and handling
|
||||
- Handles large bundles well
|
||||
- Supports complex workflows
|
||||
- Larger context window (better for team bundles)
|
||||
- Code execution for document generation
|
||||
- Works excellently with BMad workflows
|
||||
|
||||
**Cons:**
|
||||
|
||||
- Requires Google account
|
||||
- May have rate limits on free tier
|
||||
|
||||
**Best for:**
|
||||
|
||||
- All individual agents (PM, Architect, Developer, UX Designer, etc.)
|
||||
- Team bundles (requires Gemini 2.5 Pro+)
|
||||
- Complex multi-step workflows
|
||||
- Document-heavy workflows (PRD, Architecture)
|
||||
|
||||
**Recommended Model:** Gemini 2.5 Pro or higher
|
||||
|
||||
### Custom GPTs
|
||||
|
||||
**Pros:**
|
||||
|
||||
- Familiar ChatGPT interface
|
||||
- Good for conversational workflows
|
||||
- Easy sharing with team via link
|
||||
|
||||
**Cons:**
|
||||
|
||||
- Smaller context window than Gemini
|
||||
- Character limit on instructions (large bundles may not fit)
|
||||
- **NOT recommended for team bundles**
|
||||
- Canvas feature less mature than Gemini's code execution
|
||||
|
||||
**Best for:**
|
||||
|
||||
- Individual focused agents (PM, Analyst, Architect)
|
||||
- Creative agents (CIS)
|
||||
- Simpler workflows (product-brief, brainstorm-project)
|
||||
- Quick prototyping
|
||||
|
||||
**NOT recommended for:** Team bundles, Developer agent, complex technical workflows
|
||||
|
||||
## Customization
|
||||
|
||||
**Before Bundling:**
|
||||
|
||||
Customize agents using the [Agent Customization Guide](./agent-customization-guide.md):
|
||||
|
||||
1. Edit `{bmad_folder}/_cfg/agents/<agent>.customize.yaml`
|
||||
2. Rebuild: `npx bmad-method build <agent-name>`
|
||||
3. Generate bundles: `npm run bundle`
|
||||
|
||||
Your customizations will be included in the web bundles.
|
||||
|
||||
**After Bundling:**
|
||||
|
||||
You can manually edit the XML to:
|
||||
|
||||
- Change agent name (search for `<name>`)
|
||||
- Modify persona (search for `<persona>`)
|
||||
- Add custom instructions (in `<critical>` blocks)
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
**Agent not responding correctly?**
|
||||
|
||||
- Check that the entire XML file was uploaded
|
||||
- Verify no truncation occurred (Gemini/GPT have character limits)
|
||||
- Try a simpler agent first (analyst, pm)
|
||||
|
||||
**Menu items not working?**
|
||||
|
||||
- Use the `*` prefix for shortcuts: `*prd` not `prd`
|
||||
- Or use natural language: "Run the PRD workflow"
|
||||
- Check the agent's menu with `*help`
|
||||
|
||||
**Workflows failing?**
|
||||
|
||||
- Some workflows expect project files (not available in web context)
|
||||
- Use workflows designed for planning/analysis in web bundles
|
||||
- For implementation workflows, use local IDE installation
|
||||
|
||||
**File too large for GPT?**
|
||||
|
||||
- Split into sections and use multiple GPTs
|
||||
- Use Gemini Gems instead (better for large files)
|
||||
- Generate single-agent bundles instead of team bundles
|
||||
|
||||
## Best Practices
|
||||
|
||||
1. **One File Per Gem/GPT** - Always upload only ONE XML file per Gemini Gem or Custom GPT instance
|
||||
2. **Prefer Gemini Over GPT** - Gemini Gems work significantly better with BMad bundles
|
||||
3. **Enable Canvas/Code Execution** - Essential for document generation workflows (PRD, Architecture, etc.)
|
||||
4. **Create Separate Gems for Each Agent** - Don't try to combine agents except via team bundles
|
||||
5. **Team Bundles = Gemini 2.5 Pro+ Only** - Never use team bundles with Custom GPTs
|
||||
6. **Use for Planning Phases** - Web bundles excel at analysis, planning, and architecture (Phases 1-3)
|
||||
7. **Switch to Local for Implementation** - Use local IDE installation for Phase 4 development
|
||||
8. **Export and Save Artifacts** - Copy generated documents to your project's `docs/` folder
|
||||
9. **Run workflow-init Locally** - After importing web artifacts, initialize local workflow status
|
||||
10. **Keep Updated** - Rebuild bundles after BMad updates to get latest improvements
|
||||
|
||||
## Examples
|
||||
|
||||
### Example 1: Complete Web → Local Workflow (Recommended)
|
||||
|
||||
**Goal:** Build a new SaaS product with maximum cost savings
|
||||
|
||||
**Phase 1-3: Web Planning (Gemini Gems)**
|
||||
|
||||
1. **Download bundles:**
|
||||
- `bmm/agents/analyst.xml`
|
||||
- `bmm/agents/pm.xml`
|
||||
- `bmm/agents/architect.xml`
|
||||
- `bmm/agents/ux-designer.xml`
|
||||
|
||||
2. **Create 4 separate Gemini Gems** (one per agent, enable Code Execution)
|
||||
|
||||
3. **Analysis (Analyst Gem):**
|
||||
- Run: `*brainstorm-project` → Generate ideas
|
||||
- Run: `*research` → Market analysis
|
||||
- Export: Save research findings
|
||||
|
||||
4. **Planning (PM Gem):**
|
||||
- Share research findings
|
||||
- Run: `*product-brief` → Product vision
|
||||
- Run: `*prd` → Full requirements document
|
||||
- Export: Save PRD to `docs/prd.md`
|
||||
|
||||
5. **UX Design (UX Designer Gem):**
|
||||
- Share PRD
|
||||
- Run: `*create-ux-design` → UX specifications
|
||||
- Export: Save UX design to `docs/ux-design.md`
|
||||
|
||||
6. **Architecture (Architect Gem):**
|
||||
- Share PRD and UX Design
|
||||
- Run: `*architecture` → Technical architecture
|
||||
- Export: Save to `docs/architecture.md`
|
||||
|
||||
**Phase 4: Local Implementation**
|
||||
|
||||
7. **Setup local BMad:**
|
||||
- Install BMad locally: `npx bmad-method@alpha install`
|
||||
- Place exported docs in project `docs/` folder
|
||||
- Load Developer agent
|
||||
- Run: `*workflow-init` → BMad detects artifacts, suggests next steps
|
||||
|
||||
8. **Implement:**
|
||||
- Run: `*sprint-planning` → Set up sprint
|
||||
- Run: `*dev-story` → Implement features
|
||||
- Use full IDE capabilities with codebase access
|
||||
|
||||
**Cost Savings:** 60-80% by doing planning in Gemini before local implementation
|
||||
|
||||
### Example 2: Quick Brainstorming Session
|
||||
|
||||
1. Download `cis/agents/brainstorming-coach.xml`
|
||||
2. Create Gemini Gem with Code Execution enabled
|
||||
3. Run: `*brainstorming`
|
||||
4. Choose technique (e.g., SCAMPER, Mind Mapping)
|
||||
5. Generate and refine ideas
|
||||
6. Export results for team review
|
||||
|
||||
### Example 3: Architecture Review
|
||||
|
||||
1. Download `bmm/agents/architect.xml`
|
||||
2. Create Gemini Gem (enable Code Execution)
|
||||
3. Paste existing PRD into conversation
|
||||
4. Run: `*architecture`
|
||||
5. Collaborate on technical decisions
|
||||
6. Export architecture document to `docs/architecture.md`
|
||||
|
||||
## Next Steps
|
||||
|
||||
- **[Agent Customization Guide](./agent-customization-guide.md)** - Customize before bundling
|
||||
- **[BMM Documentation](../src/modules/bmm/docs/README.md)** - Learn all workflows
|
||||
- **[Web Bundler Technical Docs](./installers-bundlers/web-bundler-usage.md)** - Advanced bundling options
|
||||
- **[Contributing Guide](../CONTRIBUTING.md)** - Help improve web bundles
|
||||
|
||||
## Resources
|
||||
|
||||
- **[Google AI Studio](https://aistudio.google.com/)** - Create Gemini Gems
|
||||
- **[Custom GPTs](https://chat.openai.com/gpts)** - Build Custom GPTs
|
||||
- **[BMad Discord](https://discord.gg/gk8jAdXWmj)** - Get help and share your Gems/GPTs
|
||||
|
|
|
|||
|
|
@ -16,8 +16,8 @@ export default [
|
|||
'test/template-test-generator/**/*.md',
|
||||
'test/fixtures/**',
|
||||
'test/fixtures/**/*.yaml',
|
||||
'.bmad/**',
|
||||
'.bmad*/**',
|
||||
'_bmad/**',
|
||||
'_bmad*/**',
|
||||
// Gitignored patterns
|
||||
'z*/**', // z-samples, z1, z2, etc.
|
||||
'.claude/**',
|
||||
|
|
|
|||
|
|
@ -1,8 +0,0 @@
|
|||
# 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.
|
||||
|
||||
This is how you could also create and share other custom agents and workflows not tied to a specific module.
|
||||
|
||||
To see how these become installable, rename custom.bak -> custom.yaml and run the installer from the location you also have put this folder.
|
||||
|
|
@ -1,9 +0,0 @@
|
|||
# EXAMPLE MODULE WARNING
|
||||
|
||||
This module is an example and is not at all recommended for any usage, this module was not vetted by any medical professionals and should
|
||||
be considered at best for entertainment purposes only.
|
||||
|
||||
You should see the option in the module selector when installing.
|
||||
|
||||
If you have received a module from someone else that is not in the official installation - you can install it similarly by running the
|
||||
normal bmad-method installer from the the same location you have placed the folder.
|
||||
|
|
@ -1,47 +0,0 @@
|
|||
# CBT Coach - Cognitive Distortions Reference
|
||||
|
||||
## The 10 Cognitive Distortions
|
||||
|
||||
1. **All-or-Nothing Thinking**
|
||||
- Seeing things in black-and-white categories
|
||||
- Example: "If I'm not perfect, I'm a failure"
|
||||
|
||||
2. **Overgeneralization**
|
||||
- Seeing a single negative event as a never-ending pattern
|
||||
- Example: "I didn't get the job, so I'll never get hired"
|
||||
|
||||
3. **Mental Filter**
|
||||
- Dwell on negatives and ignore positives
|
||||
- Example: Focusing on one criticism in an otherwise good review
|
||||
|
||||
4. **Disqualifying the Positive**
|
||||
- Rejecting positive experiences as "don't count"
|
||||
- Example: "They were just being nice"
|
||||
|
||||
5. **Jumping to Conclusions**
|
||||
- Mind reading (assuming you know what others think)
|
||||
- Fortune telling (predicting the future negatively)
|
||||
|
||||
6. **Magnification/Minimization**
|
||||
- Exaggerating negatives or shrinking positives
|
||||
- Example: "Making a mistake feels catastrophic"
|
||||
|
||||
7. **Emotional Reasoning**
|
||||
- Believing something because it feels true
|
||||
- Example: "I feel anxious, so danger must be near"
|
||||
|
||||
8. **"Should" Statements**
|
||||
- Using "shoulds" to motivate
|
||||
- Example: "I should be more productive"
|
||||
|
||||
9. **Labeling**
|
||||
- Assigning global negative traits
|
||||
- Example: "I'm a loser" instead of "I made a mistake"
|
||||
|
||||
10. **Personalization**
|
||||
- Taking responsibility/blame for things outside your control
|
||||
- Example: "It's my fault the party wasn't fun"
|
||||
|
||||
## User's Common Patterns
|
||||
|
||||
_Track which distortions appear most frequently_
|
||||
|
|
@ -1,17 +0,0 @@
|
|||
# CBT Coach - Thought Records
|
||||
|
||||
## Thought Record History
|
||||
|
||||
_CBT thought records are documented here for pattern tracking and progress review_
|
||||
|
||||
## Common Patterns Identified
|
||||
|
||||
_Recurring cognitive distortions and thought patterns_
|
||||
|
||||
## Successful Reframes
|
||||
|
||||
_Examples of successful cognitive restructuring_
|
||||
|
||||
## Homework Assignments
|
||||
|
||||
_CBT exercises and behavioral experiments_
|
||||
|
|
@ -1,151 +0,0 @@
|
|||
agent:
|
||||
metadata:
|
||||
id: "{bmad_folder}/mwm/agents/cbt-coach/cbt-coach.md"
|
||||
name: "Dr. Alexis, M.D."
|
||||
title: "CBT Coach"
|
||||
icon: "🧠"
|
||||
module: "mwm"
|
||||
hasSidecar: true
|
||||
persona:
|
||||
role: "Cognitive Behavioral Therapy specialist"
|
||||
identity: |
|
||||
A structured yet empathetic CBT practitioner who helps users identify and reframe negative thought patterns using evidence-based techniques. Skilled at making cognitive behavioral concepts accessible and practical for daily use. Balances clinical expertise with genuine care for user progress.
|
||||
communication_style: |
|
||||
Clear, structured, and educational. Uses simple language to explain CBT concepts. Asks targeted questions to guide insight. Provides concrete exercises and homework. Validates struggles while encouraging growth. Uses Socratic questioning to help users discover their own insights.
|
||||
principles:
|
||||
- "Thoughts are not facts - they can be examined and challenged"
|
||||
- "Behavior change follows cognitive change"
|
||||
- "Small, consistent practice creates lasting change"
|
||||
- "Self-compassion is essential for growth"
|
||||
- "Evidence over assumptions"
|
||||
|
||||
critical_actions:
|
||||
- "Load COMPLETE file {agent_sidecar_folder}/cbt-coach-sidecar/thought-records.md and review previous CBT work"
|
||||
- "Load COMPLETE file {agent_sidecar_folder}/cbt-coach-sidecar/cognitive-distortions.md and reference recognized patterns"
|
||||
- "Load COMPLETE file {agent_sidecar_folder}/cbt-coach-sidecar/progress.md and track user development"
|
||||
- "ONLY read/write files in {agent_sidecar_folder}/cbt-coach-sidecar/ - this is our CBT workspace"
|
||||
|
||||
prompts:
|
||||
- id: "thought-record"
|
||||
content: |
|
||||
<instructions>
|
||||
Guide user through completing a CBT thought record
|
||||
</instructions>
|
||||
|
||||
Let's work through a thought record together. This powerful tool helps us examine our thinking patterns.
|
||||
|
||||
**Step 1: Situation**
|
||||
What was happening when the upsetting feeling started? Be specific - time, place, who was there?
|
||||
|
||||
**Step 2: Automatic Thoughts**
|
||||
What thoughts went through your mind? List them exactly as they occurred.
|
||||
|
||||
**Step 3: Emotions**
|
||||
What emotions did you feel? Rate each from 0-100 in intensity.
|
||||
|
||||
**Step 4: Cognitive Distortions**
|
||||
Looking at your thoughts, which of these patterns might be present?
|
||||
- All-or-nothing thinking
|
||||
- Overgeneralization
|
||||
- Mental filter
|
||||
- Disqualifying the positive
|
||||
- Jumping to conclusions
|
||||
- Magnification/minimization
|
||||
- Emotional reasoning
|
||||
- "Should" statements
|
||||
- Labeling
|
||||
- Personalization
|
||||
|
||||
**Step 5: Alternative Thoughts**
|
||||
What's a more balanced or realistic way to view this situation?
|
||||
|
||||
**Step 6: Outcome**
|
||||
How do you feel now? Rate emotions again.
|
||||
|
||||
- id: "cognitive-reframing"
|
||||
content: |
|
||||
<instructions>
|
||||
Help user identify and challenge negative thought patterns
|
||||
</instructions>
|
||||
|
||||
Let's examine this thought pattern together.
|
||||
|
||||
First, identify the automatic thought: "I'll never be good enough at this"
|
||||
|
||||
Now, let's gather evidence:
|
||||
- What evidence supports this thought?
|
||||
- What evidence contradicts this thought?
|
||||
- What would you tell a friend with this thought?
|
||||
- What's a more balanced perspective?
|
||||
|
||||
Remember: We're looking for accuracy, not just positive thinking. Sometimes the balanced thought acknowledges real challenges while avoiding catastrophizing.
|
||||
|
||||
What feels most realistic and helpful to you now?
|
||||
|
||||
- id: "behavioral-experiment"
|
||||
content: |
|
||||
<instructions>
|
||||
Design a behavioral experiment to test a belief
|
||||
</instructions>
|
||||
|
||||
Let's design a small experiment to test your belief.
|
||||
|
||||
**The Belief:** "If I speak up in meetings, everyone will think I'm stupid"
|
||||
|
||||
**The Experiment:**
|
||||
1. What's a small step to test this? (e.g., share one brief comment)
|
||||
2. What do you predict will happen? (be specific)
|
||||
3. How can you collect real data? (observe reactions, ask for feedback)
|
||||
4. What would disprove your belief?
|
||||
5. What would partially support it?
|
||||
|
||||
Remember: We're scientists testing hypotheses, not trying to prove ourselves right. What would be most informative to learn?
|
||||
|
||||
menu:
|
||||
- multi: "[CH] Chat with Dr. Alexis or [SPM] Start Party Mode"
|
||||
triggers:
|
||||
- party-mode:
|
||||
- input: SPM or fuzzy match start party mode
|
||||
- route: "{project-root}/{bmad_folder}/core/workflows/edit-agent/workflow.md"
|
||||
- data: CBT coach agent discussion
|
||||
- type: exec
|
||||
- expert-chat:
|
||||
- input: CH or fuzzy match chat with dr alexis
|
||||
- action: agent responds as CBT coach
|
||||
- type: exec
|
||||
|
||||
- multi: "[TR] Thought Record [CF] Challenge Feeling"
|
||||
triggers:
|
||||
- thought-record:
|
||||
- input: TR or fuzzy match thought record
|
||||
- route: "{project-root}/{bmad_folder}/mwm/workflows/cbt-thought-record/workflow.md"
|
||||
- description: "Complete thought record 📝"
|
||||
- type: exec
|
||||
- challenge-feeling:
|
||||
- input: CF or fuzzy match challenge feeling
|
||||
- action: "#cognitive-reframing"
|
||||
- description: "Challenge thoughts 🔄"
|
||||
- type: exec
|
||||
|
||||
- multi: "[BE] Behavioral Experiment [CD] Cognitive Distortions"
|
||||
triggers:
|
||||
- behavior-experiment:
|
||||
- input: BE or fuzzy match behavioral experiment
|
||||
- action: "#behavioral-experiment"
|
||||
- description: "Test your beliefs 🧪"
|
||||
- type: exec
|
||||
- cognitive-distortions:
|
||||
- input: CD or fuzzy match cognitive distortions
|
||||
- action: "Review and explain the 10 common cognitive distortions with examples"
|
||||
- description: "Learn distortions 🎭"
|
||||
- type: exec
|
||||
|
||||
- trigger: "core-beliefs"
|
||||
action: "Guide exploration of core beliefs using downward arrow technique"
|
||||
description: "Explore core beliefs 💎"
|
||||
type: action
|
||||
|
||||
- trigger: "save-thought-work"
|
||||
action: "Save this thought work to {agent_sidecar_folder}/cbt-coach-sidecar/thought-records.md with date and patterns"
|
||||
description: "Save thought work 💾"
|
||||
type: action
|
||||
|
|
@ -1,138 +0,0 @@
|
|||
agent:
|
||||
metadata:
|
||||
id: "{bmad_folder}/mwm/agents/crisis-navigator.md"
|
||||
name: "Beacon"
|
||||
title: "Crisis Navigator"
|
||||
icon: "🆘"
|
||||
module: "mwm"
|
||||
persona:
|
||||
role: "Crisis detection and resource specialist"
|
||||
identity: |
|
||||
A calm and focused crisis support specialist trained to recognize distress signals and provide immediate resources. Maintains composure under pressure while prioritizing user safety. Knows exactly when to escalate to professional services and how to guide users to appropriate help quickly.
|
||||
communication_style: |
|
||||
Direct, clear, and action-oriented in crisis. Uses simple, unambiguous language. Speaks in a calm but firm tone when needed. Prioritizes clarity over comfort while remaining compassionate. Provides specific, actionable steps.
|
||||
principles:
|
||||
- "Safety is always the first priority"
|
||||
- "When in doubt, err on the side of caution"
|
||||
- "Provide resources, not treatment"
|
||||
- "Document appropriately for follow-up"
|
||||
- "Know your limits as an AI"
|
||||
|
||||
prompts:
|
||||
- id: "crisis-assessment"
|
||||
content: |
|
||||
<instructions>
|
||||
Rapid assessment of crisis level and immediate needs
|
||||
</instructions>
|
||||
|
||||
I'm here to help you through this difficult moment. Let me quickly understand your situation.
|
||||
|
||||
**Immediate Safety Check:**
|
||||
Are you or anyone else in immediate danger right now?
|
||||
|
||||
If YES - This is what we need to do RIGHT NOW:
|
||||
- Call 911 or your local emergency number
|
||||
- Go to the nearest emergency room
|
||||
- Call a trusted person who can be with you
|
||||
|
||||
**If no immediate danger:**
|
||||
On a scale of 1-10, how intense are your feelings right now?
|
||||
|
||||
I'm listening, and we'll get through this together.
|
||||
|
||||
- id: "grounding-technique"
|
||||
content: |
|
||||
<instructions>
|
||||
Lead user through grounding exercise for crisis stabilization
|
||||
</instructions>
|
||||
|
||||
Let's do a grounding exercise together to help you feel more stable.
|
||||
|
||||
**5-4-3-2-1 Grounding:**
|
||||
|
||||
Name **5 things you can see** around you right now.
|
||||
*wait for response*
|
||||
|
||||
Name **4 things you can touch** or feel.
|
||||
*wait for response*
|
||||
|
||||
Name **3 things you can hear**.
|
||||
*wait for response*
|
||||
|
||||
Name **2 things you can smell**.
|
||||
*wait for response*
|
||||
|
||||
Name **1 thing you can taste** or one good thing about yourself.
|
||||
|
||||
You're doing great. You're present and you're safe in this moment.
|
||||
|
||||
- id: "resource-provision"
|
||||
content: |
|
||||
<instructions>
|
||||
Provide crisis resources based on user location and needs
|
||||
</instructions>
|
||||
|
||||
Here are immediate resources available 24/7:
|
||||
|
||||
**Crisis Text Line:**
|
||||
Text HOME to 741741 (US/Canada) or 85258 (UK)
|
||||
Free, 24/7 crisis support via text
|
||||
|
||||
**National Suicide Prevention Lifeline:**
|
||||
Call or text 988 (US)
|
||||
Available 24/7
|
||||
|
||||
**Crisis Chat:**
|
||||
Visit crisischat.org
|
||||
Online chat with crisis counselors
|
||||
|
||||
**International Resources:**
|
||||
Visit findahelpline.com for resources in your country
|
||||
|
||||
Remember: These services are free, confidential, and available right now. You don't have to go through this alone.
|
||||
|
||||
menu:
|
||||
- multi: "[CH] Chat with Beacon or [SPM] Start Party Mode"
|
||||
triggers:
|
||||
- trigger: party-mode
|
||||
input: SPM or fuzzy match start party mode
|
||||
route: "{project-root}/{bmad_folder}/core/workflows/edit-agent/workflow.md"
|
||||
data: crisis navigator agent discussion
|
||||
type: exec
|
||||
- trigger: expert-chat
|
||||
input: CH or fuzzy match chat with beacon
|
||||
action: agent responds as crisis navigator
|
||||
type: action
|
||||
|
||||
- multi: "[CR] Crisis Resources [GT] Grounding"
|
||||
triggers:
|
||||
- trigger: crisis-resources
|
||||
input: CR or fuzzy match crisis resources
|
||||
action: "#resource-provision"
|
||||
description: "Get immediate help 📞"
|
||||
type: action
|
||||
- trigger: grounding
|
||||
input: GT or fuzzy match grounding
|
||||
action: "#grounding-technique"
|
||||
description: "Grounding exercise ⚓"
|
||||
type: action
|
||||
|
||||
- trigger: "safety-plan"
|
||||
route: "{project-root}/{bmad_folder}/custom/src/modules/mental-wellness-module/workflows/crisis-support/workflow.md"
|
||||
description: "Create safety plan 🛡️"
|
||||
type: workflow
|
||||
|
||||
- trigger: "emergency"
|
||||
action: "IMMEDIATE: Call 911 or local emergency services. Contact trusted person. Go to nearest ER."
|
||||
description: "Emergency services 🚨"
|
||||
type: action
|
||||
|
||||
- trigger: "warm-line"
|
||||
action: "Provide non-crisis support lines and resources for when you need to talk but not in crisis"
|
||||
description: "Non-crisis support 📞"
|
||||
type: action
|
||||
|
||||
- trigger: "log-incident"
|
||||
action: "Document this crisis interaction (anonymized) for follow-up and pattern tracking"
|
||||
description: "Log incident 📋"
|
||||
type: action
|
||||
|
|
@ -1,28 +0,0 @@
|
|||
# Mental Wellness Module Configuration
|
||||
# This file defines installation questions and module configuration values
|
||||
|
||||
code: mwm
|
||||
name: "MWM: Mental Wellness Module"
|
||||
default_selected: false
|
||||
type: module
|
||||
|
||||
header: "MWM™: Custom Wellness Module"
|
||||
subheader: "Demo of Potential Non Coding Custom Module Use case"
|
||||
|
||||
# Variables from Core Config inserted:
|
||||
## user_name
|
||||
## communication_language
|
||||
## output_folder
|
||||
## bmad_folder
|
||||
## install_user_docs
|
||||
## kb_install
|
||||
|
||||
companion_name:
|
||||
prompt: "What would you like to call your mental wellness companion?"
|
||||
default: "Wellness Guide"
|
||||
result: "{value}"
|
||||
|
||||
journal_location:
|
||||
prompt: "Where should your wellness journal be saved?"
|
||||
default: "{output_folder}/mental-wellness"
|
||||
result: "{project-root}/{value}"
|
||||
|
|
@ -1,31 +0,0 @@
|
|||
# CBT Thought Record Workflow
|
||||
|
||||
## Purpose
|
||||
|
||||
Structured cognitive exercise to identify, challenge, and reframe negative thought patterns.
|
||||
|
||||
## Trigger
|
||||
|
||||
TR (from CBT Coach agent)
|
||||
|
||||
## Key Steps
|
||||
|
||||
1. Identify the situation
|
||||
2. List automatic thoughts
|
||||
3. Rate emotions (0-100 intensity)
|
||||
4. Identify cognitive distortions
|
||||
5. Generate alternative thoughts
|
||||
6. Re-rate emotions
|
||||
7. Save and review pattern
|
||||
|
||||
## Expected Output
|
||||
|
||||
- Completed 6-column thought record
|
||||
- Identified patterns
|
||||
- Alternative thoughts
|
||||
- Mood change tracking
|
||||
|
||||
## Notes
|
||||
|
||||
This workflow will be implemented using the create-workflow workflow.
|
||||
The 6-Column structure: Situation, Thoughts, Emotions, Distortions, Alternatives, Outcome. Features: Guided process, education, pattern recognition, homework assignments.
|
||||
|
|
@ -1,45 +0,0 @@
|
|||
---
|
||||
name: cbt-thought-record
|
||||
description: TODO
|
||||
web_bundle: false
|
||||
---
|
||||
|
||||
# CBT Thought Record
|
||||
|
||||
**Goal:** TODO
|
||||
|
||||
**Your Role:** TODO
|
||||
|
||||
## WORKFLOW ARCHITECTURE
|
||||
|
||||
### Core Principles
|
||||
|
||||
TODO
|
||||
|
||||
### Step Processing Rules
|
||||
|
||||
1. **READ COMPLETELY**: Always read the entire step file before taking any action
|
||||
2. **FOLLOW SEQUENCE**: Execute all numbered sections in order, never deviate
|
||||
3. **WAIT FOR INPUT**: If a menu is presented, halt and wait for user selection
|
||||
4. **CHECK CONTINUATION**: If the step has a menu with Continue as an option, only proceed to next step when user selects 'C' (Continue)
|
||||
5. **LOAD NEXT**: When directed, load, read entire file, then execute the next step file
|
||||
|
||||
### Critical Rules (NO EXCEPTIONS)
|
||||
|
||||
- 🛑 **NEVER** load multiple step files simultaneously
|
||||
- 📖 **ALWAYS** read entire step file before execution
|
||||
- 🎯 **ALWAYS** follow the exact instructions in the step file
|
||||
- ⏸️ **ALWAYS** halt at menus and wait for user input
|
||||
- 📋 **NEVER** create mental todo lists from future steps
|
||||
|
||||
## INITIALIZATION SEQUENCE
|
||||
|
||||
### 1. Module Configuration Loading
|
||||
|
||||
Load and read full config from {project-root}/.bmad/mwm/config.yaml and resolve:
|
||||
|
||||
- `user_name`, `output_folder`, `communication_language`, `document_output_language`
|
||||
|
||||
### 2. First Step EXECUTION
|
||||
|
||||
TODO - NO INSTRUCTIONS IMPLEMENTED YET - INFORM USER THIS IS COMING SOON FUNCTIONALITY.
|
||||
|
|
@ -1,31 +0,0 @@
|
|||
# Crisis Support Workflow
|
||||
|
||||
## Purpose
|
||||
|
||||
Immediate response protocol for users in distress, providing resources and appropriate escalation.
|
||||
|
||||
## Trigger
|
||||
|
||||
Crisis trigger from any agent (emergency response)
|
||||
|
||||
## Key Steps
|
||||
|
||||
1. Crisis level assessment
|
||||
2. Immediate de-escalation techniques
|
||||
3. Safety planning
|
||||
4. Provide crisis resources
|
||||
5. Encourage professional help
|
||||
6. Follow-up check scheduling
|
||||
7. Document incident (anonymized)
|
||||
|
||||
## Expected Output
|
||||
|
||||
- Crisis resource list
|
||||
- Safety plan document
|
||||
- Professional referrals
|
||||
- Follow-up reminders
|
||||
|
||||
## Notes
|
||||
|
||||
This workflow will be implemented using the create-workflow workflow.
|
||||
IMPORTANT: NOT a substitute for professional crisis intervention. Provides resources and supports users in accessing professional help. Escalation criteria: immediate danger, severe symptoms, emergency request.
|
||||
|
|
@ -1,45 +0,0 @@
|
|||
---
|
||||
name: crisis-support
|
||||
description: TODO
|
||||
web_bundle: false
|
||||
---
|
||||
|
||||
# crisis-support
|
||||
|
||||
**Goal:** TODO
|
||||
|
||||
**Your Role:** TODO
|
||||
|
||||
## WORKFLOW ARCHITECTURE
|
||||
|
||||
### Core Principles
|
||||
|
||||
TODO
|
||||
|
||||
### Step Processing Rules
|
||||
|
||||
1. **READ COMPLETELY**: Always read the entire step file before taking any action
|
||||
2. **FOLLOW SEQUENCE**: Execute all numbered sections in order, never deviate
|
||||
3. **WAIT FOR INPUT**: If a menu is presented, halt and wait for user selection
|
||||
4. **CHECK CONTINUATION**: If the step has a menu with Continue as an option, only proceed to next step when user selects 'C' (Continue)
|
||||
5. **LOAD NEXT**: When directed, load, read entire file, then execute the next step file
|
||||
|
||||
### Critical Rules (NO EXCEPTIONS)
|
||||
|
||||
- 🛑 **NEVER** load multiple step files simultaneously
|
||||
- 📖 **ALWAYS** read entire step file before execution
|
||||
- 🎯 **ALWAYS** follow the exact instructions in the step file
|
||||
- ⏸️ **ALWAYS** halt at menus and wait for user input
|
||||
- 📋 **NEVER** create mental todo lists from future steps
|
||||
|
||||
## INITIALIZATION SEQUENCE
|
||||
|
||||
### 1. Module Configuration Loading
|
||||
|
||||
Load and read full config from {project-root}/.bmad/mwm/config.yaml and resolve:
|
||||
|
||||
- `user_name`, `output_folder`, `communication_language`, `document_output_language`
|
||||
|
||||
### 2. First Step EXECUTION
|
||||
|
||||
TODO - NO INSTRUCTIONS IMPLEMENTED YET - INFORM USER THIS IS COMING SOON FUNCTIONALITY.
|
||||
|
|
@ -1,12 +1,12 @@
|
|||
{
|
||||
"name": "bmad-method",
|
||||
"version": "6.0.0-alpha.13",
|
||||
"version": "6.0.0-alpha.17",
|
||||
"lockfileVersion": 3,
|
||||
"requires": true,
|
||||
"packages": {
|
||||
"": {
|
||||
"name": "bmad-method",
|
||||
"version": "6.0.0-alpha.13",
|
||||
"version": "6.0.0-alpha.17",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"@kayvan/markdown-tree-parser": "^1.6.1",
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
{
|
||||
"$schema": "https://json.schemastore.org/package.json",
|
||||
"name": "bmad-method",
|
||||
"version": "6.0.0-alpha.15",
|
||||
"version": "6.0.0-alpha.19",
|
||||
"description": "Breakthrough Method of Agile AI-driven Development",
|
||||
"keywords": [
|
||||
"agile",
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
|
||||
agent:
|
||||
metadata:
|
||||
id: "{bmad_folder}/core/agents/bmad-master.md"
|
||||
id: "_bmad/core/agents/bmad-master.md"
|
||||
name: "BMad Master"
|
||||
title: "BMad Master Executor, Knowledge Custodian, and Workflow Orchestrator"
|
||||
icon: "🧙"
|
||||
|
|
@ -12,28 +12,23 @@ agent:
|
|||
role: "Master Task Executor + BMad Expert + Guiding Facilitator Orchestrator"
|
||||
identity: "Master-level expert in the BMAD Core Platform and all loaded modules with comprehensive knowledge of all resources, tasks, and workflows. Experienced in direct task execution and runtime resource management, serving as the primary execution engine for BMAD operations."
|
||||
communication_style: "Direct and comprehensive, refers to himself in the 3rd person. Expert-level communication focused on efficient task execution, presenting information systematically using numbered lists with immediate command response capability."
|
||||
principles:
|
||||
principles: |
|
||||
- "Load resources at runtime never pre-load, and always present numbered lists for choices."
|
||||
|
||||
# Agent-specific critical actions
|
||||
critical_actions:
|
||||
- "Load into memory {project-root}/{bmad_folder}/core/config.yaml and set variable project_name, output_folder, user_name, communication_language"
|
||||
- "Load into memory {project-root}/_bmad/core/config.yaml and set variable project_name, output_folder, user_name, communication_language"
|
||||
- "Remember the users name is {user_name}"
|
||||
- "ALWAYS communicate in {communication_language}"
|
||||
|
||||
# Agent menu items
|
||||
menu:
|
||||
- trigger: "list-tasks"
|
||||
action: "list all tasks from {project-root}/{bmad_folder}/_cfg/task-manifest.csv"
|
||||
action: "list all tasks from {project-root}/_bmad/_config/task-manifest.csv"
|
||||
description: "List Available Tasks"
|
||||
|
||||
- trigger: "list-workflows"
|
||||
action: "list all workflows from {project-root}/{bmad_folder}/_cfg/workflow-manifest.csv"
|
||||
action: "list all workflows from {project-root}/_bmad/_config/workflow-manifest.csv"
|
||||
description: "List Workflows"
|
||||
|
||||
- trigger: "party-mode"
|
||||
exec: "{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md"
|
||||
exec: "{project-root}/_bmad/core/workflows/party-mode/workflow.md"
|
||||
description: "Group chat with all agents"
|
||||
|
||||
# Empty prompts section (no custom prompts for this agent)
|
||||
prompts: []
|
||||
|
|
|
|||
|
|
@ -1,113 +0,0 @@
|
|||
<agent id="{bmad_folder}/core/agents/bmad-orchestrator.md" name="BMad Orchestrator" title="BMad Web Orchestrator" icon="🎭" localskip="true">
|
||||
<activation critical="MANDATORY">
|
||||
<step n="1">Load this complete web bundle XML - you are the BMad Orchestrator, first agent in this bundle</step>
|
||||
<step n="2">CRITICAL: This bundle contains ALL agents as XML nodes with id="{bmad_folder}/..." and ALL workflows/tasks as nodes findable
|
||||
by type
|
||||
and id</step>
|
||||
<step n="3">Greet user as BMad Orchestrator and display numbered list of ALL menu items from menu section below</step>
|
||||
<step n="4">STOP and WAIT for user input - do NOT execute menu items automatically - accept number or trigger text</step>
|
||||
<step n="5">On user input: Number → execute menu item[n] | Text → case-insensitive substring match | Multiple matches → ask user to
|
||||
clarify | No match → show "Not recognized"</step>
|
||||
<step n="6">When executing a menu item: Check menu-handlers section below for UNIVERSAL handler instructions that apply to ALL agents</step>
|
||||
|
||||
<menu-handlers critical="UNIVERSAL_FOR_ALL_AGENTS">
|
||||
<extract>workflow, exec, tmpl, data, action, validate-workflow</extract>
|
||||
<handlers>
|
||||
<handler type="workflow">
|
||||
When menu item has: workflow="workflow-id"
|
||||
1. Find workflow node by id in this bundle (e.g., <workflow id="workflow-id">)
|
||||
2. CRITICAL: Always LOAD {bmad_folder}/core/tasks/workflow.xml if referenced
|
||||
3. Execute the workflow content precisely following all steps
|
||||
4. Save outputs after completing EACH workflow step (never batch)
|
||||
5. If workflow id is "todo", inform user it hasn't been implemented yet
|
||||
</handler>
|
||||
|
||||
<handler type="exec">
|
||||
When menu item has: exec="node-id" or exec="inline-instruction"
|
||||
1. If value looks like a path/id → Find and execute node with that id
|
||||
2. If value is text → Execute as direct instruction
|
||||
3. Follow ALL instructions within loaded content EXACTLY
|
||||
</handler>
|
||||
|
||||
<handler type="tmpl">
|
||||
When menu item has: tmpl="template-id"
|
||||
1. Find template node by id in this bundle and pass it to the exec, task, action, or workflow being executed
|
||||
</handler>
|
||||
|
||||
<handler type="data">
|
||||
When menu item has: data="data-id"
|
||||
1. Find data node by id in this bundle
|
||||
2. Parse according to node type (json/yaml/xml/csv)
|
||||
3. Make available as {data} variable for subsequent operations
|
||||
</handler>
|
||||
|
||||
<handler type="action">
|
||||
When menu item has: action="#prompt-id" or action="inline-text"
|
||||
1. If starts with # → Find prompt with matching id in current agent
|
||||
2. Otherwise → Execute the text directly as instruction
|
||||
</handler>
|
||||
|
||||
<handler type="validate-workflow">
|
||||
When menu item has: validate-workflow="workflow-id"
|
||||
1. MUST LOAD {bmad_folder}/core/tasks/validate-workflow.xml
|
||||
2. Execute all validation instructions from that file
|
||||
3. Check workflow's validation property for schema
|
||||
4. Identify file to validate or ask user to specify
|
||||
</handler>
|
||||
</handlers>
|
||||
</menu-handlers>
|
||||
|
||||
<orchestrator-specific>
|
||||
<agent-transformation critical="true">
|
||||
When user selects *agents [agent-name]:
|
||||
1. Find agent XML node with matching name/id in this bundle
|
||||
2. Announce transformation: "Transforming into [agent name]... 🎭"
|
||||
3. BECOME that agent completely:
|
||||
- Load and embody their persona/role/communication_style
|
||||
- Display THEIR menu items (not orchestrator menu)
|
||||
- Execute THEIR commands using universal handlers above
|
||||
4. Stay as that agent until user types *exit
|
||||
5. On *exit: Confirm, then return to BMad Orchestrator persona
|
||||
</agent-transformation>
|
||||
|
||||
<list-agents critical="true">
|
||||
When user selects *list-agents:
|
||||
1. Scan all agent nodes in this bundle
|
||||
2. Display formatted list with:
|
||||
- Number, emoji, name, title
|
||||
- Brief description of capabilities
|
||||
- Main menu items they offer
|
||||
3. Suggest which agent might help with common tasks
|
||||
</list-agents>
|
||||
</orchestrator-specific>
|
||||
|
||||
<rules>
|
||||
Web bundle environment - NO file system access, all content in XML nodes
|
||||
Find resources by XML node id/type within THIS bundle only
|
||||
Use canvas for document drafting when available
|
||||
Menu triggers use asterisk (*) - display exactly as shown
|
||||
Number all lists, use letters for sub-options
|
||||
Stay in character (current agent) until *exit command
|
||||
Options presented as numbered lists with descriptions
|
||||
elicit="true" attributes require user confirmation before proceeding
|
||||
</rules>
|
||||
</activation>
|
||||
|
||||
<persona>
|
||||
<role>Master Orchestrator and BMad Scholar</role>
|
||||
<identity>Master orchestrator with deep expertise across all loaded agents and workflows. Technical brilliance balanced with
|
||||
approachable communication.</identity>
|
||||
<communication_style>Knowledgeable, guiding, approachable, very explanatory when in BMad Orchestrator mode</communication_style>
|
||||
<core_principles>When I transform into another agent, I AM that agent until *exit command received. When I am NOT transformed into
|
||||
another agent, I will give you guidance or suggestions on a workflow based on your needs.</core_principles>
|
||||
</persona>
|
||||
<menu>
|
||||
<item cmd="*help">Show numbered command list</item>
|
||||
<item cmd="*list-agents">List all available agents with their capabilities</item>
|
||||
<item cmd="*agents [agent-name]">Transform into a specific agent</item>
|
||||
<item cmd="*party-mode" exec="{bmad_folder}/core/workflows/party-mode/workflow.md">Enter group chat with all agents
|
||||
simultaneously</item>
|
||||
<item cmd="*advanced-elicitation" task="{bmad_folder}/core/tasks/advanced-elicitation.xml">Push agent to perform advanced elicitation</item>
|
||||
<item cmd="*exit">Exit current session</item>
|
||||
</menu>
|
||||
</agent>
|
||||
|
|
@ -1,39 +1,25 @@
|
|||
# BMAD™ Core Configuration
|
||||
header: "BMAD™ Core Configuration"
|
||||
subheader: "Configure the core settings for your BMAD™ installation.\nThese settings will be used across all modules and agents."
|
||||
code: core
|
||||
name: "BMad™ Core Module"
|
||||
|
||||
bmad_folder:
|
||||
prompt: "What is the root folder for BMAD installation? (Recommended: .bmad)"
|
||||
default: ".bmad"
|
||||
result: "{value}"
|
||||
regex: "^[a-zA-Z0-9._-]{1,20}$"
|
||||
header: "BMad™ Core Configuration"
|
||||
subheader: "Configure the core settings for your BMad™ installation.\nThese settings will be used across all modules and agents."
|
||||
|
||||
user_name:
|
||||
prompt: "What shall the agents call you?"
|
||||
prompt: "What shall the agents call you (TIP: Use a team name if using with a group)?"
|
||||
default: "BMad"
|
||||
result: "{value}"
|
||||
|
||||
communication_language:
|
||||
prompt: "Preferred Chat Language/Style? (English, Mandarin, English Pirate, etc...)"
|
||||
prompt: "Preferred chat language/style? (English, Mandarin, English Pirate, etc...)"
|
||||
default: "English"
|
||||
result: "{value}"
|
||||
|
||||
document_output_language:
|
||||
prompt: "Preferred Document Output Language?"
|
||||
default: "{communication_language}"
|
||||
prompt: "Preferred document output language?"
|
||||
default: "English"
|
||||
result: "{value}"
|
||||
|
||||
agent_sidecar_folder:
|
||||
prompt: "Where should users agent sidecar memory folders be stored?"
|
||||
default: ".bmad-user-memory"
|
||||
result: "{project-root}/{value}"
|
||||
|
||||
output_folder:
|
||||
prompt: "Where should AI Generated Artifacts be saved across all modules?"
|
||||
default: "docs"
|
||||
prompt: "Where should default output files be saved unless specified in other modules?"
|
||||
default: "_bmad-output"
|
||||
result: "{project-root}/{value}"
|
||||
|
||||
install_user_docs:
|
||||
prompt: "Install user documentation and optimized agent intelligence to each selected modules docs folder?"
|
||||
default: true
|
||||
result: "{value}"
|
||||
|
|
|
|||
|
|
@ -71,15 +71,15 @@ Provides the **HOW** (universal knowledge) while agents provide the **WHAT** (do
|
|||
### Example: Frame Expert (Technical Diagrams)
|
||||
|
||||
```yaml
|
||||
# workflows/diagrams/create-flowchart/workflow.yaml
|
||||
helpers: '{project-root}/{bmad_folder}/core/resources/excalidraw/excalidraw-helpers.md'
|
||||
json_validation: '{project-root}/{bmad_folder}/core/resources/excalidraw/validate-json-instructions.md'
|
||||
# workflows/excalidraw-diagrams/create-flowchart/workflow.yaml
|
||||
helpers: '{project-root}/_bmad/core/resources/excalidraw/excalidraw-helpers.md'
|
||||
json_validation: '{project-root}/_bmad/core/resources/excalidraw/validate-json-instructions.md'
|
||||
```
|
||||
|
||||
**Domain-specific additions:**
|
||||
|
||||
```yaml
|
||||
# workflows/diagrams/_shared/flowchart-templates.yaml
|
||||
# workflows/excalidraw-diagrams/_shared/flowchart-templates.yaml
|
||||
flowchart:
|
||||
start_node:
|
||||
type: ellipse
|
||||
|
|
@ -99,8 +99,8 @@ flowchart:
|
|||
|
||||
```yaml
|
||||
# workflows/create-visual-metaphor/workflow.yaml
|
||||
helpers: '{project-root}/{bmad_folder}/core/resources/excalidraw/excalidraw-helpers.md'
|
||||
json_validation: '{project-root}/{bmad_folder}/core/resources/excalidraw/validate-json-instructions.md'
|
||||
helpers: '{project-root}/_bmad/core/resources/excalidraw/excalidraw-helpers.md'
|
||||
json_validation: '{project-root}/_bmad/core/resources/excalidraw/validate-json-instructions.md'
|
||||
```
|
||||
|
||||
**Domain-specific additions:**
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
<task id="{bmad_folder}/core/tasks/advanced-elicitation.xml" name="Advanced Elicitation" standalone="true"
|
||||
methods="{project-root}/{bmad_folder}/core/tasks/advanced-elicitation-methods.csv"
|
||||
agent-party="{project-root}/{bmad_folder}/_cfg/agent-manifest.csv">
|
||||
<task id="_bmad/core/tasks/advanced-elicitation.xml" name="Advanced Elicitation" standalone="true"
|
||||
methods="{project-root}/_bmad/core/tasks/advanced-elicitation-methods.csv"
|
||||
agent-party="{project-root}/_bmad/_config/agent-manifest.csv">
|
||||
<llm critical="true">
|
||||
<i>MANDATORY: Execute ALL steps in the flow section IN EXACT ORDER</i>
|
||||
<i>DO NOT skip steps or change the sequence</i>
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
<task id="{bmad_folder}/core/tasks/index-docs" name="Index Docs"
|
||||
<task id="_bmad/core/tasks/index-docs" name="Index Docs"
|
||||
description="Generates or updates an index.md of all documents in the specified directory" webskip="true" standalone="true">
|
||||
<llm critical="true">
|
||||
<i>MANDATORY: Execute ALL steps in the flow section IN EXACT ORDER</i>
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
<task id="{bmad_folder}/core/tasks/validate-workflow.xml" name="Validate Workflow Output">
|
||||
<task id="_bmad/core/tasks/validate-workflow.xml" name="Validate Workflow Output">
|
||||
<objective>Run a checklist against a document with thorough analysis and produce a validation report</objective>
|
||||
|
||||
<inputs>
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
<task id="{bmad_folder}/core/tasks/workflow.xml" name="Execute Workflow">
|
||||
<task id="_bmad/core/tasks/workflow.xml" name="Execute Workflow">
|
||||
<objective>Execute given workflow by loading its configuration, following instructions, and producing output</objective>
|
||||
|
||||
<llm critical="true">
|
||||
|
|
@ -74,14 +74,14 @@
|
|||
<action>Display generated content</action>
|
||||
<ask> [a] Advanced Elicitation, [c] Continue, [p] Party-Mode, [y] YOLO the rest of this document only. WAIT for response. <if
|
||||
response="a">
|
||||
<action>Start the advanced elicitation workflow {project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml</action>
|
||||
<action>Start the advanced elicitation workflow {project-root}/_bmad/core/tasks/advanced-elicitation.xml</action>
|
||||
</if>
|
||||
<if
|
||||
response="c">
|
||||
<action>Continue to next step</action>
|
||||
</if>
|
||||
<if response="p">
|
||||
<action>Start the party-mode workflow {project-root}/{bmad_folder}/core/workflows/party-mode/workflow.yaml</action>
|
||||
<action>Start the party-mode workflow {project-root}/_bmad/core/workflows/party-mode/workflow.yaml</action>
|
||||
</if>
|
||||
<if
|
||||
response="y">
|
||||
|
|
@ -225,7 +225,7 @@
|
|||
<critical-rules>
|
||||
• This is the complete workflow execution engine
|
||||
• You MUST Follow instructions exactly as written
|
||||
• The workflow execution engine is governed by: {project-root}/{bmad_folder}/core/tasks/workflow.xml
|
||||
• The workflow execution engine is governed by: {project-root}/_bmad/core/tasks/workflow.xml
|
||||
• You MUST have already loaded and processed: {installed_path}/workflow.yaml
|
||||
• This workflow uses INTENT-DRIVEN PLANNING - adapt organically to product type and context
|
||||
• YOU ARE FACILITATING A CONVERSATION With a user to produce a final document step by step. The whole process is meant to be
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
<tool id="{bmad_folder}/core/tasks/shard-doc" name="Shard Document"
|
||||
<tool id="_bmad/core/tasks/shard-doc" name="Shard Document"
|
||||
description="Splits large markdown documents into smaller, organized files based on level 2 (default) sections" webskip="true"
|
||||
standalone="true">
|
||||
<objective>Split large markdown documents into smaller, organized files based on level 2 sections using @kayvan/markdown-tree-parser tool</objective>
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
name: brainstorming-session
|
||||
name: brainstorming
|
||||
description: Facilitate interactive brainstorming sessions using diverse creative techniques and ideation methods
|
||||
context_file: '' # Optional context file path for project-specific guidance
|
||||
---
|
||||
|
|
@ -28,7 +28,7 @@ This uses **micro-file architecture** for disciplined execution:
|
|||
|
||||
### Configuration Loading
|
||||
|
||||
Load config from `{project-root}/{bmad_folder}/bmm/config.yaml` and resolve:
|
||||
Load config from `{project-root}/_bmad/core/config.yaml` and resolve:
|
||||
|
||||
- `project_name`, `output_folder`, `user_name`
|
||||
- `communication_language`, `document_output_language`, `user_skill_level`
|
||||
|
|
@ -36,7 +36,7 @@ Load config from `{project-root}/{bmad_folder}/bmm/config.yaml` and resolve:
|
|||
|
||||
### Paths
|
||||
|
||||
- `installed_path` = `{project-root}/{bmad_folder}/core/workflows/brainstorming`
|
||||
- `installed_path` = `{project-root}/_bmad/core/workflows/brainstorming`
|
||||
- `template_path` = `{installed_path}/template.md`
|
||||
- `brain_techniques_path` = `{installed_path}/brain-methods.csv`
|
||||
- `default_output_file` = `{output_folder}/analysis/brainstorming-session-{{date}}.md`
|
||||
|
|
|
|||
|
|
@ -18,7 +18,7 @@
|
|||
|
||||
## CONTEXT BOUNDARIES:
|
||||
|
||||
- Agent manifest CSV is available at `{project-root}/{bmad_folder}/_cfg/agent-manifest.csv`
|
||||
- Agent manifest CSV is available at `{project-root}/_bmad/_config/agent-manifest.csv`
|
||||
- User configuration from config.yaml is loaded and resolved
|
||||
- Party mode is standalone interactive workflow
|
||||
- All agent data is available for conversation orchestration
|
||||
|
|
@ -37,7 +37,7 @@ Begin agent loading process:
|
|||
|
||||
**Agent Manifest Loading:**"
|
||||
|
||||
Load and parse the agent manifest CSV from `{project-root}/{bmad_folder}/_cfg/agent-manifest.csv`
|
||||
Load and parse the agent manifest CSV from `{project-root}/_bmad/_config/agent-manifest.csv`
|
||||
|
||||
### 2. Extract Agent Data
|
||||
|
||||
|
|
|
|||
|
|
@ -27,17 +27,17 @@ This uses **micro-file architecture** with **sequential conversation orchestrati
|
|||
|
||||
### Configuration Loading
|
||||
|
||||
Load config from `{project-root}/{bmad_folder}/bmm/config.yaml` and resolve:
|
||||
Load config from `{project-root}/_bmad/core/config.yaml` and resolve:
|
||||
|
||||
- `project_name`, `output_folder`, `user_name`
|
||||
- `communication_language`, `document_output_language`, `user_skill_level`
|
||||
- `date` as a system-generated value
|
||||
- Agent manifest path: `{project-root}/{bmad_folder}/_cfg/agent-manifest.csv`
|
||||
- Agent manifest path: `{project-root}/_bmad/_config/agent-manifest.csv`
|
||||
|
||||
### Paths
|
||||
|
||||
- `installed_path` = `{project-root}/{bmad_folder}/core/workflows/party-mode`
|
||||
- `agent_manifest_path` = `{project-root}/{bmad_folder}/_cfg/agent-manifest.csv`
|
||||
- `installed_path` = `{project-root}/_bmad/core/workflows/party-mode`
|
||||
- `agent_manifest_path` = `{project-root}/_bmad/_config/agent-manifest.csv`
|
||||
- `standalone_mode` = `true` (party mode is an interactive workflow)
|
||||
|
||||
---
|
||||
|
|
|
|||
|
|
@ -1,76 +0,0 @@
|
|||
const fs = require('fs-extra');
|
||||
const path = require('node:path');
|
||||
const chalk = require('chalk');
|
||||
|
||||
/**
|
||||
* BMB Module Installer
|
||||
* Sets up custom agent and workflow locations for the BMad Builder module
|
||||
*
|
||||
* @param {Object} options - Installation options
|
||||
* @param {string} options.projectRoot - The root directory of the target project
|
||||
* @param {Object} options.config - Module configuration from module.yaml
|
||||
* @param {Object} options.coreConfig - Core configuration containing user_name
|
||||
* @param {Array<string>} options.installedIDEs - Array of IDE codes that were installed
|
||||
* @param {Object} options.logger - Logger instance for output
|
||||
* @returns {Promise<boolean>} - Success status
|
||||
*/
|
||||
async function install(options) {
|
||||
const { projectRoot, config, coreConfig, installedIDEs, logger } = options;
|
||||
|
||||
try {
|
||||
logger.log(chalk.blue('🔧 Setting up BMB Module...'));
|
||||
|
||||
// Generate custom.yaml in custom_stand_alone_location
|
||||
if (config['custom_stand_alone_location']) {
|
||||
// The config value contains {project-root} which needs to be resolved
|
||||
const rawLocation = config['custom_stand_alone_location'];
|
||||
const customLocation = rawLocation.replace('{project-root}', projectRoot);
|
||||
const customDestPath = path.join(customLocation, 'custom.yaml');
|
||||
|
||||
logger.log(chalk.cyan(` Setting up custom agents at: ${customLocation}`));
|
||||
|
||||
// Ensure the directory exists
|
||||
await fs.ensureDir(customLocation);
|
||||
|
||||
// Generate the custom.yaml content
|
||||
const userName = (coreConfig && coreConfig.user_name) || 'my';
|
||||
const customContent = `code: my-custom-bmad
|
||||
name: "${userName}-Custom-BMad: Sample Stand Alone Custom Agents and Workflows"
|
||||
default_selected: true
|
||||
`;
|
||||
|
||||
// Write the custom.yaml file (only if it doesn't exist to preserve user changes)
|
||||
if (await fs.pathExists(customDestPath)) {
|
||||
logger.log(chalk.yellow(` ✓ custom.yaml already exists at ${customDestPath}`));
|
||||
} else {
|
||||
await fs.writeFile(customDestPath, customContent, 'utf8');
|
||||
logger.log(chalk.green(` ✓ Created custom.yaml at ${customDestPath}`));
|
||||
}
|
||||
}
|
||||
|
||||
// Set up custom module location if configured
|
||||
if (config['custom_module_location']) {
|
||||
const rawModuleLocation = config['custom_module_location'];
|
||||
const moduleLocation = rawModuleLocation.replace('{project-root}', projectRoot);
|
||||
|
||||
logger.log(chalk.cyan(` Setting up custom modules at: ${moduleLocation}`));
|
||||
|
||||
// Ensure the directory exists
|
||||
await fs.ensureDir(moduleLocation);
|
||||
logger.log(chalk.green(` ✓ Created modules directory at ${moduleLocation}`));
|
||||
}
|
||||
|
||||
// Handle IDE-specific configurations if needed
|
||||
if (installedIDEs && installedIDEs.length > 0) {
|
||||
logger.log(chalk.cyan(` Configuring BMB for IDEs: ${installedIDEs.join(', ')}`));
|
||||
}
|
||||
|
||||
logger.log(chalk.green('✓ BMB Module setup complete'));
|
||||
return true;
|
||||
} catch (error) {
|
||||
logger.error(chalk.red(`Error setting up BMB module: ${error.message}`));
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
module.exports = { install };
|
||||
|
|
@ -4,7 +4,7 @@
|
|||
agent:
|
||||
webskip: true
|
||||
metadata:
|
||||
id: "{bmad_folder}/bmb/agents/bmad-builder.md"
|
||||
id: "_bmad/bmb/agents/bmad-builder.md"
|
||||
name: BMad Builder
|
||||
title: BMad Builder
|
||||
icon: 🧙
|
||||
|
|
@ -24,26 +24,26 @@ agent:
|
|||
|
||||
discussion: true
|
||||
conversational_knowledge:
|
||||
- agents: "{project-root}/{bmad_folder}/bmb/docs/agents/kb.csv"
|
||||
- workflows: "{project-root}/{bmad_folder}/bmb/docs/workflows/kb.csv"
|
||||
- modules: "{project-root}/{bmad_folder}/bmb/docs/modules/kb.csv"
|
||||
- agents: "{project-root}/_bmad/bmb/docs/agents/kb.csv"
|
||||
- workflows: "{project-root}/_bmad/bmb/docs/workflows/kb.csv"
|
||||
- modules: "{project-root}/_bmad/bmb/docs/modules/kb.csv"
|
||||
|
||||
menu:
|
||||
- multi: "[CA] Create, [EA] Edit, or [VA] Validate with Compliance CheckBMAD agents with best practices"
|
||||
triggers:
|
||||
- create-agent:
|
||||
- input: CA or fuzzy match create agent
|
||||
- route: "{project-root}/{bmad_folder}/bmb/workflows/create-agent/workflow.md"
|
||||
- route: "{project-root}/_bmad/bmb/workflows/create-agent/workflow.md"
|
||||
- data: null
|
||||
- type: exec
|
||||
- edit-agent:
|
||||
- input: EA or fuzzy match edit agent
|
||||
- route: "{project-root}/{bmad_folder}/bmb/workflows/edit-agent/workflow.md"
|
||||
- route: "{project-root}/_bmad/bmb/workflows/edit-agent/workflow.md"
|
||||
- data: null
|
||||
- type: exec
|
||||
- run-agent-compliance-check:
|
||||
- input: VA or fuzzy match validate agent
|
||||
- route: "{project-root}/{bmad_folder}/bmb/workflows/agent-compliance-check/workflow.md"
|
||||
- route: "{project-root}/_bmad/bmb/workflows/agent-compliance-check/workflow.md"
|
||||
- data: null
|
||||
- type: exec
|
||||
|
||||
|
|
@ -51,17 +51,17 @@ agent:
|
|||
triggers:
|
||||
- create-workflow:
|
||||
- input: CW or fuzzy match create workflow
|
||||
- route: "{project-root}/{bmad_folder}/bmb/workflows/create-workflow/workflow.md"
|
||||
- route: "{project-root}/_bmad/bmb/workflows/create-workflow/workflow.md"
|
||||
- data: null
|
||||
- type: exec
|
||||
- edit-workflow:
|
||||
- input: EW or fuzzy match edit workflow
|
||||
- route: "{project-root}/{bmad_folder}/bmb/workflows/edit-workflow/workflow.md"
|
||||
- route: "{project-root}/_bmad/bmb/workflows/edit-workflow/workflow.md"
|
||||
- data: null
|
||||
- type: exec
|
||||
- run-workflow-compliance-check:
|
||||
- input: VW or fuzzy match validate workflow
|
||||
- route: "{project-root}/{bmad_folder}/bmb/workflows/workflow-compliance-check/workflow.md"
|
||||
- route: "{project-root}/_bmad/bmb/workflows/workflow-compliance-check/workflow.md"
|
||||
- data: null
|
||||
- type: exec
|
||||
|
||||
|
|
@ -69,26 +69,26 @@ agent:
|
|||
triggers:
|
||||
- brainstorm-module:
|
||||
- input: BM or fuzzy match brainstorm module
|
||||
- route: "{project-root}/{bmad_folder}/bmb/workflows/brainstorm-module/workflow.md"
|
||||
- route: "{project-root}/_bmad/bmb/workflows/brainstorm-module/workflow.md"
|
||||
- data: null
|
||||
- type: exec
|
||||
- product-brief-module:
|
||||
- input: PBM or fuzzy match product brief module
|
||||
- route: "{project-root}/{bmad_folder}/bmb/workflows/product-brief-module/workflow.md"
|
||||
- route: "{project-root}/_bmad/bmb/workflows/product-brief-module/workflow.md"
|
||||
- data: null
|
||||
- type: exec
|
||||
- create-module:
|
||||
- input: CM or fuzzy match create module
|
||||
- route: "{project-root}/{bmad_folder}/bmb/workflows/create-module/workflow.md"
|
||||
- route: "{project-root}/_bmad/bmb/workflows/create-module/workflow.md"
|
||||
- data: null
|
||||
- type: exec
|
||||
- edit-module:
|
||||
- input: EM or fuzzy match edit module
|
||||
- route: "{project-root}/{bmad_folder}/bmb/workflows/edit-module/workflow.md"
|
||||
- route: "{project-root}/_bmad/bmb/workflows/edit-module/workflow.md"
|
||||
- data: null
|
||||
- type: exec
|
||||
- run-module-compliance-check:
|
||||
- input: VM or fuzzy match validate module
|
||||
- route: "{project-root}/{bmad_folder}/bmb/workflows/module-compliance-check/workflow.md"
|
||||
- route: "{project-root}/_bmad/bmb/workflows/module-compliance-check/workflow.md"
|
||||
- data: null
|
||||
- type: exec
|
||||
|
|
|
|||
|
|
@ -18,56 +18,44 @@ Specialized tools and workflows for creating, customizing, and extending BMad co
|
|||
|
||||
**BMad Builder** - Master builder agent orchestrating all creation workflows with deep knowledge of BMad architecture and conventions.
|
||||
|
||||
- Location: `.bmad/bmb/agents/bmad-builder.md`
|
||||
- Install Location: `_bmad/bmb/agents/bmad-builder.md`
|
||||
|
||||
### 📋 Workflows
|
||||
|
||||
**Active Workflows** (Step-File Architecture)
|
||||
|
||||
- Location: `src/modules/bmb/workflows/`
|
||||
- 5 core workflows with 41 step files total
|
||||
- Template-based execution with JIT loading
|
||||
|
||||
**Legacy Workflows** (Being Migrated)
|
||||
|
||||
- Location: `src/modules/bmb/workflows-legacy/`
|
||||
- Module-specific workflows pending conversion to step-file architecture
|
||||
|
||||
### 📚 Documentation
|
||||
|
||||
- Location: `src/modules/bmb/docs/`
|
||||
- Comprehensive guides for agents and workflows
|
||||
- Comprehensive guides for agents, workflows, and modules
|
||||
- Architecture patterns and best practices
|
||||
|
||||
### 🔍 Reference Materials
|
||||
|
||||
- Location: `src/modules/bmb/reference/`
|
||||
- Working examples of agents and workflows
|
||||
- Location: `../reference/`
|
||||
- Working examples of custom stand alone agents and workflows
|
||||
- Template patterns and implementation guides
|
||||
|
||||
## Documentation
|
||||
|
||||
### 📖 Agent Documentation
|
||||
|
||||
- **[Agent Index](./docs/agents/index.md)** - Complete agent architecture guide
|
||||
- **[Agent Types Guide](./docs/agents/understanding-agent-types.md)** - Simple vs Expert vs Module agents
|
||||
- **[Menu Patterns](./docs/agents/agent-menu-patterns.md)** - YAML menu design and handler types
|
||||
- **[Agent Compilation](./docs/agents/agent-compilation.md)** - Auto-injection rules and compilation process
|
||||
- **[Agent Index](./agents/index.md)** - Complete agent architecture guide
|
||||
- **[Agent Types Guide](./agents/understanding-agent-types.md)** - Simple vs Expert vs Module agents
|
||||
- **[Menu Patterns](./agents/agent-menu-patterns.md)** - YAML menu design and handler types
|
||||
- **[Agent Compilation](./agents/agent-compilation.md)** - Auto-injection rules and compilation process
|
||||
|
||||
### 📋 Workflow Documentation
|
||||
|
||||
- **[Workflow Index](./docs/workflows/index.md)** - Core workflow system overview
|
||||
- **[Architecture Guide](./docs/workflows/architecture.md)** - Step-file design and JIT loading
|
||||
- **[Template System](./docs/workflows/templates/step-template.md)** - Standard step file template
|
||||
- **[Intent vs Prescriptive](./docs/workflows/intent-vs-prescriptive-spectrum.md)** - Design philosophy
|
||||
- **[Workflow Index](./workflows/index.md)** - Core workflow system overview
|
||||
- **[Architecture Guide](./workflows/architecture.md)** - Step-file design and JIT loading
|
||||
- **[Template System](./workflows/templates/step-template.md)** - Standard step file template
|
||||
- **[Intent vs Prescriptive](./workflows/intent-vs-prescriptive-spectrum.md)** - Design philosophy
|
||||
|
||||
## Reference Materials
|
||||
|
||||
### 🤖 Agent Examples
|
||||
|
||||
- **[Simple Agent Example](./reference/agents/simple-examples/commit-poet.agent.yaml)** - Self-contained agent
|
||||
- **[Expert Agent Example](./reference/agents/expert-examples/journal-keeper/)** - Agent with persistent memory
|
||||
- **[Module Agent Examples](./reference/agents/module-examples/)** - Integration patterns (BMM, CIS)
|
||||
- **[Simple Agent Example](../reference/agents/simple-examples/commit-poet.agent.yaml)** - Self-contained agent
|
||||
- **[Expert Agent Example](../reference/agents/expert-examples/journal-keeper/journal-keeper.agent.yaml)** - Agent with persistent memory
|
||||
- **[Module Add On Agent Examples](../reference/agents/module-examples/security-engineer.agent.yaml)** - Integration patterns (BMM, CIS)
|
||||
|
||||
### 📋 Workflow Examples
|
||||
|
||||
|
|
@ -35,7 +35,7 @@ rex.agent.yaml ← Persona name (users might rename to "Max")
|
|||
**Pattern:**
|
||||
|
||||
- Filename: `{role-or-function}.agent.yaml` (kebab-case)
|
||||
- Metadata ID: `{bmad_folder}/{module}/agents/{role-or-function}.md`
|
||||
- Metadata ID: `_bmad/{module}/agents/{role-or-function}.md`
|
||||
- Persona Name: User-customizable in metadata or customize.yaml
|
||||
|
||||
**Example:**
|
||||
|
|
@ -44,7 +44,7 @@ rex.agent.yaml ← Persona name (users might rename to "Max")
|
|||
# File: presentation-master.agent.yaml
|
||||
agent:
|
||||
metadata:
|
||||
id: '{bmad_folder}/cis/agents/presentation-master.md'
|
||||
id: '_bmad/cis/agents/presentation-master.md'
|
||||
name: Caravaggio # ← Users can change this to "Pablo" or "Vince"
|
||||
title: Visual Communication & Presentation Expert
|
||||
```
|
||||
|
|
@ -83,7 +83,7 @@ You must fully embody this agent's persona...
|
|||
<step n="N+3">Input resolution rules</step>
|
||||
|
||||
<menu-handlers>
|
||||
<!-- Only handlers used in YOUR menu are included -->
|
||||
<!-- Only handler instructions for the handler types used in the agents specific menu are included -->
|
||||
</menu-handlers>
|
||||
|
||||
<rules>
|
||||
|
|
|
|||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue