Package Exports

claude-flow
claude-flow/src/cli/main.ts

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (claude-flow) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

🌊 Claude-Flow: Agent Orchestration Platform for Claude-Code

🎯 Transform Your Development Workflow

Claude-Flow is the ultimate multi-terminal orchestration platform that revolutionizes how you work with Claude Code. Imagine coordinating dozens of AI agents simultaneously, each working on different aspects of your project while sharing knowledge through an intelligent memory bank.

🔥 One command to rule them all: npx claude-flow - Deploy a full AI agent coordination system in seconds!

🌟 Why Claude-Flow?

🚀 10x Faster Development: Parallel AI agent execution with intelligent task distribution
🧠 Persistent Memory: Agents learn and share knowledge across sessions
🔄 Zero Configuration: Works out-of-the-box with sensible defaults
⚡ VSCode Native: Seamless integration with your favorite IDE
🔒 Enterprise Ready: Production-grade security, monitoring, and scaling
🌐 MCP Compatible: Full Model Context Protocol support for tool integration

📦 Installation

# 🚀 Get started in 30 seconds
npx claude-flow init
npx claude-flow start

# 🤖 Spawn a research team
npx claude-flow agent spawn researcher --name "Senior Researcher"
npx claude-flow agent spawn analyst --name "Data Analyst"
npx claude-flow agent spawn implementer --name "Code Developer"

# 📋 Create and execute tasks
npx claude-flow task create research "Research AI optimization techniques"
npx claude-flow task list

# 📊 Monitor in real-time
npx claude-flow status
npx claude-flow monitor

🏗️ Core Features

🤖 Multi-Agent Orchestration

Coordinate dozens of AI agents with different specializations, each running in isolated terminal sessions with intelligent load balancing.

🧠 Intelligent Memory Bank

Advanced CRDT-based memory system with SQLite performance and Markdown readability. Agents learn and share knowledge across sessions.

⚡ Terminal Virtualization

Native VSCode integration with terminal pooling, session recycling, and cross-platform shell support (Bash, Zsh, PowerShell, CMD).

🎯 Smart Task Scheduling

Priority-based task queues with dependency resolution, deadlock detection, and automatic retry with exponential backoff.

🔒 Enterprise Security

Token-based authentication, rate limiting, circuit breakers, audit logging, and role-based access control.

🌐 MCP Integration

Full Model Context Protocol support with stdio and HTTP transports, enabling seamless integration with external tools.

⚡ Quick Start

🎯 Option 1: NPX (Recommended)

# Install and run in one command
npx claude-flow

# Or install globally for repeated use
npm install -g claude-flow
claude-flow --version

🦕 Option 2: Deno (For Developers)

# Install via Deno
deno install --allow-all --name claude-flow \
  https://raw.githubusercontent.com/ruvnet/claude-code-flow/main/src/cli/index.ts

# Or run directly
deno run --allow-all \
  https://raw.githubusercontent.com/ruvnet/claude-code-flow/main/src/cli/index.ts

🔧 Option 3: From Source (For Contributors)

git clone https://github.com/ruvnet/claude-code-flow.git
cd claude-code-flow
deno task build && deno task install

📚 Documentation

Comprehensive documentation is available to help you get the most out of Claude-Flow:

Getting Started Guide - Quick setup and first steps
Architecture Overview - System design and components
Configuration Guide - Detailed configuration options
Agent Management - Working with AI agents
Task Coordination - Task scheduling and workflows
Memory Bank Usage - Persistent memory system
MCP Integration - Model Context Protocol tools
Terminal Management - Terminal pooling and sessions
Troubleshooting - Common issues and solutions
Advanced Usage - Power user features
CLI Reference - Complete command documentation

💡 Quick Start Guide

1. Initialize Claude Code Integration

npx claude-flow init

This creates:

CLAUDE.md - Claude Code configuration
memory-bank.md - Memory system documentation
coordination.md - Agent coordination documentation
Memory folder structure with placeholders

2. Start the Orchestrator

npx claude-flow start
# Or run as daemon
npx claude-flow start --daemon

3. Spawn Agents

# Spawn different agent types
npx claude-flow agent spawn researcher --name "Research Assistant"
npx claude-flow agent spawn implementer --name "Code Developer"
npx claude-flow agent spawn coordinator --name "Project Manager"

4. Create and Execute Tasks

# Create tasks with priorities
npx claude-flow task create research "Analyze market trends" --priority 8
npx claude-flow task create code "Implement authentication" --priority 9

# List active tasks
npx claude-flow task list --verbose

5. Spawn Claude Instances 🆕

# Spawn Claude with specific configuration
npx claude-flow claude spawn "implement user authentication" --research --parallel

# Run with custom tools
npx claude-flow claude spawn "fix payment bug" --tools "View,Edit,Bash" --no-permissions

# Execute batch workflow
npx claude-flow claude batch examples/claude-workflow.json --dry-run

6. Monitor System Status

# Check system health
npx claude-flow status

# Real-time monitoring
npx claude-flow monitor

# View MCP tools
npx claude-flow mcp tools

Architecture

Claude-Flow uses a modular architecture with the following components:

