create-byan-agent 1.1.3 → 1.2.0

package/lib/errors.js

@@ -0,0 +1,61 @@
+/**
+ * Custom Error Classes
+ * 
+ * @module errors
+ */
+
+class YanInstallerError extends Error {
+  constructor(message, options) {
+    super(message, options);
+    this.name = 'YanInstallerError';
+  }
+}
+
+class NodeVersionError extends YanInstallerError {
+  constructor(required, current) {
+    super(`Node.js ${required}+ required, got ${current}`);
+    this.name = 'NodeVersionError';
+    this.required = required;
+    this.current = current;
+  }
+}
+
+class PlatformNotFoundError extends YanInstallerError {
+  constructor(platform) {
+    super(`Platform not found: ${platform}`);
+    this.name = 'PlatformNotFoundError';
+    this.platform = platform;
+  }
+}
+
+class PermissionError extends YanInstallerError {
+  constructor(path) {
+    super(`Permission denied: ${path}`);
+    this.name = 'PermissionError';
+    this.path = path;
+  }
+}
+
+class ValidationError extends YanInstallerError {
+  constructor(message, failures) {
+    super(message);
+    this.name = 'ValidationError';
+    this.failures = failures;
+  }
+}
+
+class BackupError extends YanInstallerError {
+  constructor(message, options) {
+    super(message, options);
+    this.name = 'BackupError';
+  }
+}
+
+module.exports = {
+  YanInstallerError,
+  NodeVersionError,
+  PlatformNotFoundError,
+  PermissionError,
+  ValidationError,
+  BackupError
+};

package/lib/exit-codes.js

@@ -0,0 +1,54 @@
+/**
+ * Exit Codes
+ * 
+ * Standard exit codes for YANSTALLER CLI.
+ * 
+ * @module exit-codes
+ */
+
+module.exports = {
+  /**
+   * Success - Installation completed without errors
+   */
+  SUCCESS: 0,
+
+  /**
+   * Node.js version too old (< 18.0.0)
+   */
+  NODE_VERSION_ERROR: 1,
+
+  /**
+   * Permission denied (file system access)
+   */
+  PERMISSION_ERROR: 2,
+
+  /**
+   * Post-installation validation failed
+   */
+  VALIDATION_FAILED: 3,
+
+  /**
+   * Installation process failed
+   */
+  INSTALLATION_FAILED: 4,
+
+  /**
+   * Backup operation failed
+   */
+  BACKUP_FAILED: 5,
+
+  /**
+   * Platform not found or not supported
+   */
+  PLATFORM_ERROR: 6,
+
+  /**
+   * User cancelled installation
+   */
+  USER_CANCELLED: 7,
+
+  /**
+   * Unknown error
+   */
+  UNKNOWN_ERROR: 99
+};

package/lib/platforms/claude-code.js

@@ -0,0 +1,113 @@
+/**
+ * Claude Code Platform Support
+ * 
+ * Detects and installs MCP server config for Claude Code.
+ * 
+ * @module platforms/claude-code
+ */
+
+const path = require('path');
+const os = require('os');
+const fileUtils = require('../utils/file-utils');
+
+const PLATFORM_NAME = 'Claude Code';
+
+/**
+ * Get config path for current platform
+ * 
+ * @returns {string|null}
+ */
+function getConfigPath() {
+  const platform = os.platform();
+  const home = os.homedir();
+  
+  switch (platform) {
+    case 'darwin':
+      return path.join(home, 'Library/Application Support/Claude/claude_desktop_config.json');
+    case 'win32':
+      return path.join(home, 'AppData/Roaming/Claude/claude_desktop_config.json');
+    case 'linux':
+      return path.join(home, '.config/Claude/claude_desktop_config.json');
+    default:
+      return null;
+  }
+}
+
+/**
+ * Detect if Claude Code is installed
+ * 
+ * @returns {Promise<boolean>}
+ */
+async function detect() {
+  const configPath = getConfigPath();
+  if (!configPath) return false;
+  
+  return fileUtils.exists(configPath);
+}
+
+/**
+ * Install MCP server config for Claude Code
+ * 
+ * @param {string} projectRoot - Project root directory
+ * @param {string[]} agents - Agent names to install
+ * @param {Object} config - Installation config
+ * @returns {Promise<{success: boolean, installed: number}>}
+ */
+async function install(projectRoot, agents, config) {
+  const configPath = getConfigPath();
+  
+  if (!configPath) {
+    throw new Error(`Unsupported platform: ${os.platform()}`);
+  }
+  
+  // Read existing config or create new
+  let desktopConfig = {};
+  if (await fileUtils.exists(configPath)) {
+    const content = await fileUtils.readFile(configPath, 'utf8');
+    desktopConfig = JSON.parse(content);
+  }
+  
+  // Ensure mcpServers exists
+  if (!desktopConfig.mcpServers) {
+    desktopConfig.mcpServers = {};
+  }
+  
+  // Add BYAN MCP server if not exists
+  if (!desktopConfig.mcpServers.byan) {
+    desktopConfig.mcpServers.byan = {
+      command: 'npx',
+      args: ['-y', '@byan/mcp-server'],
+      env: {
+        BYAN_PROJECT_ROOT: projectRoot
+      }
+    };
+  }
+  
+  // Write updated config
+  await fileUtils.ensureDir(path.dirname(configPath));
+  await fileUtils.writeFile(
+    configPath,
+    JSON.stringify(desktopConfig, null, 2)
+  );
+  
+  return {
+    success: true,
+    installed: agents.length
+  };
+}
+
+/**
+ * Get platform installation path
+ * 
+ * @returns {string}
+ */
+function getPath() {
+  return getConfigPath() || 'unknown';
+}
+
+module.exports = {
+  name: PLATFORM_NAME,
+  detect,
+  install,
+  getPath
+};

