code-framework 1.0.0 → 1.1.0

package/install.js

@@ -9,6 +9,7 @@
 
 const fs = require('fs');
 const path = require('path');
+const readline = require('readline');
 
 const LOGO = `
  ██████╗ ██████╗ ██████╗ ███████╗
@@ -25,16 +26,115 @@ Context. Outline. Documentation. Evolve.
 const colors = {
   reset: '\x1b[0m',
   bright: '\x1b[1m',
+  dim: '\x1b[2m',
   green: '\x1b[32m',
   cyan: '\x1b[36m',
   yellow: '\x1b[33m',
   red: '\x1b[31m',
+  magenta: '\x1b[35m',
+};
+
+// CLI tool configurations
+const CLI_TOOLS = {
+  'claude-code': {
+    name: 'Claude Code',
+    description: 'Anthropic\'s official CLI for Claude',
+    configFile: '.claude/commands.yaml',
+    settingsFile: '.claude/settings.json',
+    instructionsFile: 'CLAUDE.md',
+    recommended: true,
+  },
+  'antigravity': {
+    name: 'Antigravity',
+    description: 'AI-powered development assistant',
+    configFile: '.antigravity/commands.yaml',
+    settingsFile: '.antigravity/settings.json',
+    instructionsFile: 'ANTIGRAVITY.md',
+    recommended: false,
+  },
+  'opencode': {
+    name: 'OpenCode',
+    description: 'Open source AI coding assistant',
+    configFile: '.opencode/commands.yaml',
+    settingsFile: '.opencode/settings.json',
+    instructionsFile: 'OPENCODE.md',
+    recommended: false,
+  },
+  'cursor': {
+    name: 'Cursor',
+    description: 'AI-first code editor',
+    configFile: '.cursor/rules',
+    settingsFile: null,
+    instructionsFile: '.cursorrules',
+    recommended: true,
+  },
+  'windsurf': {
+    name: 'Windsurf',
+    description: 'Codeium\'s AI IDE',
+    configFile: '.windsurf/rules',
+    settingsFile: null,
+    instructionsFile: '.windsurfrules',
+    recommended: false,
+  },
+  'aider': {
+    name: 'Aider',
+    description: 'AI pair programming in your terminal',
+    configFile: '.aider.conf.yml',
+    settingsFile: null,
+    instructionsFile: 'CONVENTIONS.md',
+    recommended: false,
+  },
+  'cline': {
+    name: 'Cline',
+    description: 'VS Code AI assistant',
+    configFile: '.cline/rules',
+    settingsFile: null,
+    instructionsFile: '.clinerules',
+    recommended: false,
+  },
 };
 
 function log(msg, color = '') {
   console.log(`${color}${msg}${colors.reset}`);
 }
 
+function createPrompt() {
+  return readline.createInterface({
+    input: process.stdin,
+    output: process.stdout,
+  });
+}
+
+async function ask(rl, question) {
+  return new Promise((resolve) => {
+    rl.question(question, resolve);
+  });
+}
+
+async function selectMultiple(rl, message, options) {
+  console.log(`\n${colors.cyan}${message}${colors.reset}\n`);
+
+  options.forEach((opt, i) => {
+    const marker = opt.recommended ? `${colors.green}⭐${colors.reset}` : '  ';
+    const check = opt.selected ? `${colors.green}[✓]${colors.reset}` : '[ ]';
+    console.log(`  ${i + 1}. ${check} ${marker} ${opt.name} ${colors.dim}- ${opt.description}${colors.reset}`);
+  });
+
+  console.log(`\n${colors.dim}Enter numbers separated by commas (e.g., 1,2,4) or 'all' or 'none':${colors.reset}`);
+  const answer = await ask(rl, '> ');
+
+  if (answer.toLowerCase() === 'all') {
+    return options.map((_, i) => i);
+  }
+  if (answer.toLowerCase() === 'none' || answer.trim() === '') {
+    return [];
+  }
+
+  return answer.split(',')
+    .map(s => parseInt(s.trim()) - 1)
+    .filter(n => !isNaN(n) && n >= 0 && n < options.length);
+}
+
 function copyRecursive(src, dest) {
   const stats = fs.statSync(src);
 
@@ -45,7 +145,6 @@ function copyRecursive(src, dest) {
 
     const files = fs.readdirSync(src);
     for (const file of files) {
-      // Skip .git folder
       if (file === '.git') continue;
       copyRecursive(path.join(src, file), path.join(dest, file));
     }
@@ -54,139 +153,342 @@ function copyRecursive(src, dest) {
   }
 }
 
-function install(targetDir = process.cwd()) {
-  console.log(colors.cyan + LOGO + colors.reset);
-
-  log('\n📦 Installing CODE Framework...\n', colors.bright);
-
-  const sourceDir = __dirname;
-  const codeDir = path.join(targetDir, '_code');
-  const projectTemplateDir = path.join(sourceDir, 'project-template');
-
-  // Check if already installed
-  if (fs.existsSync(codeDir)) {
-    log('⚠️  CODE framework already installed in this directory.', colors.yellow);
-    log('   Use --force to overwrite.\n');
+function generateInstructionsFile(toolId, targetDir) {
+  const tool = CLI_TOOLS[toolId];
+  const commandPrefix = 'code';
 
-    if (!process.argv.includes('--force')) {
-      process.exit(1);
-    }
-    log('   --force detected, overwriting...\n', colors.yellow);
-  }
+  const content = `# CODE Framework
 