Orchestrator: Central coordinator managing all system components
Terminal Manager: Handles terminal sessions with pooling and recycling
Memory Manager: Persistent storage with caching and indexing
Coordination Manager: Task scheduling and resource management
MCP Server: Tool integration via Model Context Protocol

Configuration

Default configuration file (claude-flow.config.json):

{
  "orchestrator": {
    "maxConcurrentAgents": 10,
    "taskQueueSize": 100,
    "healthCheckInterval": 30000,
    "shutdownTimeout": 30000
  },
  "terminal": {
    "type": "auto",
    "poolSize": 5,
    "recycleAfter": 10,
    "healthCheckInterval": 60000,
    "commandTimeout": 300000
  },
  "memory": {
    "backend": "hybrid",
    "cacheSizeMB": 100,
    "syncInterval": 5000,
    "conflictResolution": "crdt",
    "retentionDays": 30
  },
  "coordination": {
    "maxRetries": 3,
    "retryDelay": 1000,
    "deadlockDetection": true,
    "resourceTimeout": 60000,
    "messageTimeout": 30000
  },
  "mcp": {
    "transport": "stdio",
    "port": 3000,
    "tlsEnabled": false
  },
  "logging": {
    "level": "info",
    "format": "json",
    "destination": "console"
  }
}

Agent Types

Claude-Flow supports multiple agent types:

Coordinator: Plans and delegates tasks to other agents
Researcher: Gathers and analyzes information
Implementer: Writes code and creates solutions
Analyst: Identifies patterns and generates insights
Custom: User-defined agent types

🛠️ CLI Commands

Claude-Flow provides a comprehensive CLI for managing your AI orchestration system. For detailed command documentation, see the CLI Reference.

🌐 Global Options

-c, --config <path>: Path to configuration file
-v, --verbose: Enable verbose logging
--log-level <level>: Set log level (debug, info, warn, error)
--version: Show version information
--help: Show help for any command

📋 Core Commands

`init` - Initialize Claude Code Integration

npx claude-flow init [options]
  -f, --force               Overwrite existing files
  -m, --minimal             Create minimal configuration files

Creates CLAUDE.md, memory-bank.md, coordination.md, and folder structure.

`start` - Start Orchestration System

npx claude-flow start [options]
  -d, --daemon              Run as daemon in background
  -p, --port <port>         MCP server port (default: 3000)

`status` - Show System Status

npx claude-flow status [options]
  -v, --verbose             Show detailed status information

`agent` - Manage AI Agents

npx claude-flow agent <subcommand>
  spawn <type>              Spawn a new agent (researcher/implementer/analyst/coordinator)
    --name <name>           Agent name
    --priority <1-10>       Agent priority
    --max-tasks <n>         Max concurrent tasks
  list                      List all active agents
  info <agent-id>          Get detailed agent information
  terminate <agent-id>      Terminate an agent

`task` - Manage Tasks

npx claude-flow task <subcommand>
  create <type> <desc>      Create a new task
    --priority <1-10>       Task priority
    --deps <task-ids>       Comma-separated dependency IDs
  list                      List all tasks
    --verbose               Show task descriptions
  status <task-id>          Get task status
  cancel <task-id>          Cancel a task
  workflow <file>           Execute workflow from file
    --async                 Run workflow asynchronously

`memory` - Manage Memory Bank

npx claude-flow memory <subcommand>
  query <search>            Search memory entries
    --namespace <ns>        Filter by namespace
    --limit <n>             Limit results
  store <key> <value>       Store information
    --namespace <ns>        Target namespace
  export <file>             Export memory to file
  import <file>             Import memory from file
  stats                     Show memory statistics
  cleanup                   Clean up old entries
    --days <n>              Entries older than n days

`mcp` - MCP Server Management

npx claude-flow mcp <subcommand>
  status                    Show MCP server status
  tools                     List available MCP tools
  config                    Show MCP configuration
  logs                      View MCP server logs
    --lines <n>             Number of log lines (default: 50)

`monitor` - Real-time Monitoring

npx claude-flow monitor [options]
  -i, --interval <seconds>  Update interval (default: 2)
  -c, --compact             Compact view mode
  -f, --focus <component>   Focus on specific component

`claude` - Spawn Claude Instances 🆕

npx claude-flow claude <subcommand>
  spawn <task>              Spawn Claude with specific configuration
    -t, --tools <tools>     Allowed tools (comma-separated)
    --no-permissions        Use --dangerously-skip-permissions flag
    -c, --config <file>     MCP config file path
    -m, --mode <mode>       Development mode (full/backend-only/frontend-only/api-only)
    --parallel              Enable parallel execution with BatchTool
    --research              Enable web research with WebFetchTool
    --coverage <n>          Test coverage target percentage (default: 80)
    --commit <freq>         Commit frequency (phase/feature/manual)
    -v, --verbose           Enable verbose output
    -d, --dry-run           Show what would be executed without running
    
  batch <workflow-file>     Execute multiple Claude instances from workflow
    --dry-run               Show what would be executed without running

`config` - Configuration Management

