bmad-method 5.1.2 → 6.0.0-Beta.0

package/tools/cli/installers/lib/ide/crush.js

@@ -0,0 +1,149 @@
+const path = require('node:path');
+const fs = require('fs-extra');
+const { BaseIdeSetup } = require('./_base-ide');
+const chalk = require('chalk');
+const { AgentCommandGenerator } = require('./shared/agent-command-generator');
+const { WorkflowCommandGenerator } = require('./shared/workflow-command-generator');
+const { TaskToolCommandGenerator } = require('./shared/task-tool-command-generator');
+const { customAgentColonName } = require('./shared/path-utils');
+
+/**
+ * Crush IDE setup handler
+ * Creates commands in .crush/commands/ directory structure using flat colon naming
+ */
+class CrushSetup extends BaseIdeSetup {
+  constructor() {
+    super('crush', 'Crush');
+    this.configDir = '.crush';
+    this.commandsDir = 'commands';
+  }
+
+  /**
+   * Setup Crush IDE configuration
+   * @param {string} projectDir - Project directory
+   * @param {string} bmadDir - BMAD installation directory
+   * @param {Object} options - Setup options
+   */
+  async setup(projectDir, bmadDir, options = {}) {
+    console.log(chalk.cyan(`Setting up ${this.name}...`));
+
+    // Clean up old BMAD installation first
+    await this.cleanup(projectDir);
+
+    // Create .crush/commands directory
+    const crushDir = path.join(projectDir, this.configDir);
+    const commandsDir = path.join(crushDir, this.commandsDir);
+    await this.ensureDir(commandsDir);
+
+    // Use underscore format: files written directly to commands dir (no bmad subfolder)
+    // Creates: .crush/commands/bmad_bmm_pm.md
+
+    // Generate agent launchers
+    const agentGen = new AgentCommandGenerator(this.bmadFolderName);
+    const { artifacts: agentArtifacts } = await agentGen.collectAgentArtifacts(bmadDir, options.selectedModules || []);
+
+    // Write agent launcher files using flat underscore naming
+    // Creates files like: bmad_bmm_pm.md
+    const agentCount = await agentGen.writeColonArtifacts(commandsDir, agentArtifacts);
+
+    // Get ALL workflows using the new workflow command generator
+    const workflowGenerator = new WorkflowCommandGenerator(this.bmadFolderName);
+    const { artifacts: workflowArtifacts } = await workflowGenerator.collectWorkflowArtifacts(bmadDir);
+
+    // Write workflow-command artifacts using flat underscore naming
+    // Creates files like: bmad_bmm_correct-course.md
+    const workflowCount = await workflowGenerator.writeColonArtifacts(commandsDir, workflowArtifacts);
+
+    // Generate task and tool commands using flat underscore naming
+    const taskToolGen = new TaskToolCommandGenerator();
+    const taskToolResult = await taskToolGen.generateColonTaskToolCommands(projectDir, bmadDir, commandsDir);
+
+    console.log(chalk.green(`✓ ${this.name} configured:`));
+    console.log(chalk.dim(`  - ${agentCount} agent commands created`));
+    console.log(chalk.dim(`  - ${taskToolResult.tasks} task commands created`));
+    console.log(chalk.dim(`  - ${taskToolResult.tools} tool commands created`));
+    console.log(chalk.dim(`  - ${workflowCount} workflow commands created`));
+    console.log(chalk.dim(`  - Commands directory: ${path.relative(projectDir, commandsDir)}`));
+    console.log(chalk.dim('\n  Commands can be accessed via Crush command palette'));
+
+    return {
+      success: true,
+      agents: agentCount,
+      tasks: taskToolResult.tasks || 0,
+      tools: taskToolResult.tools || 0,
+      workflows: workflowCount,
+    };
+  }
+
+  /**
+   * Cleanup Crush configuration
+   */
+  async cleanup(projectDir) {
+    const commandsDir = path.join(projectDir, this.configDir, this.commandsDir);
+
+    // Remove any bmad* files from the commands directory (cleans up old bmad: and bmad- formats)
+    if (await fs.pathExists(commandsDir)) {
+      const entries = await fs.readdir(commandsDir);
+      for (const entry of entries) {
+        if (entry.startsWith('bmad')) {
+          await fs.remove(path.join(commandsDir, entry));
+        }
+      }
+    }
+    // Also remove legacy bmad folder if it exists
+    const bmadFolder = path.join(commandsDir, 'bmad');
+    if (await fs.pathExists(bmadFolder)) {
+      await fs.remove(bmadFolder);
+      console.log(chalk.dim(`Removed BMAD commands from Crush`));
+    }
+  }
+
+  /**
+   * Install a custom agent launcher for Crush
+   * @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} Installation result
+   */
+  async installCustomAgentLauncher(projectDir, agentName, agentPath, metadata) {
+    const commandsDir = path.join(projectDir, this.configDir, this.commandsDir);
+
+    // Create .crush/commands directory if it doesn't exist
+    await fs.ensureDir(commandsDir);
+
+    // Create custom agent launcher
+    const launcherContent = `# ${agentName} Custom Agent
+
+**⚠️ IMPORTANT**: Run @${agentPath} first to load the complete agent!
+
+This is a launcher for the custom BMAD agent "${agentName}".
+
+## Usage
+1. First run: \`${agentPath}\` to load the complete agent
+2. Then use this command to activate ${agentName}
+
+The agent will follow the persona and instructions from the main agent file.
+
+---
+
+*Generated by BMAD Method*`;
+
+    // Use underscore format: bmad_custom_fred-commit-poet.md
+    // Written directly to commands dir (no bmad subfolder)
+    const launcherName = customAgentColonName(agentName);
+    const launcherPath = path.join(commandsDir, launcherName);
+
+    // Write the launcher file
+    await fs.writeFile(launcherPath, launcherContent, 'utf8');
+
+    return {
+      ide: 'crush',
+      path: path.relative(projectDir, launcherPath),
+      command: launcherName.replace('.md', ''),
+      type: 'custom-agent-launcher',
+    };
+  }
+}
+
+module.exports = { CrushSetup };