-  // Copy _code framework
-  log('📁 Copying framework files...', colors.cyan);
-  copyRecursive(path.join(sourceDir, '_code'), codeDir);
-  log('   ✓ _code/ folder created\n', colors.green);
-
-  // Copy project template folders
-  log('📁 Creating project structure...', colors.cyan);
-
-  const folders = [
-    '1-context',
-    '2-outline',
-    '3-ux',
-    '4-documentation',
-    '5-evolution',
-    'research',
-    '.claude'
-  ];
-
-  for (const folder of folders) {
-    const srcFolder = path.join(projectTemplateDir, folder);
-    const destFolder = path.join(targetDir, folder);
-
-    if (fs.existsSync(srcFolder)) {
-      // Don't overwrite existing folders unless forced
-      if (fs.existsSync(destFolder) && !process.argv.includes('--force')) {
-        log(`   ⏭️  ${folder}/ exists, skipping`, colors.yellow);
-      } else {
-        copyRecursive(srcFolder, destFolder);
-        log(`   ✓ ${folder}/ created`, colors.green);
-      }
-    }
-  }
+This project uses the CODE Framework for AI-assisted development.
 
-  // Create CLAUDE.md for Claude Code integration
-  const claudeMd = `# CODE Framework
+## Quick Start
 
-This project uses the CODE Framework for AI-assisted development.
+Run \`/${commandPrefix}-help\` to see all available commands.
 
 ## Commands
 
 | Command | Description |
 |---------|-------------|
-| \`/sage\` | Start with SAGE - the orchestrator |
-| \`/brief\` | Fill out or improve your BRIEF |
-| \`/outline\` | Generate technical architecture |
-| \`/ux\` | Generate sitemap and wireframes |
-| \`/docs\` | Generate epics and stories |
-| \`/evolve\` | Add a new feature |
-| \`/implement\` | Start coding a story |
-| \`/party\` | Multi-agent discussion |
+| \`/${commandPrefix}-help\` | Show help and available commands |
+| \`/${commandPrefix}-status\` | Check project status and next steps |
+| \`/${commandPrefix}-sage\` | Start with SAGE - the orchestrator |
+| \`/${commandPrefix}-brief\` | Fill out or improve your BRIEF |
+| \`/${commandPrefix}-outline\` | Generate technical architecture |
+| \`/${commandPrefix}-ux\` | Generate sitemap and wireframes |
+| \`/${commandPrefix}-docs\` | Generate epics and stories |
+| \`/${commandPrefix}-implement\` | Start coding a story |
+| \`/${commandPrefix}-review\` | Quality review and testing |
+| \`/${commandPrefix}-evolve\` | Add a new feature/version |
+| \`/${commandPrefix}-party\` | Multi-agent discussion |
 
 ## Agents
 
-- **SAGE** 🧙 - Guide & Orchestrator
-- **IRIS** 🎯 - Context Architect (BRIEF)
-- **ATLAS** 🏗️ - Technical Architect
-- **LUNA** 🎨 - Experience Designer
-- **ECHO** 📖 - Story Keeper
-- **PHOENIX** 🚀 - Evolution Strategist
-- **BUILDER** 💻 - Developer
-- **SCOUT** 🧪 - Quality Guide
+| Agent | Role | Expertise |
+|-------|------|-----------|
+| **SAGE** 🧙 | Guide & Orchestrator | Routes to right agent, tracks progress |
+| **IRIS** 🎯 | Context Architect | Requirements, stakeholders, goals |
+| **ATLAS** 🏗️ | Technical Architect | Architecture, tech stack, schemas |
+| **LUNA** 🎨 | Experience Designer | UX, wireframes, user flows |
+| **ECHO** 📖 | Story Keeper | Epics, stories, documentation |
+| **PHOENIX** 🚀 | Evolution Strategist | Versioning, migrations, changelog |
+| **BUILDER** 💻 | Developer | Implementation, coding, integration |
+| **SCOUT** 🧪 | Quality Guide | Testing, review, quality gates |
 
 ## Project Structure
 
 \`\`\`
-1-context/          # BRIEF goes here (start here!)
+_code/              # Framework (read-only)
+├── agents/         # Agent definitions
+├── workflows/      # Workflow steps
+├── templates/      # Document templates
+└── checklists/     # Quality gates
+
+1-context/          # Your BRIEF (start here!)
+├── v1.0.0/         # Version folder
+│   ├── 1-brainstorm/
+│   ├── 2-requirements/
+│   ├── 3-inspiration/
+│   ├── 4-entities/
+│   └── 5-framework/
+
 2-outline/          # Technical architecture
 3-ux/               # Sitemap and wireframes
 4-documentation/    # Epics and stories
-5-evolution/        # Changelog
-_code/              # Framework (don't edit)
+5-evolution/        # Changelog and versions
+research/           # Research notes
 \`\`\`
 
-## Getting Started
+## Workflow
+
+1. **Brief** → Fill out context in \`1-context/v1.0.0/\`
+2. **Outline** → Generate technical architecture
+3. **UX** → Create sitemap and wireframes
+4. **Docs** → Generate epics and stories
+5. **Implement** → Build story by story
+6. **Review** → Quality check each story
+7. **Evolve** → Plan next version
+
+## Quality Gates
 
-1. Fill out the files in \`1-context/v1.0.0/\`
-2. Run \`/brief\` to have IRIS help you improve them
-3. Run \`/outline\` for technical architecture
-4. Run \`/ux\` for sitemap and wireframes
-5. Run \`/docs\` for epics and stories
-6. Run \`/implement\` to start building!
+Each workflow has quality checklists in \`_code/checklists/\`:
+- \`brief-checklist.md\` - Context completeness
+- \`architecture-checklist.md\` - Technical design review
+- \`story-checklist.md\` - Story quality review
+- \`code-review-checklist.md\` - Implementation review
+- \`pre-release-checklist.md\` - Release readiness
 
 ## Philosophy
 
 > "All ideas deserve a story."
 
-Every feature, every thought gets documented and tracked.
+Every feature gets documented, tracked, and evolved.
 `;
 
