Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions tools/cli/installers/lib/ide/manager.js
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ class IdeManager {

/**
* Dynamically load all IDE handlers
* 1. Load custom installer files first (codex.js, kilo.js, kiro-cli.js)
* 1. Load custom installer files first (codex.js, kilo.js, kiro-cli.js, opencode.js)
* 2. Load config-driven handlers from platform-codes.yaml
*/
async loadHandlers() {
Expand All @@ -61,7 +61,7 @@ class IdeManager {
*/
loadCustomInstallerFiles() {
const ideDir = __dirname;
const customFiles = ['codex.js', 'kilo.js', 'kiro-cli.js'];
const customFiles = ['codex.js', 'kilo.js', 'kiro-cli.js', 'opencode.js'];

for (const file of customFiles) {
const filePath = path.join(ideDir, file);
Expand Down
259 changes: 259 additions & 0 deletions tools/cli/installers/lib/ide/opencode.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,259 @@
const path = require('node:path');
const fs = require('fs-extra');
const os = require('node:os');
const chalk = require('chalk');
const yaml = require('yaml');
const { BaseIdeSetup } = require('./_base-ide');
const { WorkflowCommandGenerator } = require('./shared/workflow-command-generator');
const { TaskToolCommandGenerator } = require('./shared/task-tool-command-generator');
const { AgentCommandGenerator } = require('./shared/agent-command-generator');

/**
* OpenCode IDE setup handler
*/
class OpenCodeSetup extends BaseIdeSetup {
constructor() {
super('opencode', 'OpenCode', true); // Mark as preferred/recommended
this.configDir = '.opencode';
this.commandsDir = 'command';
this.agentsDir = 'agent';
}

async setup(projectDir, bmadDir, options = {}) {
console.log(chalk.cyan(`Setting up ${this.name}...`));

const baseDir = path.join(projectDir, this.configDir);
const commandsBaseDir = path.join(baseDir, this.commandsDir);
const agentsBaseDir = path.join(baseDir, this.agentsDir);

await this.ensureDir(commandsBaseDir);
await this.ensureDir(agentsBaseDir);

// 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 || []);

// Install primary agents with flat naming: bmad-agent-{module}-{name}.md
// OpenCode agents go in the agent folder (not command folder)
let agentCount = 0;
for (const artifact of agentArtifacts) {
const agentContent = artifact.content;
// Flat structure in agent folder: bmad-agent-{module}-{name}.md
const targetPath = path.join(agentsBaseDir, `bmad-agent-${artifact.module}-${artifact.name}.md`);
await this.writeFile(targetPath, agentContent);
agentCount++;
}

// Install workflow commands with flat naming: bmad-{module}-{workflow-name}
const workflowGenerator = new WorkflowCommandGenerator(this.bmadFolderName);
const { artifacts: workflowArtifacts, counts: workflowCounts } = await workflowGenerator.collectWorkflowArtifacts(bmadDir);

let workflowCommandCount = 0;
for (const artifact of workflowArtifacts) {
if (artifact.type === 'workflow-command') {
const commandContent = artifact.content;
// Flat structure: bmad-{module}-{workflow-name}.md
// artifact.relativePath is like: bmm/workflows/plan-project.md
const workflowName = path.basename(artifact.relativePath, '.md');
const targetPath = path.join(commandsBaseDir, `bmad-${artifact.module}-${workflowName}.md`);
await this.writeFile(targetPath, commandContent);
workflowCommandCount++;
}
// Skip workflow launcher READMEs as they're not needed in flat structure
}

// Install task and tool commands with flat naming
const { tasks, tools } = await this.generateFlatTaskToolCommands(bmadDir, commandsBaseDir);

console.log(chalk.green(`✓ ${this.name} configured:`));
console.log(chalk.dim(` - ${agentCount} agents installed to .opencode/agent/`));
if (workflowCommandCount > 0) {
console.log(chalk.dim(` - ${workflowCommandCount} workflows installed to .opencode/command/`));
}
if (tasks + tools > 0) {
console.log(chalk.dim(` - ${tasks + tools} tasks/tools installed to .opencode/command/ (${tasks} tasks, ${tools} tools)`));
}

return {
success: true,
agents: agentCount,
workflows: workflowCommandCount,
workflowCounts,
tasks,
tools,
};
}

/**
* Generate flat task and tool commands for OpenCode
* OpenCode doesn't support nested command directories
*/
async generateFlatTaskToolCommands(bmadDir, commandsBaseDir) {
const taskToolGen = new TaskToolCommandGenerator();
const tasks = await taskToolGen.loadTaskManifest(bmadDir);
const tools = await taskToolGen.loadToolManifest(bmadDir);

// Filter to only standalone items
const standaloneTasks = tasks ? tasks.filter((t) => t.standalone === 'true' || t.standalone === true) : [];
const standaloneTools = tools ? tools.filter((t) => t.standalone === 'true' || t.standalone === true) : [];

// Generate command files for tasks with flat naming: bmad-task-{module}-{name}.md
for (const task of standaloneTasks) {
const commandContent = taskToolGen.generateCommandContent(task, 'task');
const targetPath = path.join(commandsBaseDir, `bmad-task-${task.module}-${task.name}.md`);
await this.writeFile(targetPath, commandContent);
}

// Generate command files for tools with flat naming: bmad-tool-{module}-{name}.md
for (const tool of standaloneTools) {
const commandContent = taskToolGen.generateCommandContent(tool, 'tool');
const targetPath = path.join(commandsBaseDir, `bmad-tool-${tool.module}-${tool.name}.md`);
await this.writeFile(targetPath, commandContent);
}

return {
tasks: standaloneTasks.length,
tools: standaloneTools.length,
};
}

async readAndProcess(filePath, metadata) {
const content = await fs.readFile(filePath, 'utf8');
return this.processContent(content, metadata);
}

async createAgentContent(content, metadata) {
const { frontmatter = {}, body } = this.parseFrontmatter(content);

frontmatter.description =
frontmatter.description && String(frontmatter.description).trim().length > 0
? frontmatter.description
: `BMAD ${metadata.module} agent: ${metadata.name}`;

// OpenCode agents use: 'primary' mode for main agents
frontmatter.mode = 'primary';

const frontmatterString = this.stringifyFrontmatter(frontmatter);

// Get the activation header from central template
const activationHeader = await this.getAgentCommandHeader();

return `${frontmatterString}\n\n${activationHeader}\n\n${body}`;
}

parseFrontmatter(content) {
const match = content.match(/^---\s*\n([\s\S]*?)\n---\s*\n?/);
if (!match) {
return { frontmatter: {}, body: content };
}

const body = content.slice(match[0].length);

let frontmatter = {};
try {
frontmatter = yaml.parse(match[1]) || {};
} catch {
frontmatter = {};
}

return { frontmatter, body };
}

stringifyFrontmatter(frontmatter) {
const yamlText = yaml
.stringify(frontmatter, {
indent: 2,
lineWidth: -1,
sortKeys: false,
})
.trimEnd();

return `---\n${yamlText}\n---`;
}

/**
* Cleanup OpenCode configuration - surgically remove only BMAD files
*/
async cleanup(projectDir) {
const agentsDir = path.join(projectDir, this.configDir, this.agentsDir);
const commandsDir = path.join(projectDir, this.configDir, this.commandsDir);
let removed = 0;

// Clean up agent folder
if (await fs.pathExists(agentsDir)) {
const files = await fs.readdir(agentsDir);
for (const file of files) {
if (file.startsWith('bmad-') && file.endsWith('.md')) {
await fs.remove(path.join(agentsDir, file));
removed++;
}
}
}

// Clean up command folder
if (await fs.pathExists(commandsDir)) {
const files = await fs.readdir(commandsDir);
for (const file of files) {
if (file.startsWith('bmad-') && file.endsWith('.md')) {
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 OpenCode
* @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 agentsDir = path.join(projectDir, this.configDir, this.agentsDir);

if (!(await this.exists(path.join(projectDir, this.configDir)))) {
return null; // IDE not configured for this project
}

await this.ensureDir(agentsDir);

const launcherFrontmatter = {
name: agentName,
description: `${metadata.title || agentName} agent`,
mode: 'primary',
};
const launcherContent = `${this.stringifyFrontmatter(launcherFrontmatter)}

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>
`;

// OpenCode uses flat naming: bmad-agent-custom-{name}.md
const launcherPath = path.join(agentsDir, `bmad-agent-custom-${agentName}.md`);
await this.writeFile(launcherPath, launcherContent);

return {
path: launcherPath,
command: `bmad-agent-custom-${agentName}`,
};
}
}

module.exports = { OpenCodeSetup };