npx claude-flow config <subcommand>
  show                      Show current configuration
  get <path>                Get specific config value
  set <path> <value>        Set config value
  init [file]               Initialize config file
  validate <file>           Validate config file

`session` - Session Management

npx claude-flow session <subcommand>
  list                      List active sessions
  info <session-id>         Get session information
  terminate <session-id>    End a session

`workflow` - Workflow Execution

npx claude-flow workflow <file> [options]
  --validate                Validate workflow without executing
  --async                   Run workflow asynchronously
  --watch                   Watch workflow progress

`help` - Get Help

npx claude-flow help [command]

🎯 Common Use Cases

Research Project Setup:

npx claude-flow init
npx claude-flow start --daemon
npx claude-flow agent spawn researcher --name "Senior Researcher" --priority 8
npx claude-flow agent spawn analyst --name "Data Analyst" --priority 7
npx claude-flow task create research "Analyze competitor landscape" --priority 9
npx claude-flow monitor

Code Development Workflow:

npx claude-flow agent spawn implementer --name "Backend Dev" --max-tasks 3
npx claude-flow agent spawn implementer --name "Frontend Dev" --max-tasks 3
npx claude-flow agent spawn coordinator --name "Tech Lead"
npx claude-flow workflow development-pipeline.json --watch

Memory Operations:

npx claude-flow memory store "project-requirements" "Authentication using JWT" --namespace project
npx claude-flow memory query "authentication" --namespace project
npx claude-flow memory export project-knowledge.json

Workflow Example

Create a workflow file (example-workflow.json):

{
  "name": "Research and Analysis Workflow",
  "tasks": [
    {
      "id": "research-1",
      "type": "research",
      "description": "Research quantum computing basics",
      "assignTo": "researcher"
    },
    {
      "id": "analyze-1",
      "type": "analysis",
      "description": "Analyze research findings",
      "dependencies": ["research-1"],
      "assignTo": "analyst"
    },
    {
      "id": "report-1",
      "type": "report",
      "description": "Generate summary report",
      "dependencies": ["analyze-1"],
      "assignTo": "coordinator"
    }
  ]
}

Execute the workflow:

claude-flow task workflow example-workflow.json

Development

Prerequisites

Deno 1.38+ or Node.js 16+
Git

Setup

git clone https://github.com/ruvnet/claude-code-flow.git
cd claude-flow
deno task dev

Testing

deno task test

Building

deno task build

API Usage

Claude-Flow can also be used programmatically:

import { Orchestrator } from 'claude-flow';

const orchestrator = new Orchestrator(config);
await orchestrator.initialize();

// Spawn an agent
const sessionId = await orchestrator.spawnAgent({
  id: 'agent-1',
  name: 'Research Agent',
  type: 'researcher',
  // ... other properties
});

// Create and assign a task
await orchestrator.assignTask({
  id: 'task-1',
  type: 'research',
  description: 'Research AI trends',
  // ... other properties
});

Contributing

Contributions are welcome! Please read our Contributing Guide for details.

License

MIT License - see LICENSE file for details.

🔌 Integration with Claude Code

Claude-Flow seamlessly integrates with Claude Code through the CLAUDE.md file created by npx claude-flow init. This enables:

Automatic Context Loading: Claude Code reads your project configuration
Build Command Integration: All build/test commands are available to Claude
Memory Persistence: Claude remembers context across sessions
SPARC Methodology: Built-in support for structured AI development

Use with Claude Code:

# Initialize integration
npx claude-flow init

# Use with Claude Code SDK
claude --dangerously-skip-permissions

# Claude will automatically use the configuration from CLAUDE.md

🏢 Enterprise Features

🔐 Security: Token-based auth, rate limiting, audit logging
📊 Monitoring: Real-time metrics, performance tracking, health checks
🔄 Reliability: Circuit breakers, automatic retries, graceful degradation
📈 Scalability: Horizontal scaling, load balancing, resource pooling
🛡️ Compliance: Audit trails, data retention policies, access controls

📖 Resources

Documentation

Complete Documentation - All guides and references
API Documentation - Programmatic usage
Examples - Sample configurations and workflows
Memory System Docs - In-depth memory bank documentation

Community & Support

GitHub Issues - Bug reports and feature requests
GitHub Discussions - Community forum
Discord Server - Real-time chat and support
Stack Overflow - Q&A

Tutorials & Guides

Video Tutorials - Step-by-step video guides
Blog Posts - Tips, tricks, and use cases
Case Studies - Real-world implementations

🚀 Roadmap

Q1 2025

Initial release with core orchestration
Memory bank implementation
MCP integration
Claude Code integration (init command)
Web UI for visual orchestration
Plugin system for custom agent types

Q2 2025

Distributed orchestration support
Enhanced monitoring dashboard
Integration with more AI models
Workflow templates library
Cloud deployment options

Q3 2025

Enterprise SSO integration
Advanced analytics and reporting
Multi-tenant support
GraphQL API
Mobile app for monitoring

🤝 Contributing

We welcome contributions! See our Contributing Guide for:

Code of Conduct
Development setup
Submission guidelines
Coding standards
Testing requirements

📄 License