fraim-framework 1.0.0 → 1.0.1

package/bin/fraim.js

@@ -70,6 +70,19 @@ function showRigor() {
     console.log('✨ Every rule has been tested and proven in real project environments.');
 }
 
+async function runSetup() {
+    try {
+        // Import and run the setup script
+        const { runSetup: setupFunction } = require('../setup.js');
+        setupFunction();
+    } catch (error) {
+        console.error('❌ Failed to run setup:', error.message);
+        console.log('\n💡 Try running the setup script directly:');
+        console.log('   node setup.js');
+        process.exit(1);
+    }
+}
+
 function main() {
     const args = process.argv.slice(2);
 
@@ -86,13 +99,7 @@ function main() {
     if (args.includes('init') || args.includes('setup')) {
         console.log(banner);
         console.log('🚀 Setting up FRAIM in current repository...\n');
-        console.log('📋 This will:');
-        console.log('  • Create GitHub labels for AI management');
-        console.log('  • Set up automated workflows');
-        console.log('  • Configure AI agent rules (all tested & proven)');
-        console.log('  • Initialize documentation\n');
-        console.log('💡 Run: npx fraim-framework init  # For full setup');
-        console.log('🔧 Or run: npx fraim-framework wizard  # For interactive setup');
+        runSetup();
         return;
     }
 
@@ -104,7 +111,8 @@ function main() {
         console.log('  2. AI agent setup (with tested rules)');
         console.log('  3. Workflow customization');
         console.log('  4. Team member onboarding\n');
-        console.log('💡 Run: npx fraim-framework wizard  # To start the wizard');
+        console.log('💡 Starting setup wizard...\n');
+        runSetup();
         return;
     }
 

package/package.json

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

package/setup.js

@@ -1,86 +1,378 @@
 #!/usr/bin/env node
 
-/**
- * FRAIM Setup Script
- * Framework for Rigor-based AI Management
- * 
- * This script sets up the FRAIM framework in a GitHub repository,
- * implementing the RIGOR methodology for coordinated AI agent development.
- */
-
-const { program } = require('commander');
 const fs = require('fs');
 const path = require('path');
 
-// FRAIM branding
-const FRAIM_BANNER = `
-╔══════════════════════════════════════════════════════════════╗
-║  🚀 FRAIM Setup                                              ║
-║  Framework for Rigor-based AI Management                    ║
-║  Where humans become AI managers                            ║
-╚══════════════════════════════════════════════════════════════╝
+// Colors for console output
+const colors = {
+    reset: '\x1b[0m',
+    bright: '\x1b[1m',
+    red: '\x1b[31m',
+    green: '\x1b[32m',
+    yellow: '\x1b[33m',
+    blue: '\x1b[34m',
+    magenta: '\x1b[35m',
+    cyan: '\x1b[36m'
+};
+
+function log(message, color = 'reset') {
+    console.log(`${colors[color]}${message}${colors.reset}`);
+}
+
+function logSuccess(message) {
+    log(`✅ ${message}`, 'green');
+}
+
+function logInfo(message) {
+    log(`ℹ️  ${message}`, 'blue');
+}
+
+function logWarning(message) {
+    log(`⚠️  ${message}`, 'yellow');
+}
+
+function logError(message) {
+    log(`❌ ${message}`, 'red');
+}
+
+function logHeader(message) {
+    log(`\n${colors.bright}${colors.cyan}${message}${colors.reset}`);
+    log('─'.repeat(message.length));
+}
+
+function ensureDirectory(dirPath) {
+    if (!fs.existsSync(dirPath)) {
+        fs.mkdirSync(dirPath, { recursive: true });
+        logSuccess(`Created directory: ${dirPath}`);
+    }
+}
+
+function writeFile(filePath, content) {
+    ensureDirectory(path.dirname(filePath));
+    fs.writeFileSync(filePath, content);
+    logSuccess(`Created file: ${filePath}`);
+}
+
+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: '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' }
+    ];
+
+    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');
+}
+
+function createGitHubWorkflows() {
+    // Phase change workflow
+    const phaseChangeWorkflow = `name: Phase Change Automation
+
+on:
+  issues:
+    types: [labeled, unlabeled]
+
+jobs:
+  phase-change:
+    runs-on: ubuntu-latest
+    if: contains(github.event.issue.labels.*.name, 'phase:') || contains(github.event.label.name, 'phase:')
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      
+      - name: Phase Change Handler
+        run: |
+          echo "Phase change detected for issue #\${{ github.event.issue.number }}"
+          echo "New phase: \${{ github.event.label.name || 'phase removed' }}"
+      
+      - name: Update Issue Status
+        if: contains(github.event.label.name, 'phase:')
+        run: |
+          gh issue edit \${{ github.event.issue.number }} --add-label "status:wip"
+          echo "Status updated to WIP for new phase"
+`;
+
+    // Status change workflow
+    const statusChangeWorkflow = `name: Status Change Automation
+
+on:
+  issues:
+    types: [labeled, unlabeled]
+
+jobs:
+  status-change:
+    runs-on: ubuntu-latest
+    if: contains(github.event.issue.labels.*.name, 'status:') || contains(github.event.label.name, 'status:')
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      
+      - name: Status Change Handler
+        run: |
+          echo "Status change detected for issue #\${{ github.event.issue.number }}"
+          echo "New status: \${{ github.event.label.name || 'status removed' }}"
+      
+      - name: Notify Team
+        if: contains(github.event.label.name, 'status:needs-review')
+        run: |
+          echo "Issue ready for review - notifying team"
 `;
 
-// FRAIM methodology labels
-const FRAIM_LABELS = [
-  // Phase Labels (RIGOR methodology)
-  { name: 'phase:design', color: 'C2E0C6', description: 'Design phase - RFC creation and review (RIGOR: Reviews)' },
-  { name: 'phase:impl', color: 'FEF2C0', description: 'Implementation phase - code development (RIGOR: Idempotency)' },
-  { name: 'phase:tests', color: 'D4C5F9', description: 'Testing phase - test creation and validation (RIGOR: Observability)' },
-  
-  // Status Labels  
-  { name: 'status:wip', color: 'FBCA04', description: 'Work in progress' },
-  { name: 'status:needs-review', color: 'EB6420', description: 'Ready for review' },
-  { name: 'status:complete', color: '0E8A16', description: 'Work completed' },
-  
-  // AI Agent Labels (AI Management)
-  { name: 'ai-agent:cursor', color: '1F77B4', description: 'Assigned to Cursor agent (IDE development)' },
-  { name: 'ai-agent:claude', color: 'FF7F0E', description: 'Assigned to Claude agent (Conversational AI)' },
-  { name: 'ai-agent:windsurf', color: '2CA02C', description: 'Assigned to Windsurf agent (Code understanding)' },
-  
-  // Priority Labels (optional)
-  { name: 'priority:critical', color: 'D93F0B', description: 'Critical priority' },
-  { name: 'priority:high', color: 'FBCA04', description: 'High priority' },
-  { name: 'priority:medium', color: '0E8A16', description: 'Medium priority' },
-  { name: 'priority:low', color: '0366D6', description: 'Low priority' }
-];
-
-// Main setup function
-async function setupFRAIM(options) {
-    console.log(FRAIM_BANNER);
-    console.log('🚀 Setting up FRAIM in your repository...\n');
+    writeFile('.github/workflows/phase-change.yml', phaseChangeWorkflow);
+    writeFile('.github/workflows/status-change.yml', statusChangeWorkflow);
     
-    console.log('📋 This will create:');
-    console.log('  • GitHub labels for AI management');
-    console.log('  • Automated workflows');
-    console.log('  • AI agent configurations');
-    console.log('  • Documentation templates\n');
+    logSuccess('GitHub workflows created');
+}
+
+function createAgentConfigs() {
+    // Cursor 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
+`;
+
+    // Claude 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
+`;
+
+    // Windsurf 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
+`;
+
+    writeFile('.cursorrules', cursorRules);
+    writeFile('CLAUDE.md', claudeRules);
+    writeFile('.windsurfrules', windsurfRules);
     
-    if (options.dryRun) {
-        console.log('🔍 DRY RUN MODE - No changes will be made\n');
-    }
+    logSuccess('AI agent configurations created');
+}
+
+function createDocumentation() {
+    const readme = `# FRAIM-Enabled Repository
+
+This repository is configured with FRAIM (Framework for Rigor-based AI Management) to enable coordinated AI agent development.
+
+## 🚀 Quick Start
+
+1. **Create an issue** with appropriate phase labels:
+   \`\`\`bash
+   gh issue create --title "Add user authentication" --label "phase:design,ai-agent:claude"
+   \`\`\`
+
+2. **AI agents will automatically coordinate** through GitHub state:
+   - Claude creates RFC → Cursor implements → Windsurf optimizes
+
+3. **Use phase labels** to manage workflow:
+   - \`phase:design\` → \`phase:impl\` → \`phase:tests\`
+
+## 🏷️ Available Labels
+
+- **Phase Labels**: \`phase:design\`, \`phase:impl\`, \`phase:tests\`
+- **Status Labels**: \`status:wip\`, \`status:needs-review\`, \`status:complete\`
+- **Agent Labels**: \`ai-agent:cursor\`, \`ai-agent:claude\`, \`ai-agent:windsurf\`
+
+## 📚 Learn More
+
+- [FRAIM Framework](https://github.com/mathursrus/Ashley-Calendar-AI/tree/master/FRAIM)
+- [RIGOR Methodology](https://github.com/mathursrus/Ashley-Calendar-AI/tree/master/FRAIM#the-rigor-methodology)
+- [Getting Started Guide](https://github.com/mathursrus/Ashley-Calendar-AI/tree/master/FRAIM/docs/guides/getting-started.md)
+
+## 🤖 AI Agent Rules
+
+Each AI agent has specific rules and configurations:
+- **Cursor**: \`.cursorrules\`
+- **Claude**: \`CLAUDE.md\`
+- **Windsurf**: \`.windsurfrules\`
+
+---
+
+*Powered by FRAIM: Where humans become AI managers through rigorous methodology*
+`;
+
+    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"
+        ]
+    };
+
+    writeFile('README.md', readme);
+    writeFile('fraim-config.json', JSON.stringify(fraimConfig, null, 2));
     
