@patricio0312rev/agentkit 0.1.0

package/src/lib/generator.js

@@ -0,0 +1,193 @@
+const fs = require('fs-extra');
+const path = require('path');
+const { TOOLS, DEPARTMENTS } = require('./config');
+const { generateReadme } = require('../utils/readme');
+const { generateToolSpecificFiles } = require('../utils/tool-specific');
+
+/**
+ * Main generator function that creates AI agent configuration
+ * @param {Object} config - Configuration object
+ * @returns {Promise<Object>} Generation result
+ */
+async function generateAgents(config) {
+  const targetDir = path.join(process.cwd(), config.folder);
+  const result = {
+    success: false,
+    targetDir,
+    agentsGenerated: 0,
+    filesCreated: [],
+    errors: []
+  };
+
+  try {
+    // Ensure target directory exists
+    await fs.ensureDir(targetDir);
+
+    // Generate department folders and agent files
+    const agentResult = await generateDepartmentAgents(config, targetDir);
+    result.agentsGenerated = agentResult.count;
+    result.filesCreated.push(...agentResult.files);
+
+    // Generate README
+    const readmePath = path.join(targetDir, 'README.md');
+    const readmeContent = generateReadme(config, result);
+    await fs.writeFile(readmePath, readmeContent);
+    result.filesCreated.push(readmePath);
+
+    // Generate tool-specific files (e.g., .cursorrules, copilot-instructions.md)
+    const toolFiles = await generateToolSpecificFiles(config, targetDir, agentResult.agentsList);
+    result.filesCreated.push(...toolFiles);
+
+    result.success = true;
+    return result;
+
+  } catch (error) {
+    result.errors.push(error.message);
+    throw error;
+  }
+}
+
+/**
+ * Generate department folders and copy agent files
+ * @param {Object} config - Configuration object
+ * @param {string} targetDir - Target directory path
+ * @returns {Promise<Object>} Result with count and file list
+ */
+async function generateDepartmentAgents(config, targetDir) {
+  let count = 0;
+  const files = [];
+  const agentsList = [];
+
+  for (const dept of config.departments) {
+    const deptInfo = DEPARTMENTS[dept];
+    if (!deptInfo) continue;
+
+    const deptDir = path.join(targetDir, dept);
+    await fs.ensureDir(deptDir);
+
+    // Determine which agents to generate
+    let agentsToGenerate = deptInfo.agents;
+    
+    // Filter if specific agents were selected
+    if (config.agents && config.agents.length > 0) {
+      agentsToGenerate = agentsToGenerate.filter(agent => {
+        // Support both "agent-name" and "dept/agent-name" formats
+        return config.agents.includes(agent) || 
+               config.agents.includes(`${dept}/${agent}`);
+      });
+    }
+
+    // Copy/generate each agent file
+    for (const agent of agentsToGenerate) {
+      const agentFile = await generateAgentFile(dept, agent, deptDir, config);
+      if (agentFile) {
+        files.push(agentFile);
+        agentsList.push({ dept, agent, file: agentFile });
+        count++;
+      }
+    }
+  }
+
+  return { count, files, agentsList };
+}
+
+/**
+ * Generate or copy an individual agent file
+ * @param {string} dept - Department name
+ * @param {string} agent - Agent name
+ * @param {string} deptDir - Department directory path
+ * @param {Object} config - Configuration object
+ * @returns {Promise<string|null>} Path to created file or null
+ */
+async function generateAgentFile(dept, agent, deptDir, config) {
+  const sourceFile = path.join(__dirname, '../../templates/departments', dept, `${agent}.md`);
+  const targetFile = path.join(deptDir, `${agent}.md`);
+
+  try {
+    // Check if template exists
+    if (await fs.pathExists(sourceFile)) {
+      let content = await fs.readFile(sourceFile, 'utf8');
+
+      // Process content based on config
+      content = processAgentContent(content, config);
+
+      await fs.writeFile(targetFile, content);
+      return targetFile;
+    } else {
+      // Generate basic template if source doesn't exist
+      const basicTemplate = generateBasicAgentTemplate(dept, agent);
+      await fs.writeFile(targetFile, basicTemplate);
+      return targetFile;
+    }
+  } catch (error) {
+    console.error(`Error generating agent ${agent}:`, error.message);
+    return null;
+  }
+}
+
+/**
+ * Process agent content based on configuration
+ * @param {string} content - Original content
+ * @param {Object} config - Configuration object
+ * @returns {string} Processed content
+ */
+function processAgentContent(content, config) {
+  let processed = content;
+
+  // Remove examples if requested
+  if (config.skipExamples) {
+    // Remove content between <example> tags
+    processed = processed.replace(/<example>[\s\S]*?<\/example>/g, '');
+    // Clean up extra whitespace
+    processed = processed.replace(/\n{3,}/g, '\n\n');
+  }
+
+  // Add tech stack information if provided
+  if (config.stack && config.stack.length > 0) {
+    const stackSection = `\n\n## Tech Stack Context\n\nThis project uses: ${config.stack.join(', ')}\n`;
+    // Insert before the main content or at the end
+    processed += stackSection;
+  }
+
+  return processed;
+}
+
+/**
+ * Generate a basic agent template when source file doesn't exist
+ * @param {string} dept - Department name
+ * @param {string} agent - Agent name
+ * @returns {string} Basic template content
+ */
+function generateBasicAgentTemplate(dept, agent) {
+  const deptInfo = DEPARTMENTS[dept];
+  return `<!-- ${dept}/${agent}.md -->
+---
+name: ${agent}
+description: AI agent for ${deptInfo.name}
+color: blue
+tools: Read, Write, MultiEdit
+---
+
+# ${agent.split('-').map(w => w.charAt(0).toUpperCase() + w.slice(1)).join(' ')}
+
+This is a placeholder agent file. Please add specific instructions and responsibilities.
+
+## Responsibilities
+
+- [Add specific responsibilities]
+
+## Best Practices
+
+- [Add best practices]
+
+## Examples
+
+- [Add usage examples]
+`;
+}
+
+module.exports = {
+  generateAgents,
+  generateDepartmentAgents,
+  generateAgentFile
+};

