claude-flow 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 rUv
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,612 @@
+# 🚀 Claude-Flow: Multi-Terminal Claude-Code Agent Orchestration Platform
+
+<div align="center">
+
+[![🌟 Star on GitHub](https://img.shields.io/github/stars/ruvnet/claude-code-flow?style=for-the-badge&logo=github&color=gold)](https://github.com/ruvnet/claude-code-flow)
+[![📦 NPX Ready](https://img.shields.io/npm/v/claude-flow?style=for-the-badge&logo=npm&color=blue&label=NPX%20INSTALL)](https://www.npmjs.com/package/claude-flow)
+[![✅ 95% Test Coverage](https://img.shields.io/badge/coverage-95%25-brightgreen?style=for-the-badge&logo=codecov)](./test-results/coverage-html/index.html)
+[![🦕 Deno Powered](https://img.shields.io/badge/deno-v1.40+-blue?style=for-the-badge&logo=deno)](https://deno.land/)
+[![⚡ TypeScript](https://img.shields.io/badge/TypeScript-Strict-blue?style=for-the-badge&logo=typescript)](https://www.typescriptlang.org/)
+[![📖 Documentation](https://img.shields.io/badge/docs-comprehensive-green?style=for-the-badge&logo=gitbook)](./docs/)
+[![🛡️ MIT License](https://img.shields.io/badge/License-MIT-yellow?style=for-the-badge&logo=opensourceinitiative)](https://opensource.org/licenses/MIT)
+
+</div>
+
+<div align="center">
+  <img src="https://github.com/ruvnet/claude-code-flow/raw/main/assets/claude-flow-banner.png" alt="Claude-Flow Banner" width="800" />
+</div>
+
+## 🎯 **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
+
+## 🎬 **See It In Action**
+
+<div align="center">
+  
+[![Demo Video](https://img.shields.io/badge/🎥%20Watch%20Demo-Claude--Flow%20in%20Action-red?style=for-the-badge)](https://youtu.be/demo-video)
+[![Live Demo](https://img.shields.io/badge/🌐%20Try%20Live%20Demo-Interactive%20Playground-blue?style=for-the-badge)](https://demo.claude-flow.dev)
+
+</div>
+
+```bash
+# 🚀 Get started in 30 seconds
+npx claude-flow init
+npx claude-flow start
+
+# 🤖 Spawn a research team
+claude-flow agent spawn researcher --name "Senior Researcher"
+claude-flow agent spawn analyst --name "Data Analyst"
+claude-flow agent spawn implementer --name "Code Developer"
+
+# 📋 Create and execute tasks
+claude-flow task create research "Research AI optimization techniques"
+claude-flow task list
+
+# 📊 Monitor in real-time
+claude-flow status
+claude-flow monitor
+```
+
+## 🏗️ **Core Features**
+
+<table>
+<tr>
+<td width="33%" align="center">
+
+### 🤖 **Multi-Agent Orchestration**
+Coordinate dozens of AI agents with different specializations, each running in isolated terminal sessions with intelligent load balancing.
+
+</td>
+<td width="33%" align="center">
+
+### 🧠 **Intelligent Memory Bank**
+Advanced CRDT-based memory system with SQLite performance and Markdown readability. Agents learn and share knowledge across sessions.
+
+</td>
+<td width="33%" align="center">
+
+### ⚡ **Terminal Virtualization**
+Native VSCode integration with terminal pooling, session recycling, and cross-platform shell support (Bash, Zsh, PowerShell, CMD).
+
+</td>
+</tr>
+<tr>
+<td width="33%" align="center">
+
+### 🎯 **Smart Task Scheduling**
+Priority-based task queues with dependency resolution, deadlock detection, and automatic retry with exponential backoff.
+
+</td>
+<td width="33%" align="center">
+
+### 🔒 **Enterprise Security**
+Token-based authentication, rate limiting, circuit breakers, audit logging, and role-based access control.
+
+</td>
+<td width="33%" align="center">
+
+### 🌐 **MCP Integration**
+Full Model Context Protocol support with stdio and HTTP transports, enabling seamless integration with external tools.
+
+</td>
+</tr>
+</table>
+
+## ⚡ **Quick Start**
+
+### 🎯 **Option 1: NPX (Recommended)**
+```bash
+# 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)**
+```bash
+# 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)**
+```bash
+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](./docs/01-getting-started.md)** - Quick setup and first steps
+- **[Architecture Overview](./docs/02-architecture-overview.md)** - System design and components
+- **[Configuration Guide](./docs/03-configuration-guide.md)** - Detailed configuration options
+- **[Agent Management](./docs/04-agent-management.md)** - Working with AI agents
+- **[Task Coordination](./docs/05-task-coordination.md)** - Task scheduling and workflows
+- **[Memory Bank Usage](./docs/06-memory-bank-usage.md)** - Persistent memory system
+- **[MCP Integration](./docs/07-mcp-integration.md)** - Model Context Protocol tools
+- **[Terminal Management](./docs/08-terminal-management.md)** - Terminal pooling and sessions
+- **[Troubleshooting](./docs/09-troubleshooting.md)** - Common issues and solutions
+- **[Advanced Usage](./docs/10-advanced-usage.md)** - Power user features
+- **[CLI Reference](./docs/cli-reference.md)** - Complete command documentation
+
+## 💡 **Quick Start Guide**
+
+### 1. **Initialize Claude Code Integration**
+```bash
+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**
+```bash
+npx claude-flow start
+# Or run as daemon
+npx claude-flow start --daemon
+```
+
+### 3. **Spawn Agents**
+```bash
+# 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**
+```bash
+# 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. **Monitor System Status**
+```bash
+# 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`):
+
+```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](./docs/cli-reference.md).
+
+### 🌐 **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
+```bash
+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
+```bash
+npx claude-flow start [options]
+  -d, --daemon              Run as daemon in background
+  -p, --port <port>         MCP server port (default: 3000)
+```
+
+#### `status` - Show System Status
+```bash
+npx claude-flow status [options]
+  -v, --verbose             Show detailed status information
+```
+
+#### `agent` - Manage AI Agents
+```bash
+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
+```bash
+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
+```bash
+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
+```bash
+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
+```bash
+npx claude-flow monitor [options]
+  --interval <ms>           Update interval (default: 5000)
+  --metrics                 Show performance metrics
+```
+
+#### `config` - Configuration Management
+```bash
+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
+```bash
+npx claude-flow session <subcommand>
+  list                      List active sessions
+  info <session-id>         Get session information
+  terminate <session-id>    End a session
+```
+
+#### `workflow` - Workflow Execution
+```bash
+npx claude-flow workflow <file> [options]
+  --validate                Validate workflow without executing
+  --async                   Run workflow asynchronously
+  --watch                   Watch workflow progress
+```
+
+#### `help` - Get Help
+```bash
+npx claude-flow help [command]
+```
+
+### 🎯 **Common Use Cases**
+
+**Research Project Setup:**
+```bash
+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:**
+```bash
+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:**
+```bash
+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`):
+
+```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:
+```bash
+claude-flow task workflow example-workflow.json
+```
+
+## Development
+
+### Prerequisites
+- Deno 1.38+ or Node.js 16+
+- Git
+
+### Setup
+```bash
+git clone https://github.com/ruvnet/claude-code-flow.git
+cd claude-flow
+deno task dev
+```
+
+### Testing
+```bash
+deno task test
+```
+
+### Building
+```bash
+deno task build
+```
+
+## API Usage
+
+Claude-Flow can also be used programmatically:
+
+```typescript
+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](CONTRIBUTING.md) for details.
+
+## License
+
+MIT License - see [LICENSE](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:
+```bash
+# 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](./docs/)** - All guides and references
+- **[API Documentation](./docs/api/)** - Programmatic usage
+- **[Examples](./examples/)** - Sample configurations and workflows
+- **[Memory System Docs](./memory/docs/)** - In-depth memory bank documentation
+
+### Community & Support
+- **[GitHub Issues](https://github.com/ruvnet/claude-code-flow/issues)** - Bug reports and feature requests
+- **[GitHub Discussions](https://github.com/ruvnet/claude-code-flow/discussions)** - Community forum
+- **[Discord Server](https://discord.gg/claude-flow)** - Real-time chat and support
+- **[Stack Overflow](https://stackoverflow.com/questions/tagged/claude-flow)** - Q&A
+
+### Tutorials & Guides
+- **[Video Tutorials](https://youtube.com/claude-flow)** - Step-by-step video guides
+- **[Blog Posts](https://claude-flow.dev/blog)** - Tips, tricks, and use cases
+- **[Case Studies](https://claude-flow.dev/case-studies)** - Real-world implementations
+
+## 🚀 **Roadmap**
+
+### Q1 2025
+- [x] Initial release with core orchestration
+- [x] Memory bank implementation
+- [x] MCP integration
+- [x] 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](CONTRIBUTING.md) for:
+- Code of Conduct
+- Development setup
+- Submission guidelines
+- Coding standards
+- Testing requirements
+
+## 📄 **License**
+
+MIT License - see [LICENSE](LICENSE) file for details.
+
+## 🙏 **Acknowledgments**
+
+- Built on top of Claude Code and Anthropic's Claude AI
+- Inspired by the SPARC methodology
+- Thanks to all contributors and the Claude community
+
+## 📊 **Stats**
+
+![GitHub stars](https://img.shields.io/github/stars/ruvnet/claude-code-flow?style=social)
+![npm downloads](https://img.shields.io/npm/dm/claude-flow)
+![Contributors](https://img.shields.io/github/contributors/ruvnet/claude-code-flow)
+![Last commit](https://img.shields.io/github/last-commit/ruvnet/claude-code-flow)
+
+---
+
+Built with ❤️ by [rUv](https://github.com/ruvnet) for the Claude community