fraim-framework 1.0.3 → 1.0.5

package/bin/fraim.js

@@ -83,7 +83,20 @@ async function runSetup() {
     }
 }
 
-function main() {
+async function runWizard() {
+    try {
+        // Import and run the wizard function
+        const { runWizard: wizardFunction } = require('../setup.js');
+        await wizardFunction();
+    } catch (error) {
+        console.error('❌ Failed to run wizard:', error.message);
+        console.log('\n💡 Try running the setup script directly:');
+        console.log('   node setup.js');
+        process.exit(1);
+    }
+}
+
+async function main() {
     const args = process.argv.slice(2);
 
     if (args.length === 0 || args.includes('--help') || args.includes('-h')) {
@@ -99,20 +112,15 @@ function main() {
     if (args.includes('init') || args.includes('setup')) {
         console.log(banner);
         console.log('🚀 Setting up FRAIM in current repository...\n');
-        runSetup();
+        await runSetup();
         return;
     }
 
     if (args.includes('wizard')) {
         console.log(banner);
         console.log('🔮 FRAIM Interactive Setup Wizard\n');
-        console.log('This wizard will guide you through:');
-        console.log('  1. Repository configuration');
-        console.log('  2. AI agent setup (with tested rules)');
-        console.log('  3. Workflow customization');
-        console.log('  4. Team member onboarding\n');
-        console.log('💡 Starting setup wizard...\n');
-        runSetup();
+        console.log('Starting interactive wizard...\n');
+        await runWizard();
         return;
     }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fraim-framework",
-  "version": "1.0.3",
+  "version": "1.0.5",
   "description": "FRAIM: Framework for Rigor-based AI Management - Where humans become AI managers through rigorous methodology",
   "main": "index.js",
   "bin": {

package/setup.js

@@ -2,6 +2,8 @@
 
 const fs = require('fs');
 const path = require('path');
+const { execSync } = require('child_process');
+const readline = require('readline');
 
 // Colors for console output
 const colors = {
@@ -40,6 +42,10 @@ function logHeader(message) {
     log('─'.repeat(message.length));
 }
 
+function logStep(message) {
+    log(`\n${colors.bright}${colors.magenta}${message}${colors.reset}`);
+}
+
 function ensureDirectory(dirPath) {
     if (!fs.existsSync(dirPath)) {
         fs.mkdirSync(dirPath, { recursive: true });
@@ -53,141 +59,73 @@ function writeFile(filePath, content) {
     logSuccess(`Created file: ${filePath}`);
 }
 
-function createAgentStructure() {
-    // Create the proper agent directory structure
-    ensureDirectory('agents/cursor/rules');
-    ensureDirectory('agents/claude/rules');
-    ensureDirectory('agents/windsurf/rules');
-
-    // Create .cursorrules that references modular rules
-    const cursorRules = `# FRAIM Cursor Rules
-
-## Core Rules (Always Apply)
-- **ashley-architecture.mdc** - Follow the established architecture patterns
-- **continuous-learning.mdc** - Always review retrospectives and RFCs before starting work
-- **local-development.mdc** - Work locally, coordinate remotely
-- **simplicity.mdc** - Keep it simple, don't over-engineer
-- **software-development-lifecycle.mdc** - Follow the established SDLC
-
-## Phase-Specific Rules (Manual Trigger Only)
-- **prep.mdc** - Preparation phase rules
-- **design.mdc** - Design phase rules
-- **implement.mdc** - Implementation phase rules
-- **test.mdc** - Testing phase rules
-- **resolve.mdc** - Resolution phase rules
-- **cursor-workflow.mdc** - Cursor-specific workflow rules
-
-## Key Behavioral Requirements
-- Always verify actions taken
-- Never expect user verification
-- Run tests to verify expected behavior
-- Link work to issues with "Closes #<n>"
-- Open Draft PRs early for review
-
-## Project Structure Awareness
-- Work in feature branches only
-- Never push to master
-- Use local file system for development
-- Coordinate through GitHub issues and PRs
-
-## Tool Usage Guidelines
-- Use local file system for development work
-- Use GitHub MCP for issue management
-- Use local Git for version control
-- Test locally before committing
-
-## FRAIM Integration
-- Follow the RIGOR methodology
-- Maintain isolation between agents
-- Use GitOps for coordination
-- Enable observability through clear documentation
-`;
+function copyDirectory(src, dest) {
+    if (!fs.existsSync(dest)) {
+        fs.mkdirSync(dest, { recursive: true });
+    }
+    
+    const items = fs.readdirSync(src);
+    for (const item of items) {
+        const srcPath = path.join(src, item);
+        const destPath = path.join(dest, item);
+        
+        if (fs.statSync(srcPath).isDirectory()) {
+            copyDirectory(srcPath, destPath);
+        } else {
+            fs.copyFileSync(srcPath, destPath);
+            logSuccess(`Copied: ${destPath}`);
+        }
+    }
+}
 
-    // Create .windsurfrules that references modular rules
-    const windsurfRules = `# FRAIM Windsurf Rules
-
-## Core Rules (Always Apply)
-- **ashley-architecture.mdc** - Follow the established architecture patterns
-- **continuous-learning.mdc** - Always review retrospectives and RFCs before starting work
-- **local-development.mdc** - Work locally, coordinate remotely
-- **simplicity.mdc** - Keep it simple, don't over-engineer
-- **issue-resolution-process.mdc** - Follow the established issue resolution process
-
-## Key Behavioral Requirements
-- Always verify actions taken
-- Never expect user verification
-- Run tests to verify expected behavior
-- Link work to issues with "Closes #<n>"
-- Open Draft PRs early for review
-
-## Project Structure Awareness
-- Work in feature branches only
-- Never push to master
-- Use local file system for development
-- Coordinate through GitHub issues and PRs
-
-## Tool Usage Guidelines
-- Use local file system for development work
-- Use GitHub MCP for issue management
-- Use local Git for version control
-- Test locally before committing
-
-## Architecture and Optimization Principles
-- Follow established patterns
-- Optimize for performance and maintainability
-- Document architectural decisions
-- Consider scalability and security
-
-## Your Role in FRAIM
-- Provide technical expertise and optimization
-- Maintain code quality and standards
-- Ensure architectural consistency
-- Support other agents with technical guidance
-`;
+function askQuestion(question, defaultValue = 'y') {
+    return new Promise((resolve) => {
+        const rl = readline.createInterface({
+            input: process.stdin,
+            output: process.stdout
+        });
+        
+        const defaultText = defaultValue ? ` (${defaultValue})` : '';
+        rl.question(`${question}${defaultText}: `, (answer) => {
+            rl.close();
+            const finalAnswer = answer.trim() || defaultValue;
+            resolve(finalAnswer.toLowerCase());
+        });
+    });
+}
 
-    // Create CLAUDE.md that references modular rules
-    const claudeRules = `# FRAIM Claude Rules
-
-## Always-On Rules
-- **ashley-architecture.mdc** - Follow the established architecture patterns
-- **continuous-learning.mdc** - Always review retrospectives and RFCs before starting work
-
-## Phase-Specific Rules (Manual Trigger Only)
-- **design.mdc** - Design phase rules
-- **implement.mdc** - Implementation phase rules
-- **test.mdc** - Testing phase rules
-
-## Key Behavioral Requirements
-- Always verify actions taken
-- Never expect user verification
-- Run tests to verify expected behavior
-- Link work to issues with "Closes #<n>"
-- Open Draft PRs early for review
-
-## Project Structure Awareness
-- Work in feature branches only
-- Never push to master
-- Use local file system for development
-- Coordinate through GitHub issues and PRs
-
-## Tool Usage Guidelines
-- Use local file system for development work
-- Use GitHub MCP for issue management
-- Use local Git for version control
-- Test locally before committing
-
-## FRAIM Integration
-- Follow the RIGOR methodology
-- Maintain isolation between agents
-- Use GitOps for coordination
-- Enable observability through clear documentation
-`;
+function createGitHubLabels() {
+    const labels = [
+        { name: 'phase:design', color: '0e8a16', description: 'Design phase - RFC creation and review' },
+        { name: 'phase:impl', color: '1d76db', description: 'Implementation phase - coding and testing' },
+        { name: 'phase:tests', color: 'fef2c0', description: 'Testing phase - validation and QA' },
+        { name: 'status:wip', color: 'fbca04', description: 'Work in progress' },
+        { name: 'status:needs-review', color: 'd93f0b', description: 'Ready for review' },
+        { name: 'status:complete', color: '0e8a16', description: 'Completed and approved' },
+        { name: 'status:approved', color: '0e8a16', description: 'Approved and ready to merge' },
+        { name: 'status:changes-requested', color: 'd93f0b', description: 'Changes requested in review' },
+        { name: 'ai-agent:cursor', color: '5319e7', description: 'Assigned to Cursor AI agent' },
+        { name: 'ai-agent:claude', color: 'c2e0c6', description: 'Assigned to Claude AI agent' },
+        { name: 'ai-agent:windsurf', color: 'bfdadc', description: 'Assigned to Windsurf AI agent' }
+    ];
 
-    writeFile('.cursorrules', cursorRules);
-    writeFile('.windsurfrules', windsurfRules);
-    writeFile('CLAUDE.md', claudeRules);
+    logInfo('Creating GitHub labels...');
     
-    logSuccess('AI agent configuration files created');
+    for (const label of labels) {
+        try {
+            const command = `gh label create "${label.name}" --color "${label.color}" --description "${label.description}"`;
+            execSync(command, { stdio: 'pipe' });
+            logSuccess(`Created label: ${label.name}`);
+        } catch (error) {
+            if (error.message.includes('already exists')) {
+                logInfo(`Label already exists: ${label.name}`);
+            } else {
+                logWarning(`Failed to create label ${label.name}: ${error.message}`);
+            }
+        }
+    }
+    
+    logSuccess('GitHub labels created');
 }
 
 function createGitHubWorkflows() {
@@ -285,76 +223,146 @@ jobs:
     logSuccess('GitHub workflows created');
 }
 
-function createGitHubLabels() {
-    const labels = [
-        { name: 'phase:design', color: '0e8a16', description: 'Design phase - RFC creation and review' },
-        { name: 'phase:impl', color: '1d76db', description: 'Implementation phase - coding and testing' },
-        { name: 'phase:tests', color: 'fef2c0', description: 'Testing phase - validation and QA' },
-        { name: 'status:wip', color: 'fbca04', description: 'Work in progress' },
-        { name: 'status:needs-review', color: 'd93f0b', description: 'Ready for review' },
-        { name: 'status:complete', color: '0e8a16', description: 'Completed and approved' },
-        { name: 'status:approved', color: '0e8a16', description: 'Approved and ready to merge' },
-        { name: 'status:changes-requested', color: 'd93f0b', description: 'Changes requested in review' },
-        { name: 'ai-agent:cursor', color: '5319e7', description: 'Assigned to Cursor AI agent' },
-        { name: 'ai-agent:claude', color: 'c2e0c6', description: 'Assigned to Claude AI agent' },
-        { name: 'ai-agent:windsurf', color: 'bfdadc', description: 'Assigned to Windsurf AI agent' }
-    ];
+function createAgentFolders() {
+    // Create .cursor folder at top level with all contents
+    if (fs.existsSync('agents/cursor')) {
+        copyDirectory('agents/cursor', '.cursor');
+        logSuccess('Created .cursor folder with all contents');
+    } else {
+        logWarning('agents/cursor directory not found, skipping .cursor creation');
+    }
 
-    const labelsContent = JSON.stringify(labels, null, 2);
-    writeFile('.github/labels.json', labelsContent);
-    
-    logInfo('GitHub labels configuration created');
-    logInfo('You can import these labels using GitHub CLI or the web interface');
-    logInfo('Or use the GitHub web interface: Settings > Labels > Import labels');
+    // Create .windsurf folder at top level with all contents
+    if (fs.existsSync('agents/windsurf')) {
+        copyDirectory('agents/windsurf', '.windsurf');
+        logSuccess('Created .windsurf folder with all contents');
+    } else {
+        logWarning('agents/windsurf directory not found, skipping .windsurf creation');
+    }
+
+    // Create CLAUDE.md at top level
+    if (fs.existsSync('agents/claude/CLAUDE.md')) {
+        const claudeContent = fs.readFileSync('agents/claude/CLAUDE.md', 'utf8');
+        writeFile('CLAUDE.md', claudeContent);
+        logSuccess('Created CLAUDE.md at top level');
+    } else {
+        logWarning('agents/claude/CLAUDE.md not found, skipping CLAUDE.md creation');
+    }
 }
 
-function createFRAIMConfig() {
-    const fraimConfig = {
-        version: "1.0.0",
-        framework: "FRAIM",
-        description: "Framework for Rigor-based AI Management",
-        created: new Date().toISOString(),
-        features: [
-            "GitHub label automation",
-            "AI agent coordination",
-            "Phase-based workflows",
-            "RIGOR methodology implementation"
-        ],
-        agents: {
-            cursor: ".cursorrules",
-            claude: "CLAUDE.md",
-            windsurf: ".windsurfrules"
-        },
-        workflows: [
-            ".github/workflows/phase-change.yml",
-            ".github/workflows/status-change.yml",
-            ".github/workflows/sync-on-pr-review.yml"
-        ]
-    };
-
-    writeFile('fraim-config.json', JSON.stringify(fraimConfig, null, 2));
-    logSuccess('FRAIM configuration created');
+async function runWizard() {
+    logHeader('🔮 FRAIM Interactive Setup Wizard');
+    log('Welcome to the FRAIM setup wizard! I\'ll guide you through each step.\n');
+
+    try {
+        // Check prerequisites
+        logStep('Step 1: Checking Prerequisites');
+        
+        // Check if gh CLI is available
+        try {
+            execSync('gh --version', { stdio: 'pipe' });
+            logSuccess('GitHub CLI (gh) is available');
+        } catch (error) {
+            logError('GitHub CLI (gh) is not installed or not available');
+            logInfo('Please install GitHub CLI: https://cli.github.com/');
+            return;
+        }
+
+        // Check if we're in a git repository
+        try {
+            execSync('git rev-parse --git-dir', { stdio: 'pipe' });
+            logSuccess('Running in a git repository');
+        } catch (error) {
+            logError('Not in a git repository');
+            logInfo('Please run this command from within a git repository');
+            return;
+        }
+
+        // Step 2: AI Agent Setup
+        logStep('Step 2: AI Agent Configuration');
+        const setupAgents = await askQuestion('Would you like to set up AI agent configurations (.cursor, .windsurf, CLAUDE.md)?', 'y');
+        
+        if (setupAgents === 'y' || setupAgents === 'yes') {
+            createAgentFolders();
+        } else {
+            logInfo('Skipping AI agent setup');
+        }
+
+        // Step 3: GitHub Workflows
+        logStep('Step 3: GitHub Workflows');
+        const setupWorkflows = await askQuestion('Would you like to set up GitHub workflows for automation?', 'y');
+        
+        if (setupWorkflows === 'y' || setupWorkflows === 'yes') {
+            ensureDirectory('.github/workflows');
+            createGitHubWorkflows();
+        } else {
+            logInfo('Skipping GitHub workflow setup');
+        }
+
+        // Step 4: GitHub Labels
+        logStep('Step 4: GitHub Labels');
+        const setupLabels = await askQuestion('Would you like to create GitHub labels for FRAIM?', 'y');
+        
+        if (setupLabels === 'y' || setupLabels === 'yes') {
+            createGitHubLabels();
+        } else {
+            logInfo('Skipping GitHub label setup');
+        }
+
+        // Step 5: Summary
+        logStep('Step 5: Setup Summary');
+        logHeader('🎉 Setup Complete!');
+        logSuccess('FRAIM has been successfully set up in your repository!');
+        logInfo('Next steps:');
+        logInfo('1. Commit and push these files to GitHub');
+        logInfo('2. Create your first issue with phase labels');
+        logInfo('3. Start coordinating your AI agents!');
+        
+        logInfo('\n📚 Learn more about FRAIM:');
+        logInfo('https://github.com/mathursrus/Ashley-Calendar-AI/tree/master/FRAIM');
+        
+        logInfo('\n🧠 Learn the RIGOR methodology:');
+        logInfo('npx fraim-framework rigor');
+
+    } catch (error) {
+        logError(`Wizard failed: ${error.message}`);
+        process.exit(1);
+    }
 }
 
 function runSetup() {
-    logHeader('🚀 FRAIM Setup Wizard');
+    logHeader('🚀 FRAIM Quick Setup');
     log('Setting up FRAIM in current repository...\n');
 
     try {
-        // Create only essential directory structure
+        // Check prerequisites
+        try {
+            execSync('gh --version', { stdio: 'pipe' });
+        } catch (error) {
+            logError('GitHub CLI (gh) is not installed or not available');
+            logInfo('Please install GitHub CLI: https://cli.github.com/');
+            process.exit(1);
+        }
+
+        try {
+            execSync('git rev-parse --git-dir', { stdio: 'pipe' });
+        } catch (error) {
+            logError('Not in a git repository');
+            logInfo('Please run this command from within a git repository');
+            process.exit(1);
+        }
+
+        // Create everything at once
         ensureDirectory('.github/workflows');
-
-        // Create all components
-        createAgentStructure();
+        createAgentFolders();
         createGitHubWorkflows();
         createGitHubLabels();
-        createFRAIMConfig();
 
         logHeader('🎉 Setup Complete!');
         logSuccess('FRAIM has been successfully set up in your repository!');
         logInfo('Next steps:');
         logInfo('1. Commit and push these files to GitHub');
-        logInfo('2. Import the GitHub labels from .github/labels.json');
+        logInfo('2. The GitHub labels have been created automatically');
         logInfo('3. Create your first issue with phase labels');
         logInfo('4. Start coordinating your AI agents!');
         
@@ -375,4 +383,4 @@ if (require.main === module) {
     runSetup();
 }
 
-module.exports = { runSetup };
+module.exports = { runSetup, runWizard };