claude-flow-novice 2.0.0 → 2.0.1

package/docs/archive/2025-10-10-guides/setup-guides/QUICK_START_INSTALLATION.md

@@ -0,0 +1,521 @@
+# Claude Flow Novice - Quick Start Installation Guide
+
+## Overview
+
+Complete installation in **under 5 minutes** with our automated quick-start wizard.
+
+## Installation Methods
+
+### Method 1: Quick Start Wizard (Recommended)
+
+The fastest way to get started with intelligent defaults and automated setup.
+
+```bash
+# Interactive wizard with automated Redis installation
+npx claude-flow-novice init --quick-start
+
+# Non-interactive mode (accepts all defaults)
+npx claude-flow-novice init --quick-start --auto-accept
+
+# Skip intro animation
+npx claude-flow-novice init --quick-start --skip-intro
+```
+
+**Time:** 2-5 minutes (depends on Redis installation method)
+
+### Method 2: Quick Install Script
+
+Direct installation script with minimal prompts.
+
+```bash
+# Run quick installation
+npm run quick-install
+
+# Skip Redis installation (if already installed)
+node scripts/install/quick-install.js --skip-redis
+
+# Verbose mode for debugging
+node scripts/install/quick-install.js --verbose
+```
+
+**Time:** 3-5 minutes
+
+### Method 3: Standard Installation
+
+Traditional installation with full control.
+
+```bash
+# Standard init
+npx claude-flow-novice init
+
+# With specific options
+npx claude-flow-novice init --force --minimal
+```
+
+**Time:** 10-15 minutes (includes manual configuration)
+
+## What Gets Installed
+
+### Phase 1: Dependency Checks (5-10 seconds)
+
+Parallel checks for:
+- Node.js v20+ (required)
+- npm v9+ (required)
+- Redis (auto-installed if missing)
+- Docker (optional, for Redis)
+- Git (optional)
+
+### Phase 2: Redis Installation (30-90 seconds)
+
+Three installation methods (automatic selection):
+
+1. **Docker** (fastest - 30 seconds)
+   ```bash
+   docker run -d --name claude-flow-redis -p 6379:6379 redis:alpine
+   ```
+
+2. **Native Package Manager** (60-90 seconds)
+   - Windows: Chocolatey or Scoop
+   - macOS: Homebrew
+   - Linux: apt/yum/pacman
+
+3. **Existing** (0 seconds)
+   - Uses already running Redis instance
+
+### Phase 3: Configuration (5 seconds)
+
+Creates minimal configuration with smart defaults:
+- `.claude/settings.json` - System settings
+- `.claude/quick-start.json` - Installation metadata
+- `CLAUDE.md` - Main configuration
+- Directory structure (memory/, coordination/)
+
+### Phase 4: Template Deployment (5-10 seconds)
+
+Deploys pre-bundled templates:
+- `CLAUDE.md` - Quick-start configuration
+- `.claude/settings.json` - Hooks and Redis config
+- `memory/README.md` - Memory system docs
+- `coordination/README.md` - Coordination docs
+
+### Phase 5: Validation (5 seconds)
+
+Validates:
+- Redis connectivity
+- File structure
+- Configuration integrity
+
+## Performance Benchmarks
+
+Target installation time: **< 5 minutes**
+
+### Typical Performance
+
+| Scenario | Time | Method |
+|----------|------|--------|
+| Docker + Quick Start | 2-3 min | Fastest |
+| Native + Quick Start | 3-5 min | Typical |
+| No Redis + Quick Start | 1-2 min | Existing Redis |
+| Standard Installation | 10-15 min | Full control |
+
+### Run Your Own Benchmark
+
+```bash
+# Run 3 installation benchmarks
+npm run install:benchmark
+
+# Custom iterations and settings
+node scripts/install/installation-benchmark.js --iterations=5 --verbose
+```
+
+## Quick Start Commands
+
+After installation:
+
+### Check System Status
+```bash
+npx claude-flow-novice status
+```
+
+### Start Your First Swarm
+```bash
+npx claude-flow-novice swarm "Create a REST API with authentication"
+```
+
+### List Available Agents
+```bash
+npx claude-flow-novice agents list
+```
+
+### Test Redis Connection
+```bash
+redis-cli ping
+# Expected: PONG
+```
+
+## Configuration
+
+### Minimal Configuration (Quick Start)
+
+```json
+{
+  "version": "1.6.6",
+  "quickStart": true,
+  "features": {
+    "swarmOrchestration": true,
+    "memoryPersistence": true,
+    "autoSpawn": true
+  },
+  "redis": {
+    "host": "localhost",
+    "port": 6379
+  }
+}
+```
+
+### Advanced Configuration
+
+For custom settings, decline defaults during wizard:
+- Max agents per swarm
+- Redis port
+- Optional features (monitoring, neural learning)
+
+## Redis Management
+
+### Docker Redis
+
+```bash
+# Check status
+docker ps | grep claude-flow-redis
+
+# Stop Redis
+docker stop claude-flow-redis
+
+# Start Redis
+docker start claude-flow-redis
+
+# Remove container
+docker rm claude-flow-redis
+```
+
+### Native Redis
+
+```bash
+# Check status
+redis-cli ping
+
+# Start Redis (Linux/macOS)
+redis-server
+
+# Start Redis (Windows)
+redis-server.exe
+
+# Check Redis info
+redis-cli INFO server
+```
+
+## Troubleshooting
+
+### Redis Connection Issues
+
+**Problem:** Redis not responding
+
+**Solutions:**
+
+1. **Check if Redis is running:**
+   ```bash
+   redis-cli ping
+   ```
+
+2. **Try Docker method:**
+   ```bash
+   docker run -d -p 6379:6379 --name claude-flow-redis redis:alpine
+   ```
+
+3. **Check firewall/port:**
+   ```bash
+   netstat -an | grep 6379
+   ```
+
+### Node.js Version Issues
+
+**Problem:** Node.js version too old
+
+**Solution:**
+```bash
+# Check version
+node --version
+
+# Install Node.js v20+
+# Visit: https://nodejs.org/
+```
+
+### Permission Issues
+
+**Problem:** Write permission denied
+
+**Solutions:**
+
+1. **Check directory permissions:**
+   ```bash
+   ls -la
+   ```
+
+2. **Fix ownership (Linux/macOS):**
+   ```bash
+   sudo chown -R $USER:$USER .
+   ```
+
+3. **Run without sudo:**
+   ```bash
+   # DO NOT run with sudo
+   npx claude-flow-novice init --quick-start
+   ```
+
+### Installation Timeout
+
+**Problem:** Installation exceeds 5 minutes
+
+**Possible Causes:**
+- Slow internet connection (Docker image pull)
+- System resource constraints
+- Package manager cache issues
+
+**Solutions:**
+
+1. **Use existing Redis:**
+   ```bash
+   node scripts/install/quick-install.js --skip-redis
+   ```
+
+2. **Pre-install Redis:**
+   ```bash
+   # Docker
+   docker pull redis:alpine
+
+   # Or native
+   # See platform-specific instructions below
+   ```
+
+3. **Verbose mode for debugging:**
+   ```bash
+   node scripts/install/quick-install.js --verbose
+   ```
+
+## Platform-Specific Instructions
+
+### Windows
+
+**Prerequisites:**
+- Node.js v20+
+- Chocolatey or Scoop (for Redis)
+
+**Quick Start:**
+```powershell
+# Install Chocolatey (if not installed)
+# See: https://chocolatey.org/install
+
+# Run wizard
+npx claude-flow-novice init --quick-start
+```
+
+**Manual Redis (if needed):**
+```powershell
+# Via Chocolatey
+choco install redis-64 -y
+
+# Via Scoop
+scoop install redis
+```
+
+### macOS
+
+**Prerequisites:**
+- Node.js v20+
+- Homebrew (for Redis)
+
+**Quick Start:**
+```bash
+# Install Homebrew (if not installed)
+# See: https://brew.sh/
+
+# Run wizard
+npx claude-flow-novice init --quick-start
+```
+
+**Manual Redis (if needed):**
+```bash
+# Via Homebrew
+brew install redis
+brew services start redis
+```
+
+### Linux (Ubuntu/Debian)
+
+**Prerequisites:**
+- Node.js v20+
+- sudo access (for Redis)
+
+**Quick Start:**
+```bash
+npx claude-flow-novice init --quick-start
+```
+
+**Manual Redis (if needed):**
+```bash
+sudo apt-get update
+sudo apt-get install redis-server -y
+sudo systemctl start redis-server
+sudo systemctl enable redis-server
+```
+
+### Linux (CentOS/RHEL/Fedora)
+
+**Manual Redis:**
+```bash
+sudo yum install redis -y
+sudo systemctl start redis
+sudo systemctl enable redis
+```
+
+### Linux (Arch)
+
+**Manual Redis:**
+```bash
+sudo pacman -S redis --noconfirm
+sudo systemctl start redis
+sudo systemctl enable redis
+```
+
+## Next Steps
+
+After successful installation:
+
+1. **Review Configuration**
+   ```bash
+   cat CLAUDE.md
+   cat .claude/settings.json
+   ```
+
+2. **Test Redis Connection**
+   ```bash
+   redis-cli ping
+   # Should return: PONG
+   ```
+
+3. **Start First Swarm**
+   ```bash
+   npx claude-flow-novice swarm "Build a todo list API"
+   ```
+
+4. **Explore Commands**
+   ```bash
+   npx claude-flow-novice --help
+   ```
+
+5. **Check System Health**
+   ```bash
+   npx claude-flow-novice status
+   ```
+
+## Advanced Topics
+
+### Customizing Installation
+
+Create custom configuration file:
+
+```json
+{
+  "redis": {
+    "host": "localhost",
+    "port": 6379,
+    "password": "optional-password"
+  },
+  "maxAgents": 20,
+  "features": {
+    "monitoring": true,
+    "neural": true,
+    "git": true
+  }
+}
+```
+
+Use with:
+```bash
+npx claude-flow-novice init --config=custom-config.json
+```
+
+### Performance Tuning
+
+```bash
+# Increase Redis memory
+docker run -d -p 6379:6379 \
+  --name claude-flow-redis \
+  redis:alpine redis-server \
+  --maxmemory 512mb \
+  --maxmemory-policy allkeys-lru
+```
+
+### Multi-Instance Setup
+
+Run multiple Claude Flow instances:
+
+```bash
+# Instance 1 (default port)
+docker run -d -p 6379:6379 --name redis-instance-1 redis:alpine
+
+# Instance 2 (custom port)
+docker run -d -p 6380:6379 --name redis-instance-2 redis:alpine
+
+# Configure instance 2
+REDIS_PORT=6380 npx claude-flow-novice init --quick-start
+```
+
+## Support
+
+### Get Help
+
+- **GitHub Issues:** https://github.com/masharratt/claude-flow-novice/issues
+- **Documentation:** https://github.com/masharratt/claude-flow-novice#readme
+- **Community:** [Join discussions](https://github.com/masharratt/claude-flow-novice/discussions)
+
+### Report Installation Issues
+
+When reporting issues, include:
+
+1. **System Info:**
+   ```bash
+   node --version
+   npm --version
+   uname -a  # Linux/macOS
+   systeminfo  # Windows
+   ```
+
+2. **Installation Log:**
+   ```bash
+   node scripts/install/quick-install.js --verbose 2>&1 | tee install.log
+   ```
+
+3. **Redis Status:**
+   ```bash
+   redis-cli INFO server
+   ```
+
+### Benchmark Results
+
+Share your installation time:
+
+```bash
+npm run install:benchmark
+# Share results in GitHub Discussions
+```
+
+## License
+
+MIT License - See LICENSE file for details
+
+---
+
+**Quick Start Installation Guide v1.0**
+*Target: <5 minute installation for novice users*
+*Last Updated: 2025-10-09*

package/docs/archive/2025-10-10-guides/setup-guides/README.md

@@ -0,0 +1,162 @@
+# Claude Flow Documentation Hub
+
+## 🚀 Welcome to Claude Flow v2.0.0-alpha.88
+
+This is the comprehensive documentation hub for Claude Flow, the ultimate AI agent orchestration platform with 54+ specialized agents, 112 MCP tools, and swarm intelligence capabilities.
+
+> **🎯 Post-Phase 14 Organization**: All 2,557+ documentation files have been organized into logical categories for optimal navigation and usability.
+
+## 📋 Quick Navigation
+
+### 🏃‍♂️ **Getting Started**
+- **[Project Overview](../README.md)** - Quick start and project introduction
+- **[Installation Guide](operations/DEPLOYMENT.md)** - Complete setup instructions
+- **[User Guide](user/USER_GUIDE.md)** - User-friendly documentation
+- **[Tutorial](user/tutorial.md)** - Step-by-step learning path
+
+### 🏗️ **For Developers**
+- **[Development Workflow](development/DEVELOPMENT_WORKFLOW.md)** - Development best practices
+- **[SPARC Methodology](development/SPARC.md)** - Structured development approach
+- **[Technical Implementation](development/technical-implementation-guide.md)** - Implementation details
+- **[Troubleshooting](development/troubleshooting.md)** - Common issues and solutions
+
+### 🏛️ **System Architecture**
+- **[Architecture Overview](architecture/ARCHITECTURE.md)** - System design and patterns
+- **[Swarm Intelligence](architecture/SWARM.md)** - Distributed coordination
+- **[Agent System](architecture/AGENTS.md)** - Agent architecture and capabilities
+- **[Full-Stack Specification](architecture/full-stack-swarm-team-specification.md)** - Complete team coordination
+
+### 📡 **API & Integration**
+- **[API Documentation](api/API_DOCUMENTATION.md)** - Complete API reference
+- **[MCP Tools](api/MCP_TOOLS.md)** - MCP tool integration guide
+- **[Swarm Integration API](api/mcp-swarm-integration-api.md)** - Swarm coordination APIs
+- **[Custom Framework API](api/custom-framework-api.md)** - Custom integrations
+
+### 👥 **User Guides**
+- **[User Guide](user/USER_GUIDE.md)** - Comprehensive user documentation
+- **[Novice Guide](user/novice-user-guide.md)** - Beginner-friendly introduction
+- **[Enterprise Guide](user/enterprise-stakeholder-guide.md)** - Enterprise deployment
+- **[Preference System](user/PREFERENCE_SYSTEM_GUIDE.md)** - Customization options
+
+### ⚙️ **Operations & Deployment**
+- **[Deployment Guide](operations/DEPLOYMENT.md)** - Production deployment
+- **[Security Audit](operations/SECURITY_AUDIT_REPORT.md)** - Security best practices
+- **[Performance Analysis](operations/performance-analysis-report.md)** - Performance optimization
+- **[Cleanup Phases](operations/cleanup-phases/)** - Documentation cleanup process
+
+## 📚 **Organized Documentation Structure**
+
+### 📁 **API Documentation** (`/api/`)
+Complete API reference, MCP tools, and integration guides
+- REST API endpoints and examples
+- MCP tool documentation (112 tools)
+- Integration patterns and best practices
+- OpenAPI specifications
+
+### 📁 **Development Guides** (`/development/`)
+Development workflows, methodologies, and technical guides
+- SPARC development methodology (17 modes)
+- Development best practices
+- Technical implementation guides
+- Troubleshooting and debugging
+
+### 📁 **Architecture Documentation** (`/architecture/`)
+System design, patterns, and architectural decisions
+- High-level system architecture
+- Swarm coordination patterns (54+ agents)
+- Agent system design
+- Scalability and performance patterns
+
+### 📁 **User Documentation** (`/user/`)
+User guides, tutorials, and getting started information
+- Getting started guides
+- User tutorials and walkthroughs
+- Enterprise user documentation
+- Configuration and preferences
+
+### 📁 **Operations Documentation** (`/operations/`)
+Deployment, monitoring, and operational procedures
+- Production deployment guides
+- Security and compliance documentation
+- Performance monitoring and optimization
+- Operational procedures and checklists
+
+## 🗺️ **Navigation & Cross-References**
+
+### 🎯 **By User Journey**
+| Journey | Start Here | Next Steps | Advanced |
+|---------|------------|------------|----------|
+| **🚀 Quick Start** | [INDEX.md](INDEX.md) → [USER_GUIDE.md](USER_GUIDE.md) | [AGENTS.md](AGENTS.md) | [SPARC.md](SPARC.md) |
+| **🏗️ Development** | [DEVELOPMENT_WORKFLOW.md](DEVELOPMENT_WORKFLOW.md) | [API_DOCUMENTATION.md](API_DOCUMENTATION.md) | [ARCHITECTURE.md](ARCHITECTURE.md) |
+| **🚀 Deployment** | [DEPLOYMENT.md](DEPLOYMENT.md) | [SECURITY_AUDIT_REPORT.md](SECURITY_AUDIT_REPORT.md) | [architecture/](architecture/) |
+| **🤖 Agents** | [AGENTS.md](AGENTS.md) → [SWARM.md](SWARM.md) | [agent-analysis-report.md](agent-analysis-report.md) | [agent-scope-creep-prevention-guide.md](agent-scope-creep-prevention-guide.md) |
+
+### 📚 **Specialized Documentation**
+- **📁 [architecture/](architecture/)** - Architecture specifications and designs
+- **📁 [automation/](automation/)** - Test automation and CI/CD strategies
+- **📁 [implementation/](implementation/)** - Implementation guides and specifications
+- **📁 [ux-design/](ux-design/)** - User experience and interface design
+- **📁 [validation/](validation/)** - Validation reports and testing strategies
+- **📁 [performance/](performance/)** - Performance analysis and optimization
+- **📁 [research/](research/)** - Research findings and analysis reports
+
+### 🔗 **Cross-Reference Matrix**
+| If you're reading... | You might also need... |
+|---------------------|------------------------|
+| **[AGENTS.md](AGENTS.md)** | [SWARM.md](SWARM.md), [agent-analysis-report.md](agent-analysis-report.md) |
+| **[SWARM.md](SWARM.md)** | [ARCHITECTURE.md](ARCHITECTURE.md), [full-stack-swarm-team-specification.md](full-stack-swarm-team-specification.md) |
+| **[DEPLOYMENT.md](DEPLOYMENT.md)** | [SECURITY_AUDIT_REPORT.md](SECURITY_AUDIT_REPORT.md), [deployment-checklist.md](deployment-checklist.md) |
+| **[ARCHITECTURE.md](ARCHITECTURE.md)** | [architecture/](architecture/), [technical-implementation-guide.md](technical-implementation-guide.md) |
+| **[SPARC.md](SPARC.md)** | [DEVELOPMENT_WORKFLOW.md](DEVELOPMENT_WORKFLOW.md), [consolidated-cli-implementation.md](consolidated-cli-implementation.md) |
+
+## 🚀 Quick Access
+
+### 🎯 **Essential References**
+- **[🗺️ Complete Site Map](SITE_MAP.md)** - Find any documentation quickly
+- **[📖 Documentation Hub](INDEX.md)** - Guided navigation with learning paths
+- **[🎯 User Guide](USER_GUIDE.md)** - Step-by-step tutorials
+- **[🔧 API Reference](API_DOCUMENTATION.md)** - Complete API documentation
+
+### 🆘 **Need Help?**
+- **[📋 Troubleshooting Guide](troubleshooting.md)** - Common issues and solutions
+- **[🎯 CLI Validation](cli-validation-report.md)** - Command reference and validation
+- **[📊 Performance Tips](performance-analysis-report.md)** - Optimization strategies
+- **[📝 Validation Summary](validation-executive-summary.md)** - System validation status
+
+### 🔍 **Search Strategy**
+1. **Browse by topic** using the [Site Map](SITE_MAP.md)
+2. **Follow learning paths** in the [Documentation Hub](INDEX.md)
+3. **Check cross-references** within each document
+4. **Use specialized directories** for deep-dive topics
+
+## 📞 Support & Community
+
+### 🆘 **Get Help**
+- **🐛 [GitHub Issues](https://github.com/ruvnet/claude-flow/issues)** - Bug reports and feature requests
+- **💬 [Discord Community](https://discord.gg/claude-flow)** - Real-time community support
+- **📚 [Documentation](SITE_MAP.md)** - Comprehensive guides and references
+- **📧 Support**: support@claude-flow.ai
+
+### 🤝 **Contribute**
+- **📝 Documentation Updates** - Submit PRs to improve guides
+- **🔗 Cross-Reference Improvements** - Help enhance navigation
+- **🐛 Bug Reports** - Report issues via GitHub
+- **💡 Feature Suggestions** - Share ideas with the community
+
+### 🏷️ **Documentation Tags**
+`#core-docs` `#agents` `#swarm` `#sparc` `#deployment` `#architecture` `#api` `#mcp` `#validation` `#performance` `#ux` `#research`
+
+---
+
+<div align="center">
+
+## 🎯 **Find What You Need**
+
+**[🗺️ Site Map](SITE_MAP.md)** • **[📖 Documentation Hub](INDEX.md)** • **[🎯 User Guide](USER_GUIDE.md)** • **[🔧 API Docs](API_DOCUMENTATION.md)**
+
+---
+
+*This documentation system is maintained by the Cross-Reference Manager*
+*Last Updated: September 26, 2025 | Version: 2.0.0-alpha.88*
+
+</div>