package/tools/cli/installers/lib/ide/cursor.js

@@ -0,0 +1,160 @@
+const path = require('node:path');
+const { BaseIdeSetup } = require('./_base-ide');
+const chalk = require('chalk');
+const { AgentCommandGenerator } = require('./shared/agent-command-generator');
+const { WorkflowCommandGenerator } = require('./shared/workflow-command-generator');
+const { TaskToolCommandGenerator } = require('./shared/task-tool-command-generator');
+const { customAgentColonName } = require('./shared/path-utils');
+
+/**
+ * Cursor IDE setup handler
+ */
+class CursorSetup extends BaseIdeSetup {
+  constructor() {
+    super('cursor', 'Cursor', true); // preferred IDE
+    this.configDir = '.cursor';
+    this.rulesDir = 'rules';
+    this.commandsDir = 'commands';
+  }
+
+  /**
+   * Cleanup old BMAD installation before reinstalling
+   * @param {string} projectDir - Project directory
+   */
+  async cleanup(projectDir) {
+    const fs = require('fs-extra');
+    const commandsDir = path.join(projectDir, this.configDir, this.commandsDir);
+
+    // Remove any bmad* files from the commands directory (cleans up old bmad: and bmad- formats)
+    if (await fs.pathExists(commandsDir)) {
+      const entries = await fs.readdir(commandsDir);
+      for (const entry of entries) {
+        if (entry.startsWith('bmad')) {
+          await fs.remove(path.join(commandsDir, entry));
+        }
+      }
+    }
+    // Also remove legacy bmad folder if it exists
+    const bmadFolder = path.join(commandsDir, 'bmad');
+    if (await fs.pathExists(bmadFolder)) {
+      await fs.remove(bmadFolder);
+      console.log(chalk.dim(`  Removed old BMAD commands from ${this.name}`));
+    }
+  }
+
+  /**
+   * Setup Cursor IDE configuration
+   * @param {string} projectDir - Project directory
+   * @param {string} bmadDir - BMAD installation directory
+   * @param {Object} options - Setup options
+   */
+  async setup(projectDir, bmadDir, options = {}) {
+    console.log(chalk.cyan(`Setting up ${this.name}...`));
+
+    // Clean up old BMAD installation first
+    await this.cleanup(projectDir);
+
+    // Create .cursor/commands directory structure
+    const cursorDir = path.join(projectDir, this.configDir);
+    const commandsDir = path.join(cursorDir, this.commandsDir);
+    await this.ensureDir(commandsDir);
+
+    // Use underscore format: files written directly to commands dir (no bmad subfolder)
+    // Creates: .cursor/commands/bmad_bmm_pm.md
+
+    // Generate agent launchers using AgentCommandGenerator
+    // This creates small launcher files that reference the actual agents in _bmad/
+    const agentGen = new AgentCommandGenerator(this.bmadFolderName);
+    const { artifacts: agentArtifacts, counts: agentCounts } = await agentGen.collectAgentArtifacts(bmadDir, options.selectedModules || []);
+
+    // Write agent launcher files using flat underscore naming
+    // Creates files like: bmad_bmm_pm.md
+    const agentCount = await agentGen.writeColonArtifacts(commandsDir, agentArtifacts);
+
+    // Generate workflow commands from manifest (if it exists)
+    const workflowGen = new WorkflowCommandGenerator(this.bmadFolderName);
+    const { artifacts: workflowArtifacts } = await workflowGen.collectWorkflowArtifacts(bmadDir);
+
+    // Write workflow-command artifacts using flat underscore naming
+    // Creates files like: bmad_bmm_correct-course.md
+    const workflowCommandCount = await workflowGen.writeColonArtifacts(commandsDir, workflowArtifacts);
+
+    // Generate task and tool commands from manifests (if they exist)
+    const taskToolGen = new TaskToolCommandGenerator();
+    const taskToolResult = await taskToolGen.generateColonTaskToolCommands(projectDir, bmadDir, commandsDir);
+
+    console.log(chalk.green(`✓ ${this.name} configured:`));
+    console.log(chalk.dim(`  - ${agentCount} agents installed`));
+    if (workflowCommandCount > 0) {
+      console.log(chalk.dim(`  - ${workflowCommandCount} workflow commands generated`));
+    }
+    if (taskToolResult.generated > 0) {
+      console.log(
+        chalk.dim(
+          `  - ${taskToolResult.generated} task/tool commands generated (${taskToolResult.tasks} tasks, ${taskToolResult.tools} tools)`,
+        ),
+      );
+    }
+    console.log(chalk.dim(`  - Commands directory: ${path.relative(projectDir, commandsDir)}`));
+
+    return {
+      success: true,
+      agents: agentCount,
+      tasks: taskToolResult.tasks || 0,
+      tools: taskToolResult.tools || 0,
+      workflows: workflowCommandCount,
+    };
+  }
+
+  /**
+   * Install a custom agent launcher for Cursor
+   * @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|null} Info about created command
+   */
+  async installCustomAgentLauncher(projectDir, agentName, agentPath, metadata) {
+    const commandsDir = path.join(projectDir, this.configDir, this.commandsDir);
+
+    if (!(await this.exists(path.join(projectDir, this.configDir)))) {
+      return null; // IDE not configured for this project
+    }
+
+    await this.ensureDir(commandsDir);
+
+    const launcherContent = `You must fully embody this agent's persona and follow all activation instructions exactly as specified. NEVER break character until given an exit command.
+
+<agent-activation CRITICAL="TRUE">
+1. LOAD the FULL agent file from @${agentPath}
+2. READ its entire contents - this contains the complete agent persona, menu, and instructions
+3. FOLLOW every step in the <activation> section precisely
+4. DISPLAY the welcome/greeting as instructed
+5. PRESENT the numbered menu
+6. WAIT for user input before proceeding
+</agent-activation>
+`;
+
+    // Cursor uses YAML frontmatter matching Claude Code format
+    const commandContent = `---
+name: '${agentName}'
+description: '${agentName} agent'
+---
+
+${launcherContent}
+`;
+
+    // Use underscore format: bmad_custom_fred-commit-poet.md
+    // Written directly to commands dir (no bmad subfolder)
+    const launcherName = customAgentColonName(agentName);
+    const launcherPath = path.join(commandsDir, launcherName);
+    await this.writeFile(launcherPath, commandContent);
+
+    return {
+      path: launcherPath,
+      command: `/${launcherName.replace('.md', '')}`,
+    };
+  }
+}
+
+module.exports = { CursorSetup };