package/lib/platforms/codex.js

@@ -0,0 +1,92 @@
+/**
+ * Codex Platform Support
+ * 
+ * Detects and installs agents for Codex.
+ * 
+ * @module platforms/codex
+ */
+
+const path = require('path');
+const fileUtils = require('../utils/file-utils');
+
+const PLATFORM_NAME = 'Codex';
+const PROMPTS_DIR = '.codex/prompts';
+
+/**
+ * Detect if Codex is configured
+ * 
+ * @returns {Promise<boolean>}
+ */
+async function detect() {
+  // Check if .codex/prompts/ directory exists
+  return fileUtils.exists(PROMPTS_DIR);
+}
+
+/**
+ * Install agents for Codex
+ * 
+ * @param {string} projectRoot - Project root directory
+ * @param {string[]} agents - Agent names to install
+ * @param {Object} config - Installation config
+ * @returns {Promise<{success: boolean, installed: number}>}
+ */
+async function install(projectRoot, agents, config) {
+  const promptsDir = path.join(projectRoot, PROMPTS_DIR);
+  await fileUtils.ensureDir(promptsDir);
+  
+  let installed = 0;
+  
+  for (const agentName of agents) {
+    await generatePrompt(promptsDir, agentName, config);
+    installed++;
+  }
+  
+  return {
+    success: true,
+    installed
+  };
+}
+
+/**
+ * Generate Codex prompt file
+ * 
+ * @param {string} promptsDir - Prompts directory path
+ * @param {string} agentName - Agent name
+ * @param {Object} config - Installation config
+ * @returns {Promise<void>}
+ */
+async function generatePrompt(promptsDir, agentName, config) {
+  const promptPath = path.join(promptsDir, `${agentName}.md`);
+  
+  const content = `# ${agentName} Agent
+
+You must fully embody this agent's persona and follow all activation instructions exactly as specified.
+
+<agent-activation CRITICAL="TRUE">
+1. LOAD the FULL agent file from {project-root}/_bmad/*/agents/${agentName}.md
+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>
+`;
+  
+  await fileUtils.writeFile(promptPath, content);
+}
+
+/**
+ * Get platform installation path
+ * 
+ * @returns {string}
+ */
+function getPath() {
+  return PROMPTS_DIR;
+}
+
+module.exports = {
+  name: PLATFORM_NAME,
+  detect,
+  install,
+  getPath
+};

package/lib/platforms/copilot-cli.js