package/src/utils/display.js

@@ -0,0 +1,95 @@
+const chalk = require("chalk");
+
+function displayBanner() {
+  const version = require("../../package.json").version;
+  console.log(
+    chalk.cyan(
+      "\n" +
+        "  ╔═══════════════════════════════════════════╗\n" +
+        "  ║                                           ║\n" +
+        "  ║      🤖  AgentKit CLI v" +
+        version.padEnd(19) +
+        "║\n" +
+        "  ║                                           ║\n" +
+        "  ║     Scaffold AI agent configurations      ║\n" +
+        "  ║     for Claude Code, Cursor & more        ║\n" +
+        "  ║                                           ║\n" +
+        "  ╚═══════════════════════════════════════════╝\n"
+    )
+  );
+}
+
+function displaySuccess(message) {
+  console.log(chalk.green(`\n✓ ${message}\n`));
+}
+
+function displayError(message) {
+  console.log(chalk.red(`\n✗ ${message}\n`));
+}
+
+function displayWarning(message) {
+  console.log(chalk.yellow(`\n⚠ ${message}\n`));
+}
+
+function displayInfo(message) {
+  console.log(chalk.blue(`\nℹ ${message}\n`));
+}
+
+/**
+ * Display content in a nice box with consistent formatting
+ * @param {string} title - Box title
+ * @param {string} content - Box content
+ */
+function displayBox(title, content) {
+  const lines = content.split("\n");
+
+  // Calculate max width needed
+  const contentWidth = Math.max(
+    ...lines.map((line) => stripAnsi(line).length),
+    stripAnsi(title).length
+  );
+
+  // Set minimum and maximum width
+  const minWidth = 50;
+  const maxWidth = 80;
+  const width = Math.min(Math.max(contentWidth, minWidth), maxWidth);
+
+  // Top border
+  console.log(chalk.cyan("┌" + "─".repeat(width + 2) + "┐"));
+
+  // Title
+  const titlePadded = title + " ".repeat(width - stripAnsi(title).length);
+  console.log(chalk.cyan("│ ") + chalk.bold(titlePadded) + chalk.cyan(" │"));
+
+  // Separator
+  console.log(chalk.cyan("├" + "─".repeat(width + 2) + "┤"));
+
+  // Content lines
+  lines.forEach((line) => {
+    const lineLength = stripAnsi(line).length;
+    const padding = " ".repeat(width - lineLength);
+    console.log(chalk.cyan("│ ") + line + padding + chalk.cyan(" │"));
+  });
+
+  // Bottom border
+  console.log(chalk.cyan("└" + "─".repeat(width + 2) + "┘\n"));
+}
+
+/**
+ * Strip ANSI color codes to get actual string length
+ * @param {string} str - String with potential ANSI codes
+ * @returns {string} Clean string
+ */
+function stripAnsi(str) {
+  // eslint-disable-next-line no-control-regex
+  return str.replace(/\x1B\[\d+m/g, "");
+}
+
+module.exports = {
+  displayBanner,
+  displaySuccess,
+  displayError,
+  displayWarning,
+  displayInfo,
+  displayBox,
+};

package/src/utils/readme.js

@@ -0,0 +1,191 @@
+const { TOOLS, DEPARTMENTS } = require('../lib/config');
+
+/**
+ * Generate README.md content for the generated configuration
+ * @param {Object} config - Configuration object
+ * @param {Object} result - Generation result
+ * @returns {string} README content
+ */
+function generateReadme(config, result) {
+  const tool = TOOLS[config.tool];
+  const timestamp = new Date().toISOString();
+
+  return `# AI Agents Configuration
+
+> Generated with [AgentKit](https://github.com/patricio0312rev/agentkit) 🤖
+
+## 📋 Overview
+
+- **Tool**: ${tool.name}
+- **Location**: \`${config.folder}/\`
+- **Departments**: ${config.departments.length}
+- **Agents**: ${result.agentsGenerated}
+- **Generated**: ${new Date().toLocaleString()}
+
+## 🚀 Usage
+
+${getDetailedUsageInstructions(config.tool)}
+
+## 📁 Structure
+
+\`\`\`
+${config.folder}/
+${generateStructureTree(config)}
+\`\`\`
+
+## 🏢 Departments Included
+
+${generateDepartmentsList(config)}
+
+${config.stack.length > 0 ? generateStackSection(config.stack) : ''}
+
+## 🔄 Updating
+
+To regenerate or update your configuration:
+
+\`\`\`bash
+npx agentkit init
+\`\`\`
+
+Or if installed globally:
+
+\`\`\`bash
+agentkit init
+\`\`\`
+
+## 📚 Resources
+
+- [AgentKit Documentation](https://github.com/patricio0312rev/agentkit)
+- [Claude Code Documentation](https://code.claude.com/docs)
+- [Cursor Documentation](https://cursor.sh/docs)
+
+## 💡 Tips
+
+- Commit these files to version control
+- Share with your team for consistent AI assistance
+- Update regularly as your project evolves
+- Customize agent instructions for your specific needs
+
+---
+
+*Generated by AgentKit v${require('../../package.json').version}*
+`;
+}
+
+function getDetailedUsageInstructions(tool) {
+  const instructions = {
+    'claude-code': `### With Claude Code CLI
+
+The agents in this folder are automatically loaded by Claude Code.
+
+\`\`\`bash
+# Use agents in your prompts naturally
+claude-code "Build a login page using the frontend-developer patterns"
+
+# Reference specific agents
+claude-code "Review this API design with the backend-architect agent"
+\`\`\`
+
+### Sub-Agent System
+
+Claude Code's sub-agent system allows multiple specialized agents to work together on complex tasks.`,
+
+    'cursor': `### With Cursor
+
+**Method 1: @-mentions**
+
+\`\`\`
+In Cursor chat, use @-mentions:
+@engineering/backend-architect.md Design a REST API for user management
+\`\`\`
+
+**Method 2: Natural References**
+
+Just reference the agent naturally in your prompts:
+\`\`\`
+"Using the backend-architect guidelines, design an API..."
+\`\`\`
+
+### Settings
+
+1. Cursor automatically detects agent files in common folders
+2. You can also configure custom folders in Cursor settings`,
+
+    'copilot': `### With GitHub Copilot
+
+The configuration file is located at:
+\`\`\`
+.github/copilot-instructions.md
+\`\`\`
+
+GitHub Copilot will automatically use these instructions when:
+- Writing code
+- Suggesting completions
+- Answering questions in chat
+
+No additional setup required!`,
+
+    'universal': `### With Any AI Tool
+
+1. **Upload Method**: Upload relevant agent .md files to your AI chat
+2. **Reference**: Reference them in your prompts
+3. **Copy-Paste**: Or copy agent content directly into context
+
+Example:
+\`\`\`
+[Upload: engineering/backend-architect.md]
+
+"Following the backend-architect guidelines, help me design..."
+\`\`\``
+  };
+
+  return instructions[tool] || instructions.universal;
+}
+
+function generateStructureTree(config) {
+  const lines = ['├── README.md'];
+  
+  config.departments.forEach((dept, index) => {
+    const isLast = index === config.departments.length - 1;
+    const prefix = isLast ? '└──' : '├──';
+    lines.push(`${prefix} ${dept}/`);
+    
+    const agents = DEPARTMENTS[dept].agents;
+    agents.forEach((agent, agentIndex) => {
+      const agentIsLast = agentIndex === agents.length - 1;
+      const agentPrefix = isLast ? '    ' : '│   ';
+      const agentMarker = agentIsLast ? '└──' : '├──';
+      lines.push(`${agentPrefix}${agentMarker} ${agent}.md`);
+    });
+  });
+
+  return lines.join('\n');
+}
+
+function generateDepartmentsList(config) {
+  return config.departments.map(dept => {
+    const deptInfo = DEPARTMENTS[dept];
+    return `### ${deptInfo.name}
+
+${deptInfo.description}
+
+**Agents** (${deptInfo.agents.length}):
+${deptInfo.agents.map(agent => `- \`${agent}\``).join('\n')}
+`;
+  }).join('\n');
+}
+
+function generateStackSection(stack) {
+  return `## 🛠️ Tech Stack
+
+This configuration is optimized for:
+
+${stack.map(tech => `- ${tech}`).join('\n')}
+
+Agents are aware of this stack and will provide relevant guidance.
+`;
+}
+
+module.exports = {
+  generateReadme
+};