package/tools/cli/installers/lib/ide/gemini.js

@@ -0,0 +1,301 @@
+const path = require('node:path');
+const fs = require('fs-extra');
+const yaml = require('yaml');
+const { BaseIdeSetup } = require('./_base-ide');
+const chalk = require('chalk');
+const { AgentCommandGenerator } = require('./shared/agent-command-generator');
+const { WorkflowCommandGenerator } = require('./shared/workflow-command-generator');
+
+/**
+ * Gemini CLI setup handler
+ * Creates TOML files in .gemini/commands/ structure
+ */
+class GeminiSetup extends BaseIdeSetup {
+  constructor() {
+    super('gemini', 'Gemini CLI', false);
+    this.configDir = '.gemini';
+    this.commandsDir = 'commands';
+    this.agentTemplatePath = path.join(__dirname, 'templates', 'gemini-agent-command.toml');
+    this.taskTemplatePath = path.join(__dirname, 'templates', 'gemini-task-command.toml');
+  }
+
+  /**
+   * Load config values from bmad installation
+   * @param {string} bmadDir - BMAD installation directory
+   * @returns {Object} Config values
+   */
+  async loadConfigValues(bmadDir) {
+    const configValues = {
+      user_name: 'User', // Default fallback
+    };
+
+    // Try to load core config.yaml
+    const coreConfigPath = path.join(bmadDir, 'core', 'config.yaml');
+    if (await fs.pathExists(coreConfigPath)) {
+      try {
+        const configContent = await fs.readFile(coreConfigPath, 'utf8');
+        const config = yaml.parse(configContent);
+
+        if (config.user_name) {
+          configValues.user_name = config.user_name;
+        }
+      } catch (error) {
+        console.warn(chalk.yellow(`  Warning: Could not load config values: ${error.message}`));
+      }
+    }
+
+    return configValues;
+  }
+
+  /**
+   * Setup Gemini CLI configuration
+   * @param {string} projectDir - Project directory
+   * @param {string} bmadDir - BMAD installation directory
+   * @param {Object} options - Setup options
+   */
+  async setup(projectDir, bmadDir, options = {}) {
+    console.log(chalk.cyan(`Setting up ${this.name}...`));
+
+    // Create .gemini/commands directory (flat structure with bmad- prefix)
+    const geminiDir = path.join(projectDir, this.configDir);
+    const commandsDir = path.join(geminiDir, this.commandsDir);
+
+    await this.ensureDir(commandsDir);
+
+    // Clean up any existing BMAD files before reinstalling
+    await this.cleanup(projectDir);
+
+    // Generate agent launchers
+    const agentGen = new AgentCommandGenerator(this.bmadFolderName);
+    const { artifacts: agentArtifacts } = await agentGen.collectAgentArtifacts(bmadDir, options.selectedModules || []);
+
+    // Get tasks and workflows (ALL workflows now generate commands)
+    const tasks = await this.getTasks(bmadDir);
+
+    // Get ALL workflows using the new workflow command generator
+    const workflowGenerator = new WorkflowCommandGenerator(this.bmadFolderName);
+    const { artifacts: workflowArtifacts, counts: workflowCounts } = await workflowGenerator.collectWorkflowArtifacts(bmadDir);
+
+    // Install agents as TOML files with bmad- prefix (flat structure)
+    let agentCount = 0;
+    for (const artifact of agentArtifacts) {
+      const tomlContent = await this.createAgentLauncherToml(artifact);
+
+      // Flat structure: bmad-agent-{module}-{name}.toml
+      const tomlPath = path.join(commandsDir, `bmad-agent-${artifact.module}-${artifact.name}.toml`);
+      await this.writeFile(tomlPath, tomlContent);
+      agentCount++;
+
+      console.log(chalk.green(`  ✓ Added agent: /bmad_agents_${artifact.module}_${artifact.name}`));
+    }
+
+    // Install tasks as TOML files with bmad- prefix (flat structure)
+    let taskCount = 0;
+    for (const task of tasks) {
+      const content = await this.readFile(task.path);
+      const tomlContent = await this.createTaskToml(task, content);
+
+      // Flat structure: bmad-task-{module}-{name}.toml
+      const tomlPath = path.join(commandsDir, `bmad-task-${task.module}-${task.name}.toml`);
+      await this.writeFile(tomlPath, tomlContent);
+      taskCount++;
+
+      console.log(chalk.green(`  ✓ Added task: /bmad_tasks_${task.module}_${task.name}`));
+    }
+
+    // Install workflows as TOML files with bmad- prefix (flat structure)
+    let workflowCount = 0;
+    for (const artifact of workflowArtifacts) {
+      if (artifact.type === 'workflow-command') {
+        // Create TOML wrapper around workflow command content
+        const tomlContent = await this.createWorkflowToml(artifact);
+
+        // Flat structure: bmad-workflow-{module}-{name}.toml
+        const workflowName = path.basename(artifact.relativePath, '.md');
+        const tomlPath = path.join(commandsDir, `bmad-workflow-${artifact.module}-${workflowName}.toml`);
+        await this.writeFile(tomlPath, tomlContent);
+        workflowCount++;
+
+        console.log(chalk.green(`  ✓ Added workflow: /bmad_workflows_${artifact.module}_${workflowName}`));
+      }
+    }
+
+    console.log(chalk.green(`✓ ${this.name} configured:`));
+    console.log(chalk.dim(`  - ${agentCount} agents configured`));
+    console.log(chalk.dim(`  - ${taskCount} tasks configured`));
+    console.log(chalk.dim(`  - ${workflowCount} workflows configured`));
+    console.log(chalk.dim(`  - Commands directory: ${path.relative(projectDir, commandsDir)}`));
+    console.log(chalk.dim(`  - Agent activation: /bmad_agents_{agent-name}`));
+    console.log(chalk.dim(`  - Task activation: /bmad_tasks_{task-name}`));
+    console.log(chalk.dim(`  - Workflow activation: /bmad_workflows_{workflow-name}`));
+
+    return {
+      success: true,
+      agents: agentCount,
+      tasks: taskCount,
+      workflows: workflowCount,
+    };
+  }
+
+  /**
+   * Create agent launcher TOML content from artifact
+   */
+  async createAgentLauncherToml(artifact) {
+    // Strip frontmatter from launcher content
+    const frontmatterRegex = /^---\s*\n[\s\S]*?\n---\s*\n/;
+    const contentWithoutFrontmatter = artifact.content.replace(frontmatterRegex, '').trim();
+
+    // Extract title from launcher frontmatter
+    const titleMatch = artifact.content.match(/description:\s*"([^"]+)"/);
+    const title = titleMatch ? titleMatch[1] : this.formatTitle(artifact.name);
+
+    // Create TOML wrapper around launcher content (without frontmatter)
+    const description = `BMAD ${artifact.module.toUpperCase()} Agent: ${title}`;
+
+    return `description = "${description}"
+prompt = """
+${contentWithoutFrontmatter}
+"""
+`;
+  }
+
+  /**
+   * Create agent TOML content using template
+   */
+  async createAgentToml(agent, content) {
+    // Extract metadata
+    const titleMatch = content.match(/title="([^"]+)"/);
+    const title = titleMatch ? titleMatch[1] : this.formatTitle(agent.name);
+
+    // Load template
+    const template = await fs.readFile(this.agentTemplatePath, 'utf8');
+
+    // Replace template variables
+    // Note: {user_name} and other {config_values} are left as-is for runtime substitution by Gemini
+    const tomlContent = template
+      .replaceAll('{{title}}', title)
+      .replaceAll('{_bmad}', '_bmad')
+      .replaceAll('{_bmad}', this.bmadFolderName)
+      .replaceAll('{{module}}', agent.module)
+      .replaceAll('{{name}}', agent.name);
+
+    return tomlContent;
+  }
+
+  /**
+   * Create task TOML content using template
+   */
+  async createTaskToml(task, content) {
+    // Extract task name from XML if available
+    const nameMatch = content.match(/<name>([^<]+)<\/name>/);
+    const taskName = nameMatch ? nameMatch[1] : this.formatTitle(task.name);
+
+    // Load template
+    const template = await fs.readFile(this.taskTemplatePath, 'utf8');
+
+    // Replace template variables
+    const tomlContent = template
+      .replaceAll('{{taskName}}', taskName)
+      .replaceAll('{_bmad}', '_bmad')
+      .replaceAll('{_bmad}', this.bmadFolderName)
+      .replaceAll('{{module}}', task.module)
+      .replaceAll('{{filename}}', task.filename);
+
+    return tomlContent;
+  }
+
+  /**
+   * Create workflow TOML content from artifact
+   */
+  async createWorkflowToml(artifact) {
+    // Extract description from artifact content
+    const descriptionMatch = artifact.content.match(/description:\s*"([^"]+)"/);
+    const description = descriptionMatch
+      ? descriptionMatch[1]
+      : `BMAD ${artifact.module.toUpperCase()} Workflow: ${path.basename(artifact.relativePath, '.md')}`;
+
+    // Strip frontmatter from command content
+    const frontmatterRegex = /^---\s*\n[\s\S]*?\n---\s*\n/;
+    const contentWithoutFrontmatter = artifact.content.replace(frontmatterRegex, '').trim();
+
+    return `description = "${description}"
+prompt = """
+${contentWithoutFrontmatter}
+"""
+`;
+  }
+
+  /**
+   * Cleanup Gemini configuration - surgically remove only BMAD files
+   */
+  async cleanup(projectDir) {
+    const fs = require('fs-extra');
+    const commandsDir = path.join(projectDir, this.configDir, this.commandsDir);
+
+    if (await fs.pathExists(commandsDir)) {
+      // Remove any bmad* files (cleans up old bmad- and bmad: formats)
+      const files = await fs.readdir(commandsDir);
+      let removed = 0;
+
+      for (const file of files) {
+        if (file.startsWith('bmad') && file.endsWith('.toml')) {
+          await fs.remove(path.join(commandsDir, file));
+          removed++;
+        }
+      }
+
+      if (removed > 0) {
+        console.log(chalk.dim(`  Cleaned up ${removed} existing BMAD files`));
+      }
+    }
+  }
+
+  /**
+   * Install a custom agent launcher for Gemini
+   * @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} Installation result
+   */
+  async installCustomAgentLauncher(projectDir, agentName, agentPath, metadata) {
+    const geminiDir = path.join(projectDir, this.configDir);
+    const commandsDir = path.join(geminiDir, this.commandsDir);
+
+    // Create .gemini/commands directory if it doesn't exist
+    await fs.ensureDir(commandsDir);
+
+    // Create custom agent launcher in TOML format
+    const launcherContent = `description = "Custom BMAD Agent: ${agentName}"
+prompt = """
+**⚠️ IMPORTANT**: Run @${agentPath} first to load the complete agent!
+
+This is a launcher for the custom BMAD agent "${agentName}".
+
+## Usage
+1. First run: \`${agentPath}\` to load the complete agent
+2. Then use this command to activate ${agentName}
+
+The agent will follow the persona and instructions from the main agent file.
+
+---
+
+*Generated by BMAD Method*
+"""`;
+
+    const fileName = `bmad-custom-${agentName.toLowerCase()}.toml`;
+    const launcherPath = path.join(commandsDir, fileName);
+
+    // Write the launcher file
+    await fs.writeFile(launcherPath, launcherContent, 'utf8');
+
+    return {
+      ide: 'gemini',
+      path: path.relative(projectDir, launcherPath),
+      command: agentName,
+      type: 'custom-agent-launcher',
+    };
+  }
+}
+
+module.exports = { GeminiSetup };