v2/docs/INDEX.md
The ultimate AI agent orchestration platform with 54+ specialized agents, 112 MCP tools, and swarm intelligence. Build, deploy, and scale AI-powered applications with unprecedented speed and reliability.
# Install and initialize
npx claude-flow@alpha init --force
# Verify installation
npx claude-flow@alpha --version
# Create your first AI swarm
npx claude-flow@alpha swarm "build a REST API for user management"
# Use SPARC development methodology
npx claude-flow@alpha sparc tdd "user authentication system"
# Spawn specialized agent teams
npx claude-flow@alpha hive-mind spawn "full-stack web app"
# Batch processing with multiple modes
npx claude-flow@alpha sparc batch research,architecture,code "microservices platform"
# Complete development pipeline
npx claude-flow@alpha sparc pipeline "e-commerce platform with payments"
# GitHub integration
npx claude-flow@alpha github pr-manager "review and merge pending PRs"
| Category | Agents | Capabilities |
|---|---|---|
| Core Development | coder, reviewer, tester, planner, researcher | Full development lifecycle |
| Specialized | backend-dev, mobile-dev, ml-developer, system-architect | Domain expertise |
| Swarm Coordination | hierarchical-coordinator, mesh-coordinator, adaptive-coordinator | Distributed intelligence |
| GitHub Integration | pr-manager, code-review-swarm, issue-tracker, release-manager | Complete DevOps |
| Performance | perf-analyzer, performance-benchmarker, production-validator | Optimization & validation |
Complete automation toolkit covering file operations, system management, GitHub integration, performance monitoring, and distributed coordination.
# Complete web application with 8-agent swarm
npx claude-flow@alpha swarm --agents 8 "build full-stack e-commerce platform"
# SPARC TDD workflow
npx claude-flow@alpha sparc tdd "payment processing system"
# Multi-agent code review
npx claude-flow@alpha github code-review-swarm --pr 123
# Performance optimization swarm
npx claude-flow@alpha swarm "optimize API performance" --agents perf-analyzer,coder,tester
# Machine learning pipeline
npx claude-flow@alpha swarm "build ML model training pipeline" --agents ml-developer,backend-dev,tester
# List all available modes and agents
npx claude-flow@alpha sparc modes
npx claude-flow@alpha agents list
# Initialize MCP integration
npx claude-flow@alpha mcp start
# Monitor swarm status
npx claude-flow@alpha swarm status
# Export session data
npx claude-flow@alpha hooks session-end --export-metrics true
# Pre-task setup
npx claude-flow@alpha hooks pre-task --description "task description"
# Post-edit notifications
npx claude-flow@alpha hooks post-edit --file "path/to/file"
# Performance analysis
npx claude-flow@alpha hooks post-task --analyze-performance true
# Initialize GitHub integration
npx claude-flow@alpha github init
# Manage pull requests
npx claude-flow@alpha github pr-manager
# Track issues
npx claude-flow@alpha github issue-tracker
# Release management
npx claude-flow@alpha github release-manager
# Clear npm cache and reinstall
npm cache clean --force
npx claude-flow@alpha init --force --reset
# Check MCP server status
npx claude-flow@alpha mcp status
# Restart MCP server
npx claude-flow@alpha mcp restart
# Clear agent memory
npx claude-flow@alpha memory clear
# Reset session state
npx claude-flow@alpha hooks session-restore --reset
# Enable performance monitoring
npx claude-flow@alpha hooks post-task --analyze-performance true
# Reduce agent count for resource-constrained environments
npx claude-flow@alpha --agents 3 swarm "task description"
| Component | Minimum | Recommended | Enterprise |
|---|---|---|---|
| Node.js | v20.0.0 | v20 LTS | v20 LTS |
| RAM | 2 GB | 8 GB | 16+ GB |
| CPU | 2 cores | 4 cores | 8+ cores |
| Disk | 500 MB | 2 GB | 10+ GB |
| Network | Broadband | High-speed | Dedicated |
βββ π README.md # Documentation hub overview
βββ ποΈ ARCHITECTURE.md # System design & patterns
βββ π DEPLOYMENT.md # Installation & production setup
βββ π οΈ DEVELOPMENT_WORKFLOW.md # Development best practices
βββ π‘ API_DOCUMENTATION.md # Complete API reference
docs/
βββ π README.md & INDEX.md # Core entry points
β
βββ π releases/ # Release Notes & Changelogs
β βββ RELEASE_v2.7.1.md # v2.7.1 release notes
β βββ RELEASE_SUMMARY_v2.7.1.md # v2.7.1 summary
β βββ RELEASE-NOTES-v2.7.0-alpha.10.md # Alpha 10 release notes
β βββ RELEASE-NOTES-v2.7.0-alpha.9.md # Alpha 9 release notes
β βββ ALPHA_TAG_UPDATE.md # Alpha versioning guide
β
βββ π§ agentdb/ # AgentDB v1.3.9 Integration
β βββ SWARM_IMPLEMENTATION_COMPLETE.md # 3-agent swarm (180 tests)
β βββ AGENTDB_INTEGRATION_PLAN.md # Integration planning
β βββ BACKWARD_COMPATIBILITY_GUARANTEE.md # 100% compatibility
β βββ PUBLISHING_CHECKLIST.md # Pre-release verification
β βββ agentdb-integration-summary.md # Quick overview
β βββ PRODUCTION_READINESS.md # Deployment guide
β βββ OPTIMIZATION_REPORT.md # Performance analysis
β
βββ β‘ performance/ # Performance Optimization
β βββ PERFORMANCE-JSON-IMPROVEMENTS.md # JSON optimization
β βββ PERFORMANCE-METRICS-GUIDE.md # Metrics tracking
β
βββ π§ fixes/ # Bug Fixes & Patches
β βββ PATTERN_PERSISTENCE_FIX.md # v2.7.1 critical fix
β βββ PATTERN_FIX_CONFIRMATION.md # Verification results
β βββ CLI-MEMORY-COMMANDS-WORKING.md # Memory command fixes
β
βββ π οΈ development/ # Development Reports
β βββ AGENT1_COMPLETION_REPORT.md # AgentDB integration agent
β βββ FINAL_INIT_STRUCTURE.md # Initialization architecture
β βββ COMMANDS_TO_SKILLS_MIGRATION.md # Migration guide
β
βββ β
validation/ # Testing & Validation
β βββ DOCKER_VERIFICATION_REPORT.md # Docker testing results
β
βββ π guides/ # User Guides & Tutorials
β βββ skills-tutorial.md # 25 Claude Flow skills
β
βββ π integrations/ # Platform Integrations
β βββ reasoningbank/ # ReasoningBank AI integration (16 docs)
β βββ agentic-flow/ # Agentic Flow system (5 docs)
β βββ agent-booster/ # Agent performance optimization
β βββ epic-sdk/ # Epic SDK integration
β
βββ ποΈ architecture/ # Architecture documentation
βββ π¬ experimental/ # Experimental features
βββ π reference/ # API & command reference
βββ βοΈ setup/ # Setup & configuration
βββ π ci-cd/ # CI/CD workflows
βββ π¦ sdk/ # SDK documentation
βββ π wiki/ # Additional wiki content
| Component | Minimum | Recommended |
|---|---|---|
| Node.js | v20.0.0 | v20 LTS |
| npm | v9.0.0 | Latest |
| RAM | 2 GB | 8 GB |
| CPU | 2 cores | 4+ cores |
| Disk | 500 MB | 2 GB |
# Hierarchical coordination for complex projects
npx claude-flow@alpha swarm --topology hierarchical "enterprise application"
# Mesh coordination for peer collaboration
npx claude-flow@alpha swarm --topology mesh "code review and optimization"
# Adaptive coordination for dynamic requirements
npx claude-flow@alpha swarm --topology adaptive "evolving microservices architecture"
# Persistent memory across sessions
npx claude-flow@alpha hooks session-restore --session-id "project-alpha"
# Cross-agent memory sharing
npx claude-flow@alpha hooks post-edit --memory-key "swarm/shared/architecture"
# Memory cleanup and optimization
npx claude-flow@alpha memory optimize --threshold 0.8
# Enable concurrent execution (CRITICAL)
npx claude-flow@alpha swarm --parallel --max-concurrent 5
# Performance monitoring and analysis
npx claude-flow@alpha hooks post-task --analyze-performance true
# Resource usage optimization
npx claude-flow@alpha --agents 3 --memory-limit 4GB swarm "task"
# Automated commit with agent coordination
npx claude-flow@alpha hooks pre-task --git-integration
# Pull request management with swarm review
npx claude-flow@alpha github pr-manager --auto-review
# Release coordination across agents
npx claude-flow@alpha github release-manager --version 2.1.0
# Pre-commit hooks with agent validation
npx claude-flow@alpha hooks pre-commit --validate
# Post-deployment testing swarm
npx claude-flow@alpha swarm "validate production deployment" --agents tester,production-validator
# Performance regression testing
npx claude-flow@alpha swarm "performance regression analysis" --agents performance-benchmarker,perf-analyzer
# Production cluster initialization
npx claude-flow@alpha init --production --cluster-size 10
# Load balancing configuration
npx claude-flow@alpha configure --load-balancer --replicas 5
# High availability setup
npx claude-flow@alpha deploy --ha --backup-strategy distributed
# Real-time metrics dashboard
npx claude-flow@alpha monitor --dashboard --port 3000
# Health check automation
npx claude-flow@alpha health-check --interval 30s --alerts
# Performance analytics
npx claude-flow@alpha analytics --export-metrics --format prometheus
Track your progress with these benchmarks:
// Initialize Claude Flow client
const claudeFlow = new ClaudeFlowClient({
apiKey: process.env.CLAUDE_FLOW_API_KEY,
version: '2.0.0-alpha.88'
});
// Spawn agent swarm
const swarm = await claudeFlow.swarm.create({
task: "build microservices architecture",
agents: ["system-architect", "backend-dev", "tester"],
topology: "hierarchical"
});
// Monitor progress
swarm.on('progress', (update) => {
console.log(`Task: ${update.task}, Status: ${update.status}`);
});
// Connect to real-time updates
const ws = new WebSocket('wss://api.claude-flow.ai/v2/ws');
ws.on('swarm:update', (data) => {
console.log('Swarm Progress:', data);
});
ws.on('agent:complete', (data) => {
console.log('Agent Completed:', data.agentId, data.result);
});
# ALWAYS batch operations in single messages
# β
CORRECT: Everything in ONE command
npx claude-flow@alpha swarm --agents coder,tester,reviewer --parallel "full-stack app"
# β WRONG: Sequential commands (6x slower)
# npx claude-flow@alpha agent spawn coder
# npx claude-flow@alpha agent spawn tester
# npx claude-flow@alpha agent spawn reviewer
# Efficient memory usage patterns
npx claude-flow@alpha hooks post-edit --memory-key "swarm/shared/patterns" --compress
# Cross-session persistence
npx claude-flow@alpha hooks session-restore --optimize-memory
# Memory cleanup automation
npx claude-flow@alpha memory gc --threshold 0.9
# Match agents to task complexity
# Simple tasks (1-3 agents)
npx claude-flow@alpha --agents 3 swarm "bug fix in authentication"
# Medium tasks (4-7 agents)
npx claude-flow@alpha --agents 6 swarm "new feature with tests and docs"
# Complex tasks (8-12 agents)
npx claude-flow@alpha --agents 10 swarm "full enterprise application"
54+ Specialized Agents β’ 112 MCP Tools β’ Swarm Intelligence β’ Enterprise Ready
npx claude-flow@alpha init --force
π Quick Start β’ π Documentation β’ π¬ Community β’ π Issues
Transform your development workflow today with the power of AI swarm intelligence.
Last Updated: August 13, 2025 β’ Version 2.0.0-alpha.88
</div>