@@ -0,0 +1,123 @@
+/**
+ * GitHub Copilot CLI Platform Support
+ * 
+ * Detects and installs agents for GitHub Copilot CLI.
+ * 
+ * @module platforms/copilot-cli
+ */
+
+const path = require('path');
+const fileUtils = require('../utils/file-utils');
+const yamlUtils = require('../utils/yaml-utils');
+const { execSync } = require('child_process');
+
+const PLATFORM_NAME = 'GitHub Copilot CLI';
+const STUB_DIR = '.github/agents';
+
+/**
+ * Detect if Copilot CLI is installed
+ * 
+ * With 10s timeout protection to prevent hanging.
+ * 
+ * @returns {Promise<boolean|{detected: boolean, error: string}>}
+ */
+async function detect() {
+  // Timeout promise (10 seconds)
+  const timeoutPromise = new Promise((resolve) =>
+    setTimeout(() => resolve({
+      detected: false,
+      error: 'Detection timeout after 10s'
+    }), 10000)
+  );
+
+  // Detection promise
+  const detectionPromise = (async () => {
+    try {
+      // Check if github-copilot-cli is installed
+      execSync('which github-copilot-cli', { encoding: 'utf8', stdio: 'ignore' });
+      return true;
+    } catch {
+      // Also check for .github/agents/ directory
+      return fileUtils.exists(STUB_DIR);
+    }
+  })();
+
+  // Race between detection and timeout
+  return Promise.race([detectionPromise, timeoutPromise]);
+}
+
+/**
+ * Install agents for Copilot CLI
+ * 
+ * @param {string} projectRoot - Project root directory
+ * @param {string[]} agents - Agent names to install
+ * @param {Object} config - Installation config
+ * @returns {Promise<{success: boolean, installed: number}>}
+ */
+async function install(projectRoot, agents, config) {
+  const stubsDir = path.join(projectRoot, STUB_DIR);
+  await fileUtils.ensureDir(stubsDir);
+  
+  let installed = 0;
+  
+  for (const agentName of agents) {
+    await generateStub(stubsDir, agentName, config);
+    installed++;
+  }
+  
+  return {
+    success: true,
+    installed
+  };
+}
+
+/**
+ * Generate Copilot CLI stub with YAML frontmatter
+ * 
+ * @param {string} stubsDir - Stubs directory path
+ * @param {string} agentName - Agent name
+ * @param {Object} config - Installation config
+ * @returns {Promise<void>}
+ */
+async function generateStub(stubsDir, agentName, config) {
+  const stubPath = path.join(stubsDir, `${agentName}.md`);
+  
+  const frontmatter = {
+    name: agentName,
+    description: `${agentName} agent from BYAN platform`
+  };
+  
+  const content = `---
+${yamlUtils.dump(frontmatter).trim()}
+---
+
+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 {project-root}/_bmad/*/agents/${agentName}.md
+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>
+`;
+  
+  await fileUtils.writeFile(stubPath, content);
+}
+
+/**
+ * Get platform installation path
+ * 
+ * @returns {string}
+ */
+function getPath() {
+  return STUB_DIR;
+}
+
+module.exports = {
+  name: PLATFORM_NAME,
+  detect,
+  install,
+  getPath
+};

package/lib/platforms/index.js

@@ -0,0 +1,14 @@
+/**
+ * Platforms Index
+ * 
+ * Exports all platform modules.
+ * 
+ * @module platforms
+ */
+
+module.exports = {
+  'copilot-cli': require('./copilot-cli'),
+  'vscode': require('./vscode'),
+  'claude': require('./claude-code'),
+  'codex': require('./codex')
+};

package/lib/platforms/vscode.js

@@ -0,0 +1,51 @@
+/**
+ * VSCode Copilot Extension Platform Support
+ * 
+ * Detects and installs agents for VSCode Copilot Extension.
+ * Same format as Copilot CLI.
+ * 
+ * @module platforms/vscode
+ */
+
+const copilotCli = require('./copilot-cli');
+
+const PLATFORM_NAME = 'VSCode Copilot Extension';
+
+/**
+ * Detect if VSCode with Copilot extension is installed
+ * 
+ * @returns {Promise<boolean>}
+ */
+async function detect() {
+  // VSCode uses same stub format as Copilot CLI
+  return copilotCli.detect();
+}
+
+/**
+ * Install agents for VSCode
+ * 
+ * @param {string} projectRoot - Project root directory
+ * @param {string[]} agents - Agent names to install
+ * @param {Object} config - Installation config
+ * @returns {Promise<{success: boolean, installed: number}>}
+ */
+async function install(projectRoot, agents, config) {
+  // Reuse Copilot CLI installation (same format)
+  return copilotCli.install(projectRoot, agents, config);
+}
+
+/**
+ * Get platform installation path
+ * 
+ * @returns {string}
+ */
+function getPath() {
+  return copilotCli.getPath();
+}
+
+module.exports = {
+  name: PLATFORM_NAME,
+  detect,
+  install,
+  getPath
+};

package/lib/utils/config-loader.js