-    console.log('🎯 Ready to become an AI manager?');
-    console.log('   Run: npx @fraim/framework init  # For full setup');
-    console.log('   Or: npx @fraim/framework wizard # For interactive setup');
+    logSuccess('Documentation created');
+}
+
+function runSetup() {
+    logHeader('🚀 FRAIM Setup Wizard');
+    log('Setting up FRAIM in current repository...\n');
+
+    try {
+        // Create directory structure
+        ensureDirectory('.github/workflows');
+        ensureDirectory('examples');
+
+        // Create all components
+        createGitHubLabels();
+        createGitHubWorkflows();
+        createAgentConfigs();
+        createDocumentation();
+
+        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('3. Create your first issue with phase labels');
+        logInfo('4. 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(`Setup failed: ${error.message}`);
+        process.exit(1);
+    }
 }
 
-// CLI setup
-program
-    .name('fraim-setup')
-    .description('Setup FRAIM framework in your repository')
-    .version('1.0.0')
-    .option('--repo <repository>', 'GitHub repository (owner/repo)')
-    .option('--config <file>', 'Configuration file path')
-    .option('--dry-run', 'Show what would be done without making changes')
-    .option('--labels-only', 'Only setup GitHub labels')
-    .option('--workflows-only', 'Only setup GitHub workflows')
-    .action(setupFRAIM);
-
-// Parse arguments
-program.parse();
-
-// If no arguments provided, show help
-if (process.argv.length === 2) {
-    program.help();
+// Run setup if this script is executed directly
+if (require.main === module) {
+    runSetup();
 }
+
+module.exports = { runSetup };