-  const claudePath = path.join(targetDir, 'CLAUDE.md');
-  if (!fs.existsSync(claudePath) || process.argv.includes('--force')) {
-    fs.writeFileSync(claudePath, claudeMd);
-    log('   ✓ CLAUDE.md created', colors.green);
-  } else {
-    log('   ⏭️  CLAUDE.md exists, skipping', colors.yellow);
+  return content;
+}
+
+function generateCommandsYaml() {
+  return `# CODE Framework Commands
+# All commands are prefixed with /code- to avoid conflicts
+
+commands:
+  # Help & Status
+  code-help:
+    description: "Show CODE framework help and available commands"
+    workflow: "_code/workflows/help.md"
+
+  code-status:
+    description: "Check project status and recommended next steps"
+    workflow: "_code/workflows/status.md"
+
+  # Main Workflows
+  code-sage:
+    description: "Start with SAGE - the orchestrator who guides you"
+    agent: "_code/agents/sage.agent.yaml"
+
+  code-brief:
+    description: "Fill out or improve your project BRIEF"
+    workflow: "_code/workflows/brief/workflow.md"
+    agent: "_code/agents/iris.agent.yaml"
+
+  code-outline:
+    description: "Generate technical architecture and schemas"
+    workflow: "_code/workflows/outline/workflow.md"
+    agent: "_code/agents/atlas.agent.yaml"
+
+  code-ux:
+    description: "Generate sitemap and wireframes"
+    workflow: "_code/workflows/ux/workflow.md"
+    agent: "_code/agents/luna.agent.yaml"
+
+  code-docs:
+    description: "Generate epics and user stories"
+    workflow: "_code/workflows/docs/workflow.md"
+    agent: "_code/agents/echo.agent.yaml"
+
+  code-implement:
+    description: "Implement a user story"
+    workflow: "_code/workflows/implement/workflow.md"
+    agent: "_code/agents/builder.agent.yaml"
+
+  code-review:
+    description: "Quality review and testing"
+    workflow: "_code/workflows/review/workflow.md"
+    agent: "_code/agents/scout.agent.yaml"
+
+  code-evolve:
+    description: "Plan and create a new version"
+    workflow: "_code/workflows/evolve/workflow.md"
+    agent: "_code/agents/phoenix.agent.yaml"
+
+  code-party:
+    description: "Multi-agent collaborative discussion"
+    workflow: "_code/workflows/party/workflow.md"
+
+  # Utility Commands
+  code-checklist:
+    description: "Run a quality checklist"
+    workflow: "_code/workflows/checklist.md"
+
+  code-research:
+    description: "Research a topic and save findings"
+    workflow: "_code/workflows/research.md"
+`;
+}
+
+function generateSettingsJson() {
+  return JSON.stringify({
+    permissions: {
+      allow: [
+        "Bash(npm:*)",
+        "Bash(npx:*)",
+        "Bash(git:*)",
+        "Bash(ls:*)",
+        "Bash(cat:*)",
+        "Bash(mkdir:*)",
+        "Read",
+        "Write",
+        "Edit"
+      ],
+      deny: []
+    }
+  }, null, 2);
+}
+
+async function install(targetDir = process.cwd()) {
+  console.log(colors.cyan + LOGO + colors.reset);
+
+  log('\n📦 CODE Framework Installer\n', colors.bright);
+
+  const sourceDir = __dirname;
+  const codeDir = path.join(targetDir, '_code');
+  const projectTemplateDir = path.join(sourceDir, 'project-template');
+
+  // Check if already installed
+  if (fs.existsSync(codeDir)) {
+    log('⚠️  CODE framework already installed in this directory.', colors.yellow);
+    log('   Use --force to overwrite.\n');
+
+    if (!process.argv.includes('--force')) {
+      process.exit(1);
+    }
+    log('   --force detected, overwriting...\n', colors.yellow);
   }
 
-  log('\n✅ Installation complete!\n', colors.green + colors.bright);
-
-  log('📋 Next Steps:', colors.bright);
-  log('   1. Fill out the files in 1-context/v1.0.0/');
-  log('   2. Run /sage or /brief to get started with AI assistance');
-  log('');
-  log('📚 Structure:', colors.bright);
-  log('   1-context/     ← Start here! Fill out your BRIEF');
-  log('   2-outline/     ← Technical architecture (generated)');
-  log('   3-ux/          ← Sitemap & wireframes (generated)');
-  log('   4-documentation/ ← Epics & stories (generated)');
-  log('   5-evolution/   ← Track changes over time');
-  log('   _code/         ← Framework files (don\'t edit)');
-  log('');
-  log('🧙 Run /sage to begin your CODE journey!', colors.cyan + colors.bright);
-  log('');
+  const rl = createPrompt();
+
+  try {
+    // Step 1: Select CLI tools
+    log('🔧 Step 1: Select AI CLI Tools to Configure\n', colors.bright);
+    log('CODE Framework can integrate with multiple AI coding assistants.', colors.dim);
+    log('Select which tools you want to configure:\n', colors.dim);
+
+    const toolOptions = Object.entries(CLI_TOOLS).map(([id, tool]) => ({
+      id,
+      name: tool.name,
+      description: tool.description,
+      recommended: tool.recommended,
+      selected: tool.recommended,
+    }));
+
+    const selectedIndices = await selectMultiple(rl, 'Select tools to configure:', toolOptions);
+    const selectedTools = selectedIndices.map(i => toolOptions[i].id);
+
+    if (selectedTools.length === 0) {
+      log('\n⚠️  No tools selected. Installing framework files only.', colors.yellow);
+    } else {
+      log(`\n✓ Selected: ${selectedTools.map(id => CLI_TOOLS[id].name).join(', ')}`, colors.green);
+    }
+
+    // Step 2: Copy framework files
+    log('\n📁 Step 2: Installing Framework Files...\n', colors.bright);
+
+    // Copy _code framework
+    log('   Copying framework files...', colors.cyan);
+    copyRecursive(path.join(sourceDir, '_code'), codeDir);
+    log('   ✓ _code/ folder created', colors.green);
+
+    // Copy project template folders
+    log('   Creating project structure...', colors.cyan);
+
+    const folders = [
+      '1-context',
+      '2-outline',
+      '3-ux',
+      '4-documentation',
+      '5-evolution',
+      'research',
+    ];
+
+    for (const folder of folders) {
+      const srcFolder = path.join(projectTemplateDir, folder);
+      const destFolder = path.join(targetDir, folder);
+
+      if (fs.existsSync(srcFolder)) {
+        if (fs.existsSync(destFolder) && !process.argv.includes('--force')) {
+          log(`   ⏭️  ${folder}/ exists, skipping`, colors.yellow);
+        } else {
+          copyRecursive(srcFolder, destFolder);
+          log(`   ✓ ${folder}/ created`, colors.green);
+        }
+      }
+    }
+
+    // Step 3: Configure selected tools
+    if (selectedTools.length > 0) {
+      log('\n🔧 Step 3: Configuring AI Tools...\n', colors.bright);
+
+      for (const toolId of selectedTools) {
+        const tool = CLI_TOOLS[toolId];
+        log(`   Configuring ${tool.name}...`, colors.cyan);
+
+        // Create config directory
+        const configDir = path.dirname(path.join(targetDir, tool.configFile));
+        if (!fs.existsSync(configDir)) {
+          fs.mkdirSync(configDir, { recursive: true });
+        }
+
+        // Write commands file
+        if (tool.configFile.endsWith('.yaml') || tool.configFile.endsWith('.yml')) {
+          fs.writeFileSync(
+            path.join(targetDir, tool.configFile),
+            generateCommandsYaml()
+          );
+        }
+
+        // Write settings file
+        if (tool.settingsFile) {
+          const settingsPath = path.join(targetDir, tool.settingsFile);
+          if (!fs.existsSync(settingsPath) || process.argv.includes('--force')) {
+            fs.writeFileSync(settingsPath, generateSettingsJson());
+          }
+        }
+
+        // Write instructions file
+        const instructionsPath = path.join(targetDir, tool.instructionsFile);
+        if (!fs.existsSync(instructionsPath) || process.argv.includes('--force')) {
+          fs.writeFileSync(instructionsPath, generateInstructionsFile(toolId, targetDir));
+        }
+
+        log(`   ✓ ${tool.name} configured`, colors.green);
+      }
+    }
+
+    rl.close();
+
+    // Final summary
+    log('\n✅ Installation complete!\n', colors.green + colors.bright);
+
+    log('📋 What was installed:', colors.bright);
+    log('   _code/           Framework files (agents, workflows, checklists)');
+    log('   1-context/       Your project BRIEF (start here!)');
+    log('   2-outline/       Technical architecture');
+    log('   3-ux/            UX designs and wireframes');
+    log('   4-documentation/ Epics and stories');
+    log('   5-evolution/     Version history');
+    log('   research/        Research notes');
+
+    if (selectedTools.length > 0) {
+      log('\n🔧 Configured tools:', colors.bright);
+      for (const toolId of selectedTools) {
+        const tool = CLI_TOOLS[toolId];
+        log(`   ✓ ${tool.name} (${tool.instructionsFile})`);
+      }
+    }
+
+    log('\n📋 Next Steps:', colors.bright);
+    log('   1. Fill out the files in 1-context/v1.0.0/');
+    log('   2. Run /code-help to see available commands');
+    log('   3. Run /code-sage to start with the AI guide');
+    log('');
+    log('🧙 Run /code-sage to begin your CODE journey!', colors.cyan + colors.bright);
+    log('');
+
+  } catch (error) {
+    rl.close();
+    log(`\n❌ Installation failed: ${error.message}`, colors.red);
+    process.exit(1);
+  }
 }
 
 // Run installer

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "code-framework",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "Context. Outline. Documentation. Evolve. - AI-assisted development framework",
   "main": "install.js",
   "bin": {