mirror of
https://github.com/bmadcode/BMAD-METHOD.git
synced 2025-12-19 02:35:31 +00:00
## Overview
This commit represents a complete overhaul of the BMAD agent creation system, establishing clear standards for agent development, installation workflows, and persona design. The changes span documentation, tooling, reference implementations, and field-specific guidance.
## Key Components
### 1. Agent Installation Infrastructure
**New CLI Command: `agent-install`**
- Interactive agent installation with persona customization
- Supports Simple (single YAML), Expert (sidecar files), and Module agents
- Template variable processing with Handlebars-style syntax
- Automatic compilation from YAML to XML (.md) format
- Manifest tracking and IDE integration (Claude Code, Cursor, Windsurf, etc.)
- Source preservation in `_cfg/custom/agents/` for reinstallation
**Files Created:**
- `tools/cli/commands/agent-install.js` - Main CLI command
- `tools/cli/lib/agent/compiler.js` - YAML to XML compilation engine
- `tools/cli/lib/agent/installer.js` - Installation orchestration
- `tools/cli/lib/agent/template-engine.js` - Handlebars template processing
**Compiler Features:**
- Auto-injects frontmatter, activation, handlers, help/exit menu items
- Smart handler inclusion (only includes action/workflow/exec/tmpl handlers actually used)
- Proper XML escaping and formatting
- Persona name customization (e.g., "Fred the Commit Poet")
### 2. Documentation Overhaul
**Deleted Bloated/Outdated Docs (2,651 lines removed):**
- Old verbose architecture docs
- Redundant pattern files
- Outdated workflow guides
**Created Focused, Type-Specific Docs:**
- `src/modules/bmb/docs/understanding-agent-types.md` - Architecture vs capability distinction
- `src/modules/bmb/docs/simple-agent-architecture.md` - Self-contained agents
- `src/modules/bmb/docs/expert-agent-architecture.md` - Agents with sidecar files
- `src/modules/bmb/docs/module-agent-architecture.md` - Workflow-integrated agents
- `src/modules/bmb/docs/agent-compilation.md` - YAML → XML process
- `src/modules/bmb/docs/agent-menu-patterns.md` - Menu design patterns
- `src/modules/bmb/docs/index.md` - Documentation hub
**Net Result:** ~1,930 line reduction while adding MORE value through focused content
### 3. Create-Agent Workflow Enhancements
**Critical Persona Field Guidance Added to Step 4:**
Explains how the LLM interprets each persona field when the agent activates:
- **role** → "What knowledge, skills, and capabilities do I possess?"
- **identity** → "What background, experience, and context shape my responses?"
- **communication_style** → "What verbal patterns, word choice, quirks, and phrasing do I use?"
- **principles** → "What beliefs and operating philosophy drive my choices?"
**Key Insight:** `communication_style` should ONLY describe HOW the agent talks, not restate role/identity/principles. The `communication-presets.csv` provides 60 pure communication styles with NO role/identity/principles mixed in.
**Files Updated:**
- `src/modules/bmb/workflows/create-agent/instructions.md` - Added persona field interpretation guide
- `src/modules/bmb/workflows/create-agent/brainstorm-context.md` - Refined to 137 lines
- `src/modules/bmb/workflows/create-agent/communication-presets.csv` - 60 styles across 13 categories
### 4. Reference Agent Cleanup
**Removed install_config Personality Bloat:**
Understanding: Future installer will handle personality customization, so stripped all personality toggles from reference agents.
**commit-poet.agent.yaml** (Simple Agent):
- BEFORE: 36 personality combinations (3 enthusiasm × 3 depths × 4 styles) = decision fatigue
- AFTER: Single concise persona with pure communication style
- Changed from verbose conditionals to: "Poetic drama and flair with every turn of a phrase. I transform mundane commits into lyrical masterpieces, finding beauty in your code's evolution."
- Reduction: 248 lines → 153 lines (38% reduction)
**journal-keeper.agent.yaml** (Expert Agent):
- Stripped install_config, simplified communication_style
- Shows proper Expert agent structure with sidecar files
**security-engineer.agent.yaml & trend-analyst.agent.yaml** (Module Agents):
- Added header comments explaining WHY Module Agent (design intent, not just location)
- Clarified: Module agents are designed FOR ecosystem integration, not capability-limited
**Files Updated:**
- `src/modules/bmb/reference/agents/simple-examples/commit-poet.agent.yaml`
- `src/modules/bmb/reference/agents/expert-examples/journal-keeper/journal-keeper.agent.yaml`
- `src/modules/bmb/reference/agents/module-examples/security-engineer.agent.yaml`
- `src/modules/bmb/reference/agents/module-examples/trend-analyst.agent.yaml`
### 5. BMM Agent Voice Enhancement
**Gave all 9 BMM agents distinct, memorable communication voices:**
**Mary (analyst)** - The favorite! Changed from generic "systematic and probing" to:
"Treats analysis like a treasure hunt - excited by every clue, thrilled when patterns emerge. Asks questions that spark 'aha!' moments while structuring insights with precision."
**Other Notable Voices:**
- **John (pm):** "Asks 'WHY?' relentlessly like a detective on a case. Direct and data-sharp, cuts through fluff to what actually matters."
- **Winston (architect):** "Speaks in calm, pragmatic tones, balancing 'what could be' with 'what should be.' Champions boring technology that actually works."
- **Amelia (dev):** "Ultra-succinct. Speaks in file paths and AC IDs - every statement citable. No fluff, all precision."
- **Bob (sm):** "Crisp and checklist-driven. Every word has a purpose, every requirement crystal clear. Zero tolerance for ambiguity."
- **Sally (ux-designer):** "Paints pictures with words, telling user stories that make you FEEL the problem. Empathetic advocate with creative storytelling flair."
**Pattern Applied:** Moved behaviors from communication_style to principles, keeping communication_style as PURE verbal patterns.
**Files Updated:**
- `src/modules/bmm/agents/analyst.agent.yaml`
- `src/modules/bmm/agents/pm.agent.yaml`
- `src/modules/bmm/agents/architect.agent.yaml`
- `src/modules/bmm/agents/dev.agent.yaml`
- `src/modules/bmm/agents/sm.agent.yaml`
- `src/modules/bmm/agents/tea.agent.yaml`
- `src/modules/bmm/agents/tech-writer.agent.yaml`
- `src/modules/bmm/agents/ux-designer.agent.yaml`
- `src/modules/bmm/agents/frame-expert.agent.yaml`
### 6. Linting Fixes
**ESLint Compliance:**
- Replaced all `'utf-8'` with `'utf8'` (unicorn/text-encoding-identifier-case)
- Changed `variables.hasOwnProperty(varName)` to `Object.hasOwn(variables, varName)` (unicorn/prefer-object-has-own)
- Replaced `JSON.parse(JSON.stringify(...))` with `structuredClone(...)` (unicorn/prefer-structured-clone)
- Fixed empty YAML mapping values in sample files
**Files Fixed:**
- 7 JavaScript files across agent tooling (compiler, installer, commands, IDE integration)
- 1 YAML sample file
## Architecture Decisions
### Agent Types Are About Architecture, Not Capability
- **Simple:** Self-contained in single YAML (NOT limited in capability)
- **Expert:** Includes sidecar files (templates, docs, etc.)
- **Module:** Designed for BMAD ecosystem integration (workflows, cross-agent coordination)
### Persona Field Separation Critical for LLM Interpretation
The LLM needs distinct fields to understand its role:
- Mixing role/identity/principles into communication_style confuses the persona
- Pure communication styles (from communication-presets.csv) have ZERO role/identity/principles content
- Example DON'T: "Experienced analyst who uses systematic approaches..." (mixing identity + style)
- Example DO: "Systematic and probing. Structures findings hierarchically." (pure style)
### Install-Time vs Runtime Configuration
- Template variables ({{var}}) resolve at compile-time
- Runtime variables ({user_name}, {bmad_folder}) resolve when agent activates
- Future installer will handle personality customization, so agents should ship with single default persona
## Testing
- All linting passes (ESLint with max-warnings=0)
- Agent compilation tested with commit-poet, journal-keeper examples
- Install workflow validated with Simple and Expert agent types
- Manifest tracking and IDE integration verified
## Impact
This establishes BMAD as having a complete, production-ready agent creation and installation system with:
- Clear documentation for all agent types
- Automated compilation and installation
- Strong persona design guidance
- Reference implementations showing best practices
- Distinct, memorable agent voices throughout BMM module
Co-Authored-By: BMad Builder <builder@bmad.dev>
Co-Authored-By: Mary the Analyst <analyst@bmad.dev>
Co-Authored-By: Paige the Tech Writer <tech-writer@bmad.dev>
245 lines
7.1 KiB
JavaScript
245 lines
7.1 KiB
JavaScript
const fs = require('fs-extra');
|
|
const path = require('node:path');
|
|
const chalk = require('chalk');
|
|
|
|
/**
|
|
* IDE Manager - handles IDE-specific setup
|
|
* Dynamically discovers and loads IDE handlers
|
|
*/
|
|
class IdeManager {
|
|
constructor() {
|
|
this.handlers = new Map();
|
|
this.loadHandlers();
|
|
this.bmadFolderName = 'bmad'; // Default, can be overridden
|
|
}
|
|
|
|
/**
|
|
* Set the bmad folder name for all IDE handlers
|
|
* @param {string} bmadFolderName - The bmad folder name
|
|
*/
|
|
setBmadFolderName(bmadFolderName) {
|
|
this.bmadFolderName = bmadFolderName;
|
|
// Update all loaded handlers
|
|
for (const handler of this.handlers.values()) {
|
|
if (typeof handler.setBmadFolderName === 'function') {
|
|
handler.setBmadFolderName(bmadFolderName);
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Dynamically load all IDE handlers from directory
|
|
*/
|
|
loadHandlers() {
|
|
const ideDir = __dirname;
|
|
|
|
try {
|
|
// Get all JS files in the IDE directory
|
|
const files = fs.readdirSync(ideDir).filter((file) => {
|
|
// Skip base class, manager, utility files (starting with _), and helper modules
|
|
return (
|
|
file.endsWith('.js') &&
|
|
!file.startsWith('_') &&
|
|
file !== 'manager.js' &&
|
|
file !== 'workflow-command-generator.js' &&
|
|
file !== 'task-tool-command-generator.js'
|
|
);
|
|
});
|
|
|
|
// Sort alphabetically for consistent ordering
|
|
files.sort();
|
|
|
|
for (const file of files) {
|
|
const moduleName = path.basename(file, '.js');
|
|
|
|
try {
|
|
const modulePath = path.join(ideDir, file);
|
|
const HandlerModule = require(modulePath);
|
|
|
|
// Get the first exported class (handles various export styles)
|
|
const HandlerClass = HandlerModule.default || HandlerModule[Object.keys(HandlerModule)[0]];
|
|
|
|
if (HandlerClass) {
|
|
const instance = new HandlerClass();
|
|
// Use the name property from the instance (set in constructor)
|
|
// Only add if the instance has a valid name
|
|
if (instance.name && typeof instance.name === 'string') {
|
|
this.handlers.set(instance.name, instance);
|
|
} else {
|
|
console.log(chalk.yellow(` Warning: ${moduleName} handler missing valid 'name' property`));
|
|
}
|
|
}
|
|
} catch (error) {
|
|
console.log(chalk.yellow(` Warning: Could not load ${moduleName}: ${error.message}`));
|
|
}
|
|
}
|
|
} catch (error) {
|
|
console.error(chalk.red('Failed to load IDE handlers:'), error.message);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Get all available IDEs with their metadata
|
|
* @returns {Array} Array of IDE information objects
|
|
*/
|
|
getAvailableIdes() {
|
|
const ides = [];
|
|
|
|
for (const [key, handler] of this.handlers) {
|
|
// Skip handlers without valid names
|
|
const name = handler.displayName || handler.name || key;
|
|
|
|
// Filter out invalid entries (undefined name, empty key, etc.)
|
|
if (!key || !name || typeof key !== 'string' || typeof name !== 'string') {
|
|
continue;
|
|
}
|
|
|
|
ides.push({
|
|
value: key,
|
|
name: name,
|
|
preferred: handler.preferred || false,
|
|
});
|
|
}
|
|
|
|
// Sort: preferred first, then alphabetical
|
|
ides.sort((a, b) => {
|
|
if (a.preferred && !b.preferred) return -1;
|
|
if (!a.preferred && b.preferred) return 1;
|
|
return a.name.localeCompare(b.name);
|
|
});
|
|
|
|
return ides;
|
|
}
|
|
|
|
/**
|
|
* Get preferred IDEs
|
|
* @returns {Array} Array of preferred IDE information
|
|
*/
|
|
getPreferredIdes() {
|
|
return this.getAvailableIdes().filter((ide) => ide.preferred);
|
|
}
|
|
|
|
/**
|
|
* Get non-preferred IDEs
|
|
* @returns {Array} Array of non-preferred IDE information
|
|
*/
|
|
getOtherIdes() {
|
|
return this.getAvailableIdes().filter((ide) => !ide.preferred);
|
|
}
|
|
|
|
/**
|
|
* Setup IDE configuration
|
|
* @param {string} ideName - Name of the IDE
|
|
* @param {string} projectDir - Project directory
|
|
* @param {string} bmadDir - BMAD installation directory
|
|
* @param {Object} options - Setup options
|
|
*/
|
|
async setup(ideName, projectDir, bmadDir, options = {}) {
|
|
const handler = this.handlers.get(ideName.toLowerCase());
|
|
|
|
if (!handler) {
|
|
console.warn(chalk.yellow(`⚠️ IDE '${ideName}' is not yet supported`));
|
|
console.log(chalk.dim('Supported IDEs:', [...this.handlers.keys()].join(', ')));
|
|
return { success: false, reason: 'unsupported' };
|
|
}
|
|
|
|
try {
|
|
await handler.setup(projectDir, bmadDir, options);
|
|
return { success: true, ide: ideName };
|
|
} catch (error) {
|
|
console.error(chalk.red(`Failed to setup ${ideName}:`), error.message);
|
|
return { success: false, error: error.message };
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Cleanup IDE configurations
|
|
* @param {string} projectDir - Project directory
|
|
*/
|
|
async cleanup(projectDir) {
|
|
const results = [];
|
|
|
|
for (const [name, handler] of this.handlers) {
|
|
try {
|
|
await handler.cleanup(projectDir);
|
|
results.push({ ide: name, success: true });
|
|
} catch (error) {
|
|
results.push({ ide: name, success: false, error: error.message });
|
|
}
|
|
}
|
|
|
|
return results;
|
|
}
|
|
|
|
/**
|
|
* Get list of supported IDEs
|
|
* @returns {Array} List of supported IDE names
|
|
*/
|
|
getSupportedIdes() {
|
|
return [...this.handlers.keys()];
|
|
}
|
|
|
|
/**
|
|
* Check if an IDE is supported
|
|
* @param {string} ideName - Name of the IDE
|
|
* @returns {boolean} True if IDE is supported
|
|
*/
|
|
isSupported(ideName) {
|
|
return this.handlers.has(ideName.toLowerCase());
|
|
}
|
|
|
|
/**
|
|
* Detect installed IDEs
|
|
* @param {string} projectDir - Project directory
|
|
* @returns {Array} List of detected IDEs
|
|
*/
|
|
async detectInstalledIdes(projectDir) {
|
|
const detected = [];
|
|
|
|
for (const [name, handler] of this.handlers) {
|
|
if (typeof handler.detect === 'function' && (await handler.detect(projectDir))) {
|
|
detected.push(name);
|
|
}
|
|
}
|
|
|
|
return detected;
|
|
}
|
|
|
|
/**
|
|
* Install custom agent launchers for specified IDEs
|
|
* @param {Array} ides - List of IDE names to install for
|
|
* @param {string} projectDir - Project directory
|
|
* @param {string} agentName - Agent name (e.g., "fred-commit-poet")
|
|
* @param {string} agentPath - Path to compiled agent (relative to project root)
|
|
* @param {Object} metadata - Agent metadata
|
|
* @returns {Object} Results for each IDE
|
|
*/
|
|
async installCustomAgentLaunchers(ides, projectDir, agentName, agentPath, metadata) {
|
|
const results = {};
|
|
|
|
for (const ideName of ides) {
|
|
const handler = this.handlers.get(ideName.toLowerCase());
|
|
|
|
if (!handler) {
|
|
console.warn(chalk.yellow(`⚠️ IDE '${ideName}' is not yet supported for custom agent installation`));
|
|
continue;
|
|
}
|
|
|
|
try {
|
|
if (typeof handler.installCustomAgentLauncher === 'function') {
|
|
const result = await handler.installCustomAgentLauncher(projectDir, agentName, agentPath, metadata);
|
|
if (result) {
|
|
results[ideName] = result;
|
|
}
|
|
}
|
|
} catch (error) {
|
|
console.warn(chalk.yellow(`⚠️ Failed to install ${ideName} launcher: ${error.message}`));
|
|
}
|
|
}
|
|
|
|
return results;
|
|
}
|
|
}
|
|
|
|
module.exports = { IdeManager };
|