@@ -0,0 +1,79 @@
+/**
+ * Config Loader Utility
+ * 
+ * Loads configuration files with variable resolution.
+ * 
+ * @module utils/config-loader
+ */
+
+const path = require('path');
+const yamlUtils = require('./yaml-utils');
+
+/**
+ * Load config file and resolve variables
+ * 
+ * @param {string} configPath - Path to config.yaml
+ * @param {Object} context - Context for variable resolution
+ * @returns {Promise<Object>}
+ */
+async function loadConfig(configPath, context = {}) {
+  const config = await yamlUtils.readYAML(configPath);
+  return resolveVariables(config, context);
+}
+
+/**
+ * Resolve variables in config object
+ * 
+ * @param {Object} config - Config object
+ * @param {Object} context - Context for variable resolution
+ * @returns {Object}
+ */
+function resolveVariables(config, context) {
+  const resolved = {};
+  
+  for (const [key, value] of Object.entries(config)) {
+    if (typeof value === 'string') {
+      resolved[key] = resolveVariable(value, context);
+    } else if (typeof value === 'object' && value !== null) {
+      resolved[key] = resolveVariables(value, context);
+    } else {
+      resolved[key] = value;
+    }
+  }
+  
+  return resolved;
+}
+
+/**
+ * Resolve single variable string
+ * 
+ * @param {string} value - Value with potential variables
+ * @param {Object} context - Context for variable resolution
+ * @returns {string}
+ */
+function resolveVariable(value, context) {
+  let resolved = value;
+  
+  // Replace {project-root}
+  if (context.projectRoot) {
+    resolved = resolved.replace(/\{project-root\}/g, context.projectRoot);
+  }
+  
+  // Replace {output_folder}
+  if (context.outputFolder) {
+    resolved = resolved.replace(/\{output_folder\}/g, context.outputFolder);
+  }
+  
+  // Replace {user_name}
+  if (context.userName) {
+    resolved = resolved.replace(/\{user_name\}/g, context.userName);
+  }
+  
+  return resolved;
+}
+
+module.exports = {
+  loadConfig,
+  resolveVariables,
+  resolveVariable
+};

package/lib/utils/file-utils.js

@@ -0,0 +1,104 @@
+/**
+ * File Utilities
+ * 
+ * Wrapper around fs-extra for common file operations.
+ * 
+ * @module utils/file-utils
+ */
+
+const fs = require('fs-extra');
+const path = require('path');
+
+/**
+ * Copy file or directory
+ * 
+ * @param {string} src - Source path
+ * @param {string} dest - Destination path
+ * @returns {Promise<void>}
+ */
+async function copy(src, dest) {
+  await fs.copy(src, dest);
+}
+
+/**
+ * Check if path exists
+ * 
+ * @param {string} filePath - File or directory path
+ * @returns {Promise<boolean>}
+ */
+async function exists(filePath) {
+  return fs.pathExists(filePath);
+}
+
+/**
+ * Ensure directory exists (create if not)
+ * 
+ * @param {string} dirPath - Directory path
+ * @returns {Promise<void>}
+ */
+async function ensureDir(dirPath) {
+  await fs.ensureDir(dirPath);
+}
+
+/**
+ * Remove file or directory
+ * 
+ * @param {string} filePath - File or directory path
+ * @returns {Promise<void>}
+ */
+async function remove(filePath) {
+  await fs.remove(filePath);
+}
+
+/**
+ * Read JSON file
+ * 
+ * @param {string} filePath - JSON file path
+ * @returns {Promise<Object>}
+ */
+async function readJSON(filePath) {
+  return fs.readJSON(filePath);
+}
+
+/**
+ * Write JSON file
+ * 
+ * @param {string} filePath - JSON file path
+ * @param {Object} data - Data to write
+ * @returns {Promise<void>}
+ */
+async function writeJSON(filePath, data) {
+  await fs.writeJSON(filePath, data, { spaces: 2 });
+}
+
+/**
+ * Read text file
+ * 
+ * @param {string} filePath - Text file path
+ * @returns {Promise<string>}
+ */
+async function readFile(filePath) {
+  return fs.readFile(filePath, 'utf8');
+}
+
+/**
+ * Write text file
+ * 
+ * @param {string} filePath - Text file path
+ * @param {string} content - Content to write
+ * @returns {Promise<void>}
+ */
+async function writeFile(filePath, content) {
+  await fs.writeFile(filePath, content, 'utf8');
+}
+
+module.exports = {
+  copy,
+  exists,
+  ensureDir,
+  remove,
+  readJSON,
+  writeJSON,
+  readFile,
+  writeFile
+};