464 lines
15 KiB
JavaScript
464 lines
15 KiB
JavaScript
const path = require('node:path');
|
|
const fs = require('fs-extra');
|
|
const os = require('node:os');
|
|
const { BaseIdeSetup } = require('./_base-ide');
|
|
const { WorkflowCommandGenerator } = require('./shared/workflow-command-generator');
|
|
const { AgentCommandGenerator } = require('./shared/agent-command-generator');
|
|
const { TaskToolCommandGenerator } = require('./shared/task-tool-command-generator');
|
|
const { getTasksFromBmad } = require('./shared/bmad-artifacts');
|
|
const { toDashPath, customAgentDashName } = require('./shared/path-utils');
|
|
const prompts = require('../../../lib/prompts');
|
|
|
|
/**
|
|
* Codex setup handler (CLI mode)
|
|
* Writes BMAD artifacts as Agent Skills (agentskills.io format)
|
|
* into .agents/skills/ directories.
|
|
*/
|
|
class CodexSetup extends BaseIdeSetup {
|
|
constructor() {
|
|
super('codex', 'Codex', true); // preferred IDE
|
|
}
|
|
|
|
/**
|
|
* Collect configuration choices before installation
|
|
* @param {Object} options - Configuration options
|
|
* @returns {Object} Collected configuration
|
|
*/
|
|
async collectConfiguration(options = {}) {
|
|
// Non-interactive mode: use default (project)
|
|
if (options.skipPrompts) {
|
|
return { installLocation: 'project' };
|
|
}
|
|
|
|
let confirmed = false;
|
|
let installLocation = 'project';
|
|
|
|
while (!confirmed) {
|
|
installLocation = await prompts.select({
|
|
message: 'Where would you like to install Codex CLI skills?',
|
|
choices: [
|
|
{
|
|
name: 'Project-specific - Recommended (<project>/.agents/skills)',
|
|
value: 'project',
|
|
},
|
|
{
|
|
name: 'Global - (~/.agents/skills)',
|
|
value: 'global',
|
|
},
|
|
],
|
|
default: 'project',
|
|
});
|
|
|
|
// Show brief confirmation hint (detailed instructions available via verbose)
|
|
if (installLocation === 'project') {
|
|
await prompts.log.info('Skills installed to: <project>/.agents/skills');
|
|
} else {
|
|
await prompts.log.info('Skills installed to: ~/.agents/skills');
|
|
}
|
|
|
|
// Confirm the choice
|
|
confirmed = await prompts.confirm({
|
|
message: 'Proceed with this installation option?',
|
|
default: true,
|
|
});
|
|
|
|
if (!confirmed) {
|
|
await prompts.log.warn("Let's choose a different installation option.");
|
|
}
|
|
}
|
|
|
|
return { installLocation };
|
|
}
|
|
|
|
/**
|
|
* Setup Codex configuration
|
|
* @param {string} projectDir - Project directory
|
|
* @param {string} bmadDir - BMAD installation directory
|
|
* @param {Object} options - Setup options
|
|
*/
|
|
async setup(projectDir, bmadDir, options = {}) {
|
|
if (!options.silent) await prompts.log.info(`Setting up ${this.name}...`);
|
|
|
|
// Always use CLI mode
|
|
const mode = 'cli';
|
|
|
|
// Get installation location from pre-collected config or default to project
|
|
const installLocation = options.preCollectedConfig?.installLocation || 'project';
|
|
|
|
const { artifacts, counts } = await this.collectClaudeArtifacts(projectDir, bmadDir, options);
|
|
|
|
const destDir = this.getCodexSkillsDir(projectDir, installLocation);
|
|
await fs.ensureDir(destDir);
|
|
await this.clearOldBmadSkills(destDir, options);
|
|
|
|
// Collect and write agent skills
|
|
const agentGen = new AgentCommandGenerator(this.bmadFolderName);
|
|
const { artifacts: agentArtifacts } = await agentGen.collectAgentArtifacts(bmadDir, options.selectedModules || []);
|
|
const agentCount = await this.writeSkillArtifacts(destDir, agentArtifacts, 'agent-launcher');
|
|
|
|
// Collect and write task skills
|
|
const tasks = await getTasksFromBmad(bmadDir, options.selectedModules || []);
|
|
const taskArtifacts = [];
|
|
for (const task of tasks) {
|
|
const content = await this.readAndProcessWithProject(
|
|
task.path,
|
|
{
|
|
module: task.module,
|
|
name: task.name,
|
|
},
|
|
projectDir,
|
|
);
|
|
taskArtifacts.push({
|
|
type: 'task',
|
|
name: task.name,
|
|
displayName: task.name,
|
|
module: task.module,
|
|
path: task.path,
|
|
sourcePath: task.path,
|
|
relativePath: path.join(task.module, 'tasks', `${task.name}.md`),
|
|
content,
|
|
});
|
|
}
|
|
|
|
const ttGen = new TaskToolCommandGenerator(this.bmadFolderName);
|
|
const taskSkillArtifacts = taskArtifacts.map((artifact) => ({
|
|
...artifact,
|
|
content: ttGen.generateCommandContent(artifact, artifact.type),
|
|
}));
|
|
const tasksWritten = await this.writeSkillArtifacts(destDir, taskSkillArtifacts, 'task');
|
|
|
|
// Collect and write workflow skills
|
|
const workflowGenerator = new WorkflowCommandGenerator(this.bmadFolderName);
|
|
const { artifacts: workflowArtifacts } = await workflowGenerator.collectWorkflowArtifacts(bmadDir);
|
|
const workflowCount = await this.writeSkillArtifacts(destDir, workflowArtifacts, 'workflow-command');
|
|
|
|
const written = agentCount + workflowCount + tasksWritten;
|
|
|
|
if (!options.silent) {
|
|
await prompts.log.success(
|
|
`${this.name} configured: ${counts.agents} agents, ${counts.workflows} workflows, ${counts.tasks} tasks, ${written} skills → ${destDir}`,
|
|
);
|
|
}
|
|
|
|
return {
|
|
success: true,
|
|
mode,
|
|
artifacts,
|
|
counts,
|
|
destination: destDir,
|
|
written,
|
|
installLocation,
|
|
};
|
|
}
|
|
|
|
/**
|
|
* Write artifacts as Agent Skills (agentskills.io format).
|
|
* Each artifact becomes a directory containing SKILL.md.
|
|
* @param {string} destDir - Base skills directory
|
|
* @param {Array} artifacts - Artifacts to write
|
|
* @param {string} artifactType - Type filter (e.g., 'agent-launcher', 'workflow-command', 'task')
|
|
* @returns {number} Number of skills written
|
|
*/
|
|
async writeSkillArtifacts(destDir, artifacts, artifactType) {
|
|
let writtenCount = 0;
|
|
|
|
for (const artifact of artifacts) {
|
|
// Filter by type if the artifact has a type field
|
|
if (artifact.type && artifact.type !== artifactType) {
|
|
continue;
|
|
}
|
|
|
|
// Get the dash-format name (e.g., bmad-bmm-create-prd.md) and remove .md
|
|
const flatName = toDashPath(artifact.relativePath);
|
|
const skillName = flatName.replace(/\.md$/, '');
|
|
|
|
// Create skill directory
|
|
const skillDir = path.join(destDir, skillName);
|
|
await fs.ensureDir(skillDir);
|
|
|
|
// Transform content: rewrite frontmatter for skills format
|
|
const skillContent = this.transformToSkillFormat(artifact.content, skillName);
|
|
|
|
// Write SKILL.md
|
|
await fs.writeFile(path.join(skillDir, 'SKILL.md'), skillContent);
|
|
writtenCount++;
|
|
}
|
|
|
|
return writtenCount;
|
|
}
|
|
|
|
/**
|
|
* Transform artifact content from Codex prompt format to Agent Skills format.
|
|
* Removes disable-model-invocation, ensures name matches directory.
|
|
* @param {string} content - Original content with YAML frontmatter
|
|
* @param {string} skillName - Skill name (must match directory name)
|
|
* @returns {string} Transformed content
|
|
*/
|
|
transformToSkillFormat(content, skillName) {
|
|
// Parse frontmatter
|
|
const fmMatch = content.match(/^---\n([\s\S]*?)\n---\n?([\s\S]*)$/);
|
|
if (!fmMatch) {
|
|
// No frontmatter -- wrap with minimal frontmatter
|
|
return `---\nname: ${skillName}\ndescription: '${skillName}'\n---\n\n${content}`;
|
|
}
|
|
|
|
const frontmatter = fmMatch[1];
|
|
const body = fmMatch[2];
|
|
|
|
// Extract description from existing frontmatter
|
|
const descMatch = frontmatter.match(/^description:\s*['"]?(.*?)['"]?\s*$/m);
|
|
const description = descMatch ? descMatch[1] : `${skillName} skill`;
|
|
|
|
// Build new frontmatter with only skills-spec fields
|
|
return `---\nname: ${skillName}\ndescription: '${description}'\n---\n${body}`;
|
|
}
|
|
|
|
/**
|
|
* Detect Codex installation by checking for BMAD skills
|
|
*/
|
|
async detect(projectDir) {
|
|
// Check both global and project-specific locations
|
|
const globalDir = this.getCodexSkillsDir(null, 'global');
|
|
const projectDir_local = projectDir || process.cwd();
|
|
const projectSpecificDir = this.getCodexSkillsDir(projectDir_local, 'project');
|
|
|
|
// Check global location
|
|
if (await fs.pathExists(globalDir)) {
|
|
try {
|
|
const entries = await fs.readdir(globalDir);
|
|
if (entries && entries.some((entry) => entry && typeof entry === 'string' && entry.startsWith('bmad'))) {
|
|
return true;
|
|
}
|
|
} catch {
|
|
// Ignore errors
|
|
}
|
|
}
|
|
|
|
// Check project-specific location
|
|
if (await fs.pathExists(projectSpecificDir)) {
|
|
try {
|
|
const entries = await fs.readdir(projectSpecificDir);
|
|
if (entries && entries.some((entry) => entry && typeof entry === 'string' && entry.startsWith('bmad'))) {
|
|
return true;
|
|
}
|
|
} catch {
|
|
// Ignore errors
|
|
}
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Collect Claude-style artifacts for Codex export.
|
|
* Returns the normalized artifact list for further processing.
|
|
*/
|
|
async collectClaudeArtifacts(projectDir, bmadDir, options = {}) {
|
|
const selectedModules = options.selectedModules || [];
|
|
const artifacts = [];
|
|
|
|
// Generate agent launchers
|
|
const agentGen = new AgentCommandGenerator(this.bmadFolderName);
|
|
const { artifacts: agentArtifacts } = await agentGen.collectAgentArtifacts(bmadDir, selectedModules);
|
|
|
|
for (const artifact of agentArtifacts) {
|
|
artifacts.push({
|
|
type: 'agent',
|
|
module: artifact.module,
|
|
sourcePath: artifact.sourcePath,
|
|
relativePath: artifact.relativePath,
|
|
content: artifact.content,
|
|
});
|
|
}
|
|
|
|
const tasks = await getTasksFromBmad(bmadDir, selectedModules);
|
|
for (const task of tasks) {
|
|
const content = await this.readAndProcessWithProject(
|
|
task.path,
|
|
{
|
|
module: task.module,
|
|
name: task.name,
|
|
},
|
|
projectDir,
|
|
);
|
|
|
|
artifacts.push({
|
|
type: 'task',
|
|
name: task.name,
|
|
displayName: task.name,
|
|
module: task.module,
|
|
path: task.path,
|
|
sourcePath: task.path,
|
|
relativePath: path.join(task.module, 'tasks', `${task.name}.md`),
|
|
content,
|
|
});
|
|
}
|
|
|
|
const workflowGenerator = new WorkflowCommandGenerator(this.bmadFolderName);
|
|
const { artifacts: workflowArtifacts, counts: workflowCounts } = await workflowGenerator.collectWorkflowArtifacts(bmadDir);
|
|
artifacts.push(...workflowArtifacts);
|
|
|
|
return {
|
|
artifacts,
|
|
counts: {
|
|
agents: agentArtifacts.length,
|
|
tasks: tasks.length,
|
|
workflows: workflowCounts.commands,
|
|
workflowLaunchers: workflowCounts.launchers,
|
|
},
|
|
};
|
|
}
|
|
|
|
getCodexSkillsDir(projectDir = null, location = 'global') {
|
|
if (location === 'project' && projectDir) {
|
|
return path.join(projectDir, '.agents', 'skills');
|
|
}
|
|
return path.join(os.homedir(), '.agents', 'skills');
|
|
}
|
|
|
|
/**
|
|
* Remove existing BMAD skill directories from the skills directory.
|
|
* Handles both old flat files and new skill directories.
|
|
*/
|
|
async clearOldBmadSkills(destDir, options = {}) {
|
|
if (!(await fs.pathExists(destDir))) {
|
|
return;
|
|
}
|
|
|
|
let entries;
|
|
try {
|
|
entries = await fs.readdir(destDir);
|
|
} catch (error) {
|
|
// Directory exists but can't be read - skip cleanup
|
|
if (!options.silent) await prompts.log.warn(`Warning: Could not read directory ${destDir}: ${error.message}`);
|
|
return;
|
|
}
|
|
|
|
if (!entries || !Array.isArray(entries)) {
|
|
return;
|
|
}
|
|
|
|
for (const entry of entries) {
|
|
// Skip non-strings or undefined entries
|
|
if (!entry || typeof entry !== 'string') {
|
|
continue;
|
|
}
|
|
if (!entry.startsWith('bmad')) {
|
|
continue;
|
|
}
|
|
|
|
const entryPath = path.join(destDir, entry);
|
|
try {
|
|
// fs.remove handles both files and directories
|
|
await fs.remove(entryPath);
|
|
} catch (error) {
|
|
if (!options.silent) {
|
|
await prompts.log.message(` Skipping ${entry}: ${error.message}`);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
async readAndProcessWithProject(filePath, metadata, projectDir) {
|
|
const content = await fs.readFile(filePath, 'utf8');
|
|
return super.processContent(content, metadata, projectDir);
|
|
}
|
|
|
|
/**
|
|
* Get instructions for global installation
|
|
* @returns {string} Instructions text
|
|
*/
|
|
getGlobalInstructions(destDir) {
|
|
const lines = [
|
|
'IMPORTANT: Codex Configuration',
|
|
'',
|
|
'Skills installed globally to your HOME DIRECTORY (~/.agents/skills).',
|
|
'',
|
|
'These skills reference a specific _bmad path.',
|
|
"To use with other projects, you'd need to copy the _bmad dir.",
|
|
'',
|
|
'Skills are available in Codex CLI automatically.',
|
|
' Use /skills to see available skills',
|
|
' Skills can also be invoked implicitly based on task description',
|
|
];
|
|
return lines.join('\n');
|
|
}
|
|
|
|
/**
|
|
* Get instructions for project-specific installation
|
|
* @param {string} projectDir - Optional project directory
|
|
* @param {string} destDir - Optional destination directory
|
|
* @returns {string} Instructions text
|
|
*/
|
|
getProjectSpecificInstructions(projectDir = null, destDir = null) {
|
|
const lines = [
|
|
'Project-Specific Codex Configuration',
|
|
'',
|
|
`Skills installed to: ${destDir || '<project>/.agents/skills'}`,
|
|
'',
|
|
'Codex automatically discovers skills in .agents/skills/ at and above the current directory.',
|
|
'No additional configuration is needed.',
|
|
];
|
|
|
|
return lines.join('\n');
|
|
}
|
|
|
|
/**
|
|
* Cleanup Codex configuration
|
|
*/
|
|
async cleanup(projectDir = null) {
|
|
// Clean both global and project-specific locations
|
|
const globalDir = this.getCodexSkillsDir(null, 'global');
|
|
await this.clearOldBmadSkills(globalDir);
|
|
|
|
if (projectDir) {
|
|
const projectSpecificDir = this.getCodexSkillsDir(projectDir, 'project');
|
|
await this.clearOldBmadSkills(projectSpecificDir);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Install a custom agent launcher for Codex as an Agent Skill
|
|
* @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 skill
|
|
*/
|
|
async installCustomAgentLauncher(projectDir, agentName, agentPath, metadata) {
|
|
const destDir = this.getCodexSkillsDir(projectDir, 'project');
|
|
|
|
// Skill name from the dash name (without .md)
|
|
const skillName = customAgentDashName(agentName).replace(/\.md$/, '');
|
|
const skillDir = path.join(destDir, skillName);
|
|
await fs.ensureDir(skillDir);
|
|
|
|
const skillContent = `---
|
|
name: ${skillName}
|
|
description: '${agentName} agent'
|
|
---
|
|
|
|
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>
|
|
`;
|
|
|
|
const skillPath = path.join(skillDir, 'SKILL.md');
|
|
await fs.writeFile(skillPath, skillContent, 'utf8');
|
|
|
|
return {
|
|
path: path.relative(projectDir, skillPath),
|
|
command: `$${skillName}`,
|
|
};
|
|
}
|
|
}
|
|
|
|
module.exports = { CodexSetup };
|