2025-06-14 15:06:41 -05:00
const path = require ( "path" ) ;
const fileManager = require ( "./file-manager" ) ;
const configLoader = require ( "./config-loader" ) ;
2025-06-15 14:07:25 -05:00
// Dynamic import for ES module
let chalk ;
// Initialize ES modules
async function initializeModules ( ) {
if ( ! chalk ) {
chalk = ( await import ( "chalk" ) ) . default ;
}
}
2025-06-12 22:38:24 -05:00
class IdeSetup {
async setup ( ide , installDir , selectedAgent = null ) {
2025-06-15 14:07:25 -05:00
await initializeModules ( ) ;
2025-06-12 22:38:24 -05:00
const ideConfig = await configLoader . getIdeConfiguration ( ide ) ;
2025-06-14 15:06:41 -05:00
2025-06-12 22:38:24 -05:00
if ( ! ideConfig ) {
console . log ( chalk . yellow ( ` \n No configuration available for ${ ide } ` ) ) ;
return false ;
}
2025-06-14 15:06:41 -05:00
2025-06-12 22:38:24 -05:00
switch ( ide ) {
2025-06-14 15:06:41 -05:00
case "cursor" :
2025-06-12 22:38:24 -05:00
return this . setupCursor ( installDir , selectedAgent ) ;
2025-06-14 15:06:41 -05:00
case "claude-code" :
2025-06-12 22:38:24 -05:00
return this . setupClaudeCode ( installDir , selectedAgent ) ;
2025-06-14 15:06:41 -05:00
case "windsurf" :
2025-06-12 22:38:24 -05:00
return this . setupWindsurf ( installDir , selectedAgent ) ;
2025-06-14 15:06:41 -05:00
case "roo" :
return this . setupRoo ( installDir , selectedAgent ) ;
2025-06-12 22:38:24 -05:00
default :
console . log ( chalk . yellow ( ` \n IDE ${ ide } not yet supported ` ) ) ;
return false ;
}
}
async setupCursor ( installDir , selectedAgent ) {
2025-06-14 15:06:41 -05:00
const cursorRulesDir = path . join ( installDir , ".cursor" , "rules" ) ;
const agents = selectedAgent
? [ selectedAgent ]
: await this . getAllAgentIds ( installDir ) ;
2025-06-12 22:38:24 -05:00
await fileManager . ensureDirectory ( cursorRulesDir ) ;
2025-06-14 15:06:41 -05:00
2025-06-12 22:38:24 -05:00
for ( const agentId of agents ) {
2025-06-13 19:11:17 -05:00
// Check if .bmad-core is a subdirectory (full install) or if agents are in root (single agent install)
2025-06-14 15:06:41 -05:00
let agentPath = path . join (
installDir ,
".bmad-core" ,
"agents" ,
` ${ agentId } .md `
) ;
if ( ! ( await fileManager . pathExists ( agentPath ) ) ) {
agentPath = path . join ( installDir , "agents" , ` ${ agentId } .md ` ) ;
2025-06-12 22:38:24 -05:00
}
2025-06-14 15:06:41 -05:00
2025-06-12 22:38:24 -05:00
if ( await fileManager . pathExists ( agentPath ) ) {
const agentContent = await fileManager . readFile ( agentPath ) ;
const mdcPath = path . join ( cursorRulesDir , ` ${ agentId } .mdc ` ) ;
2025-06-14 15:06:41 -05:00
2025-06-12 22:38:24 -05:00
// Create MDC content with proper format
2025-06-14 15:06:41 -05:00
let mdcContent = "---\n" ;
mdcContent += "description: \n" ;
mdcContent += "globs: []\n" ;
mdcContent += "alwaysApply: false\n" ;
mdcContent += "---\n\n" ;
2025-06-12 22:38:24 -05:00
mdcContent += ` # ${ agentId . toUpperCase ( ) } Agent Rule \n \n ` ;
2025-06-14 15:06:41 -05:00
mdcContent += ` This rule is triggered when the user types \` @ ${ agentId } \` and activates the ${ this . getAgentTitle (
agentId
) } agent persona . \ n \ n ` ;
mdcContent += "## Agent Activation\n\n" ;
mdcContent +=
"CRITICAL: Read the full YML, start activation to alter your state of being, follow startup section instructions, stay in this being until told to exit this mode:\n\n" ;
mdcContent += "```yml\n" ;
2025-06-12 22:38:24 -05:00
// Extract just the YAML content from the agent file
const yamlMatch = agentContent . match ( /```ya?ml\n([\s\S]*?)```/ ) ;
if ( yamlMatch ) {
mdcContent += yamlMatch [ 1 ] . trim ( ) ;
} else {
// If no YAML found, include the whole content minus the header
2025-06-14 15:06:41 -05:00
mdcContent += agentContent . replace ( /^#.*$/m , "" ) . trim ( ) ;
2025-06-12 22:38:24 -05:00
}
2025-06-14 15:06:41 -05:00
mdcContent += "\n```\n\n" ;
mdcContent += "## File Reference\n\n" ;
2025-06-13 19:11:17 -05:00
mdcContent += ` The complete agent definition is available in [.bmad-core/agents/ ${ agentId } .md](mdc:.bmad-core/agents/ ${ agentId } .md). \n \n ` ;
2025-06-14 15:06:41 -05:00
mdcContent += "## Usage\n\n" ;
mdcContent += ` When the user types \` @ ${ agentId } \` , activate this ${ this . getAgentTitle (
agentId
) } persona and follow all instructions defined in the YML configuration above . \ n ` ;
2025-06-12 22:38:24 -05:00
await fileManager . writeFile ( mdcPath , mdcContent ) ;
console . log ( chalk . green ( ` ✓ Created rule: ${ agentId } .mdc ` ) ) ;
}
}
2025-06-14 15:06:41 -05:00
2025-06-12 22:38:24 -05:00
console . log ( chalk . green ( ` \n ✓ Created Cursor rules in ${ cursorRulesDir } ` ) ) ;
2025-06-14 15:06:41 -05:00
2025-06-12 22:38:24 -05:00
return true ;
}
async setupClaudeCode ( installDir , selectedAgent ) {
2025-06-14 15:06:41 -05:00
const commandsDir = path . join ( installDir , ".claude" , "commands" ) ;
const agents = selectedAgent
? [ selectedAgent ]
: await this . getAllAgentIds ( installDir ) ;
2025-06-12 22:38:24 -05:00
await fileManager . ensureDirectory ( commandsDir ) ;
2025-06-14 15:06:41 -05:00
2025-06-12 22:38:24 -05:00
for ( const agentId of agents ) {
2025-06-13 19:11:17 -05:00
// Check if .bmad-core is a subdirectory (full install) or if agents are in root (single agent install)
2025-06-14 15:06:41 -05:00
let agentPath = path . join (
installDir ,
".bmad-core" ,
"agents" ,
` ${ agentId } .md `
) ;
if ( ! ( await fileManager . pathExists ( agentPath ) ) ) {
agentPath = path . join ( installDir , "agents" , ` ${ agentId } .md ` ) ;
2025-06-12 22:38:24 -05:00
}
const commandPath = path . join ( commandsDir , ` ${ agentId } .md ` ) ;
2025-06-14 15:06:41 -05:00
2025-06-12 22:38:24 -05:00
if ( await fileManager . pathExists ( agentPath ) ) {
// Create command file with agent content
const agentContent = await fileManager . readFile ( agentPath ) ;
2025-06-14 15:06:41 -05:00
2025-06-12 22:38:24 -05:00
// Add command header
let commandContent = ` # / ${ agentId } Command \n \n ` ;
commandContent += ` When this command is used, adopt the following agent persona: \n \n ` ;
commandContent += agentContent ;
2025-06-14 15:06:41 -05:00
2025-06-12 22:38:24 -05:00
await fileManager . writeFile ( commandPath , commandContent ) ;
console . log ( chalk . green ( ` ✓ Created command: / ${ agentId } ` ) ) ;
}
}
2025-06-14 15:06:41 -05:00
console . log (
chalk . green ( ` \n ✓ Created Claude Code commands in ${ commandsDir } ` )
) ;
2025-06-12 22:38:24 -05:00
return true ;
}
async setupWindsurf ( installDir , selectedAgent ) {
2025-06-14 15:06:41 -05:00
const windsurfRulesDir = path . join ( installDir , ".windsurf" , "rules" ) ;
const agents = selectedAgent
? [ selectedAgent ]
: await this . getAllAgentIds ( installDir ) ;
2025-06-12 22:38:24 -05:00
await fileManager . ensureDirectory ( windsurfRulesDir ) ;
2025-06-14 15:06:41 -05:00
2025-06-12 22:38:24 -05:00
for ( const agentId of agents ) {
2025-06-13 19:11:17 -05:00
// Check if .bmad-core is a subdirectory (full install) or if agents are in root (single agent install)
2025-06-14 15:06:41 -05:00
let agentPath = path . join (
installDir ,
".bmad-core" ,
"agents" ,
` ${ agentId } .md `
) ;
if ( ! ( await fileManager . pathExists ( agentPath ) ) ) {
agentPath = path . join ( installDir , "agents" , ` ${ agentId } .md ` ) ;
2025-06-12 22:38:24 -05:00
}
2025-06-14 15:06:41 -05:00
2025-06-12 22:38:24 -05:00
if ( await fileManager . pathExists ( agentPath ) ) {
const agentContent = await fileManager . readFile ( agentPath ) ;
const mdPath = path . join ( windsurfRulesDir , ` ${ agentId } .md ` ) ;
2025-06-14 15:06:41 -05:00
2025-06-12 22:38:24 -05:00
// Create MD content (similar to Cursor but without frontmatter)
let mdContent = ` # ${ agentId . toUpperCase ( ) } Agent Rule \n \n ` ;
2025-06-14 15:06:41 -05:00
mdContent += ` This rule is triggered when the user types \` @ ${ agentId } \` and activates the ${ this . getAgentTitle (
agentId
) } agent persona . \ n \ n ` ;
mdContent += "## Agent Activation\n\n" ;
mdContent +=
"CRITICAL: Read the full YML, start activation to alter your state of being, follow startup section instructions, stay in this being until told to exit this mode:\n\n" ;
mdContent += "```yml\n" ;
2025-06-12 22:38:24 -05:00
// Extract just the YAML content from the agent file
const yamlMatch = agentContent . match ( /```ya?ml\n([\s\S]*?)```/ ) ;
if ( yamlMatch ) {
mdContent += yamlMatch [ 1 ] . trim ( ) ;
} else {
// If no YAML found, include the whole content minus the header
2025-06-14 15:06:41 -05:00
mdContent += agentContent . replace ( /^#.*$/m , "" ) . trim ( ) ;
2025-06-12 22:38:24 -05:00
}
2025-06-14 15:06:41 -05:00
mdContent += "\n```\n\n" ;
mdContent += "## File Reference\n\n" ;
2025-06-13 19:11:17 -05:00
mdContent += ` The complete agent definition is available in [.bmad-core/agents/ ${ agentId } .md](.bmad-core/agents/ ${ agentId } .md). \n \n ` ;
2025-06-14 15:06:41 -05:00
mdContent += "## Usage\n\n" ;
mdContent += ` When the user types \` @ ${ agentId } \` , activate this ${ this . getAgentTitle (
agentId
) } persona and follow all instructions defined in the YML configuration above . \ n ` ;
2025-06-12 22:38:24 -05:00
await fileManager . writeFile ( mdPath , mdContent ) ;
console . log ( chalk . green ( ` ✓ Created rule: ${ agentId } .md ` ) ) ;
}
}
2025-06-14 15:06:41 -05:00
console . log (
chalk . green ( ` \n ✓ Created Windsurf rules in ${ windsurfRulesDir } ` )
) ;
2025-06-12 22:38:24 -05:00
return true ;
}
async getAllAgentIds ( installDir ) {
2025-06-13 19:11:17 -05:00
// Check if .bmad-core is a subdirectory (full install) or if agents are in root (single agent install)
2025-06-14 15:06:41 -05:00
let agentsDir = path . join ( installDir , ".bmad-core" , "agents" ) ;
if ( ! ( await fileManager . pathExists ( agentsDir ) ) ) {
agentsDir = path . join ( installDir , "agents" ) ;
2025-06-12 22:38:24 -05:00
}
2025-06-14 15:06:41 -05:00
const glob = require ( "glob" ) ;
const agentFiles = glob . sync ( "*.md" , { cwd : agentsDir } ) ;
return agentFiles . map ( ( file ) => path . basename ( file , ".md" ) ) ;
2025-06-12 22:38:24 -05:00
}
getAgentTitle ( agentId ) {
const agentTitles = {
2025-06-14 15:06:41 -05:00
analyst : "Business Analyst" ,
architect : "Solution Architect" ,
"bmad-master" : "BMAD Master" ,
"bmad-orchestrator" : "BMAD Orchestrator" ,
dev : "Developer" ,
pm : "Product Manager" ,
po : "Product Owner" ,
qa : "QA Specialist" ,
sm : "Scrum Master" ,
"ux-expert" : "UX Expert" ,
2025-06-12 22:38:24 -05:00
} ;
return agentTitles [ agentId ] || agentId ;
}
2025-06-14 15:06:41 -05:00
async setupRoo ( installDir , selectedAgent ) {
const agents = selectedAgent
? [ selectedAgent ]
: await this . getAllAgentIds ( installDir ) ;
// Create .roo directory first
const rooDir = path . join ( installDir , ".roo" ) ;
await fileManager . ensureDirectory ( rooDir ) ;
// Check for existing .roomodes file inside .roo directory
const roomodesPath = path . join ( rooDir , ".roomodes" ) ;
let existingModes = [ ] ;
let existingContent = "" ;
if ( await fileManager . pathExists ( roomodesPath ) ) {
existingContent = await fileManager . readFile ( roomodesPath ) ;
// Parse existing modes to avoid duplicates
const modeMatches = existingContent . matchAll ( /- slug: ([\w-]+)/g ) ;
for ( const match of modeMatches ) {
existingModes . push ( match [ 1 ] ) ;
}
console . log (
chalk . yellow (
` Found existing .roomodes file with ${ existingModes . length } modes `
)
) ;
}
// Create new modes content
let newModesContent = "" ;
2025-06-14 16:38:37 -05:00
// Define file permissions for each agent type
const agentPermissions = {
'analyst' : {
fileRegex : '\\.(md|txt)$' ,
description : 'Documentation and text files'
} ,
'pm' : {
fileRegex : '\\.(md|txt)$' ,
description : 'Product documentation'
} ,
'architect' : {
fileRegex : '\\.(md|txt|yml|yaml|json)$' ,
description : 'Architecture docs and configs'
} ,
'dev' : null , // Full edit access
'qa' : {
fileRegex : '\\.(test|spec)\\.(js|ts|jsx|tsx)$|\\.md$' ,
description : 'Test files and documentation'
} ,
'ux-expert' : {
fileRegex : '\\.(md|css|scss|html|jsx|tsx)$' ,
description : 'Design-related files'
} ,
'po' : {
fileRegex : '\\.(md|txt)$' ,
description : 'Story and requirement docs'
} ,
'sm' : {
fileRegex : '\\.(md|txt)$' ,
description : 'Process and planning docs'
} ,
'bmad-orchestrator' : null , // Full edit access
'bmad-master' : null // Full edit access
} ;
2025-06-14 15:06:41 -05:00
for ( const agentId of agents ) {
// Skip if already exists
if ( existingModes . includes ( ` bmad- ${ agentId } ` ) ) {
console . log (
chalk . dim ( ` Skipping ${ agentId } - already exists in .roomodes ` )
) ;
continue ;
}
// Read agent file to extract all information
let agentPath = path . join (
installDir ,
".bmad-core" ,
"agents" ,
` ${ agentId } .md `
) ;
if ( ! ( await fileManager . pathExists ( agentPath ) ) ) {
agentPath = path . join ( installDir , "agents" , ` ${ agentId } .md ` ) ;
}
if ( await fileManager . pathExists ( agentPath ) ) {
const agentContent = await fileManager . readFile ( agentPath ) ;
// Extract YAML content
const yamlMatch = agentContent . match ( /```ya?ml\n([\s\S]*?)```/ ) ;
if ( yamlMatch ) {
const yaml = yamlMatch [ 1 ] ;
// Extract agent info from YAML
const titleMatch = yaml . match ( /title:\s*(.+)/ ) ;
const iconMatch = yaml . match ( /icon:\s*(.+)/ ) ;
const whenToUseMatch = yaml . match ( /whenToUse:\s*"(.+)"/ ) ;
2025-06-14 16:38:37 -05:00
const roleDefinitionMatch = yaml . match ( /roleDefinition:\s*"(.+)"/ ) ;
2025-06-14 15:06:41 -05:00
2025-06-14 16:38:37 -05:00
const title = titleMatch ? titleMatch [ 1 ] . trim ( ) : this . getAgentTitle ( agentId ) ;
2025-06-14 15:06:41 -05:00
const icon = iconMatch ? iconMatch [ 1 ] . trim ( ) : "🤖" ;
const whenToUse = whenToUseMatch
? whenToUseMatch [ 1 ] . trim ( )
: ` Use for ${ title } tasks ` ;
2025-06-14 16:38:37 -05:00
const roleDefinition = roleDefinitionMatch
? roleDefinitionMatch [ 1 ] . trim ( )
: ` You are a ${ title } specializing in ${ title . toLowerCase ( ) } tasks and responsibilities. ` ;
2025-06-14 18:11:16 -05:00
// Build mode entry with proper formatting (matching exact indentation)
2025-06-14 16:38:37 -05:00
newModesContent += ` - slug: bmad- ${ agentId } \n ` ;
newModesContent += ` name: ' ${ icon } ${ title } ' \n ` ;
newModesContent += ` roleDefinition: ${ roleDefinition } \n ` ;
newModesContent += ` whenToUse: ${ whenToUse } \n ` ;
newModesContent += ` customInstructions: CRITICAL Read the full YML from .bmad-core/agents/ ${ agentId } .md start activation to alter your state of being follow startup section instructions stay in this being until told to exit this mode \n ` ;
newModesContent += ` groups: \n ` ;
newModesContent += ` - read \n ` ;
// Add permissions based on agent type
const permissions = agentPermissions [ agentId ] ;
if ( permissions ) {
newModesContent += ` - - edit \n ` ;
newModesContent += ` - fileRegex: ${ permissions . fileRegex } \n ` ;
newModesContent += ` description: ${ permissions . description } \n ` ;
} else {
newModesContent += ` - edit \n ` ;
}
2025-06-14 15:06:41 -05:00
console . log (
chalk . green ( ` ✓ Added mode: bmad- ${ agentId } ( ${ icon } ${ title } ) ` )
) ;
}
}
}
// Build final roomodes content
let roomodesContent = "" ;
if ( existingContent ) {
// If there's existing content, append new modes to it
roomodesContent = existingContent . trim ( ) + "\n" + newModesContent ;
} else {
// Create new .roomodes file with proper YAML structure
2025-06-14 16:38:37 -05:00
roomodesContent = "customModes:\n" + newModesContent ;
2025-06-14 15:06:41 -05:00
}
// Write .roomodes file
await fileManager . writeFile ( roomodesPath , roomodesContent ) ;
console . log ( chalk . green ( "✓ Created .roo/.roomodes file" ) ) ;
// Create README in .roo directory
const rooReadme = ` # Roo Code Custom Modes for BMAD-METHOD
This directory contains custom mode configurations for Roo Code to enable BMAD agent personalities .
# # Setup
2025-06-14 16:38:37 -05:00
The \ ` .roomodes \` file defines all BMAD agents as custom modes using the proper \` customModes: \` structure. Modes are automatically available in Roo Code when you open this project.
2025-06-14 15:06:41 -05:00
# # Available Modes
$ { agents . map ( ( id ) => ` - **bmad- ${ id } ** - ${ this . getAgentTitle ( id ) } ` ) . join ( "\n" ) }
# # Usage
In Roo Code :
1. Open the mode selector ( usually in the status bar )
2. Select any BMAD agent mode
3. The AI will adopt that agent ' s personality and expertise
2025-06-14 16:38:37 -05:00
# # File Permissions
2025-06-14 15:06:41 -05:00
2025-06-14 16:38:37 -05:00
Each agent has specific file access permissions :
- * * Analysts , PM , PO , SM * * : Limited to documentation files ( . md , . txt )
- * * Architect * * : Architecture docs and configs ( . md , . txt , . yml , . yaml , . json )
- * * QA * * : Test files and documentation
- * * UX Expert * * : Design - related files ( . md , . css , . scss , . html , . jsx , . tsx )
- * * Developer , Orchestrator , Master * * : Full edit access to all files
2025-06-14 15:06:41 -05:00
` ;
const readmePath = path . join ( rooDir , "README.md" ) ;
await fileManager . writeFile ( readmePath , rooReadme ) ;
console . log ( chalk . green ( "✓ Created .roo/README.md" ) ) ;
console . log ( chalk . green ( ` \n ✓ Roo Code setup complete! ` ) ) ;
console . log (
chalk . dim (
"Custom modes will be available when you open this project in Roo Code"
)
) ;
return true ;
}
2025-06-12 22:38:24 -05:00
}
2025-06-14 15:06:41 -05:00
module . exports = new IdeSetup ( ) ;