@liriraid/agentflow-ai 1.0.20 → 1.0.22

package/README.md

@@ -1,79 +1,231 @@
-# agentflow
+# agentflow-ai
 
-Reusable multi-agent orchestration workspace for coding projects.
+**Multi-Agent Orchestration System for AI-Powered Development**
 
-This package installs a CLI that creates a separate orchestrator workspace next to your real project. The generated workspace can be created in **English** or **Spanish**.
+A reusable workspace orchestrator that coordinates multiple AI coding agents (Claude, Codex, OpenCode, etc.) to work **in parallel** on real projects, while keeping the project repository **completely clean** of orchestrator files.
 
 ```text
-my-product-workspace/
-  my-product/                 # real project, stays clean
-  orchestrator-my-product/    # generated orchestrator workspace
+project-workspace/
+  my-project/          # Real project (stays clean)
+  orchestrator-my-project/  # Orchestrator workspace (generated)
 ```
 
-## Install
-
+## 🎯 What It Does
+
+- **Coordinates multiple AI agents** (Claude, Codex, OpenCode, Gemini, Cursor, Abacus) to work simultaneously on your project.
+- **Real-time monitoring** with a modern TUI (Terminal User Interface) that shows live agent status, queue, and progress.
+- **Automatic task delegation** based on agent specialization (analysis, implementation, code review).
+- **Persistent memory** using Engram to maintain context across sessions.
+- **Spec-Driven Development (SDD)** support with OpenSpec for large, multi-phase changes.
+- **Fallback system** that automatically reassigns tasks when an agent fails or reaches rate limits.
+- **Multi-language support** (English and Spanish) for all templates and documentation.
+
+## ✨ Key Features
+
+### 1. **Sibling Workspace Model**
+- The orchestrator creates a **separate workspace** next to your real project.
+- Your project repository **stays completely clean** (no `QUEUE.md`, `logs/`, or orchestrator files).
+- Agents work on the real project files via absolute paths configured in `orchestrator.config.json`.
+
+### 2. **Multi-Agent Coordination**
+| Agent | Role | Priority | Notes |
+|-------|------|----------|-------|
+| **Claude-Orchestrator** | Session coordinator | - | Never implements code directly; delegates to workers |
+| **Codex** | Primary implementation | 1st choice | Structured tasks, tests, docs |
+| **OpenCode** | Analysis + Implementation | 2nd choice | Uses your configured model |
+| **Claude-Worker** (Backend/Frontend) | Fallback implementation | 3rd choice | Takes over when Codex/OpenCode fail |
+| **Gemini** | Code review/audits | Optional | Disabled by default |
+| **Cursor/Abacus** | Mechanical tasks | Optional | Disabled by default |
+
+### 3. **Real-Time Operation**
+- **fs.watch on QUEUE.md**: Detects changes in **~1-2 seconds** (Linux/macOS: direct file watch; Windows: directory watch fallback).
+- **Live TUI updates**: The dashboard refreshes automatically when tasks are added, started, or completed.
+- **Instant notifications**: Claude-Orchestrator receives alerts in `INBOX.md` and `NOTIFY.md` when tasks finish.
+
+### 4. **Smart Task Delegation**
+- **Analysis tasks** → Always assigned to **OpenCode**.
+- **Implementation tasks** → Assigned to **Codex** (1st) → **OpenCode** (2nd) → **Claude-Worker** (3rd).
+- **Fallback chain**: `Codex → OpenCode → Claude-Worker` (automatic).
+
+### 5. **Persistent Memory & SDD**
+- **Engram**: Stores decisions, bugs, and findings across sessions.
+- **OpenSpec**: Supports `proposal.md`, `spec.md`, `design.md`, `tasks.md`, and `verify-report.md` for large changes.
+- **Handoffs**: Session summaries for continuity.
+
+## 🚀 Installation
+
+### Global CLI (Recommended)
 ```bash
-npm i -g @liriraid/agentflow
+pnpm add -g @liriraid/agentflow-ai
 ```
 
-## Create a Workspace
-
-Interactive language selection:
-
+### Local Development
 ```bash
-agentflow init-workspace C:/code/my-project
+git clone https://github.com/LiriRaid/agentflow-ai.git
+cd agentflow-ai
+pnpm install
 ```
 
-Direct language selection:
+## 🛠️ Quick Start
 
+### 1. Create an Orchestrator Workspace
 ```bash
+# Interactive (asks for language)
+agentflow init-workspace C:/code/my-project
+
+# Direct (English)
 agentflow init-workspace C:/code/my-project --lang en
+
+# Direct (Spanish)
 agentflow init-workspace C:/code/mi-proyecto --lang es
 ```
+This creates a sibling workspace (e.g., `orchestrator-my-project/`) with all configuration files.
+
+### 2. Configure Repositories
+Edit `orchestrator.config.json` in the generated workspace:
+```json
+{
+  "repos": {
+    "backend": "C:/code/my-backend",
+    "frontend": "C:/code/my-frontend"
+  }
+}
+```
 
-The selected language controls the generated workspace files:
-
-- `ORCHESTRATOR.md`
-- `CLAUDE.md`
-- `QUEUE.md`
-- `PROJECT.md`
-- `README.md`
-- `agents/`
-- `docs/`
-- `openspec/`
-- `.claude/`
-- `.codex/`
-- `.opencode/`
-- `.atl/`
-- `orchestrator.config.json`
-
-## Runtime
-
-The package runtime remains language-aware through `workspaceLanguage` in the generated `orchestrator.config.json`.
-
-Start the TUI from the generated orchestrator workspace:
-
+### 3. Start the TUI
 ```bash
-cd C:/code/orchestrator-my-project
+cd orchestrator-my-project
 agentflow ink --paused
 ```
+**Controls:**
+- `S`: Start/Resume
+- `P`: Pause
+- `R`: Reload queue
+- `Q`: Quit (stops all agents)
+
+### 4. Launch Claude Code
+Open a second terminal in the **orchestrator workspace** (not the real project):
+```bash
+cd orchestrator-my-project
+claude
+```
+Then run:
+```
+Read ORCHESTRATOR.md and start.
+```
 
-Then open Claude Code in the same workspace and start with the prompt from that workspace's `ORCHESTRATOR.md`.
-
-## What Gets Packaged
+### 5. Request Work
+Examples:
+- `"Explore this project"` → OpenCode analyzes and reports.
+- `"Add JWT authentication"` → OpenCode analyzes, then Codex/OpenCode implement.
+- `"Refactor the API layer"` → OpenCode explores, then workers implement in parallel.
 
-The npm package ships:
+## 📁 Workspace Structure
 
-- `bin/`
-- `src/`
-- `scripts/`
-- `templates/en/`
-- `templates/es/`
-- `orchestrator.js`
-- `LICENSE`
+The generated workspace includes:
 
-The workspace docs and prompts live inside `templates/en` and `templates/es`; they are copied into the generated workspace based on the selected language.
+```text
+orchestrator-my-project/
+├── ORCHESTRATOR.md      # Core rules for the orchestrator session
+├── CLAUDE.md            # Routing rules for Claude
+├── QUEUE.md             # Active task queue (TASK-NNN | title | agent | ...)
+├── ENGRAM.md            # Persistent memory conventions
+├── orchestrator.config.json  # Repos, agents, models, and profiles
+├── agents/              # Agent-specific instructions
+│   ├── BACKEND.md
+│   ├── FRONTEND.md
+│   ├── CODEX.md
+│   └── OPENCODE.md
+├── .claude/             # Local Claude skills and config
+│   └── skills/          # Orchestrator skills (init, explore, etc.)
+├── .codex/              # Codex config
+├── .opencode/           # OpenCode config
+├── openspec/            # SDD artifacts
+│   ├── changes/
+│   └── templates/
+├── docs/                # Documentation
+├── logs/                # Execution logs
+├── handoffs/            # Session handoffs
+└── progress/            # Agent progress reports
+```
 
-## Acknowledgements
+## 🎛️ Configuration
+
+### Agent Configuration (`orchestrator.config.json`)
+```json
+{
+  "projectName": "My Project",
+  "workspaceLanguage": "es",
+  "maxConcurrent": 5,
+  "pollIntervalSeconds": 5,  // Fallback polling (realtime uses fs.watch)
+  "taskTimeoutMinutes": 30,
+  "repos": {
+    "backend": "C:/code/my-backend",
+    "frontend": "C:/code/my-frontend"
+  },
+  "agentProfiles": {
+    "claude": { "enabled": true, "localConfigDir": ".claude" },
+    "codex": { "enabled": true, "localConfigDir": ".codex" },
+    "opencode": { "enabled": true, "localConfigDir": ".opencode" }
+  },
+  "agents": {
+    "Backend": { "cli": "claude", "defaultRepo": "backend" },
+    "Frontend": { "cli": "claude", "defaultRepo": "frontend" },
+    "Codex": { "cli": "codex", "defaultRepo": "backend" },
+    "OpenCode": { "cli": "opencode", "defaultRepo": "frontend" }
+  }
+}
+```
 
-Inspired by [Orquestador-AI](https://github.com/ariellontero/Orquestador-AI) by Ariel Lontero (originally MIT). Built from scratch with a different architecture (Ink TUI, npm package, multi-language template system).
+### Model Selection
+Each agent uses the model you have configured in its own CLI. You can optionally override it by adding `"model": "model-name"` to any agent entry — for Claude this accepts values like `sonnet` or `opus`.
+
+## 🔄 Workflow Example
+
+1. **User Request**: `"Add user authentication to the backend."`
+2. **Claude-Orchestrator**:
+   - Creates `TASK-001` (OpenCode): `"Analyze current auth system"`
+   - Waits for OpenCode's report in `progress/PROGRESS-OpenCode.md`
+3. **OpenCode**:
+   - Analyzes the codebase.
+   - Writes findings to `progress/PROGRESS-OpenCode.md` and `INBOX.md`.
+4. **Claude-Orchestrator**:
+   - Reads OpenCode's report.
+   - Creates `TASK-002` (Codex): `"Implement JWT auth"` (depends on TASK-001).
+5. **Codex**:
+   - Implements the feature.
+   - Reports completion in `progress/PROGRESS-Codex.md`.
+6. **TUI**:
+   - Shows real-time updates (task status, agent activity, costs).
+
+## 📊 Supported Agents & Models
+
+| Agent | CLI | Model | Implementation? | Notes |
+|-------|-----|-------|----------------|-------|
+| Backend | `claude` | auto | ✅ Yes | Claude-Worker for backend tasks |
+| Frontend | `claude` | auto | ✅ Yes | Claude-Worker for frontend tasks |
+| Codex | `codex` | auto | ✅ Yes | Primary implementation |
+| OpenCode | `opencode` | auto | ✅ Yes | Secondary implementation |
+| Gemini | `gemini` | auto | ❌ No | Audits/reviews only |
+| Cursor | `cursor` | auto | ❌ No | Bulk edits only |
+| Abacus | `abacusai` | auto | ❌ No | Small focused tasks |
+
+## 🛡️ Safety & Best Practices
+
+- **No auto-commits**: Agents never run `git commit` or `git push`.
+- **No YOLO by default**: Safe permissions mode is enabled unless `--yolo` is used.
+- **Claude as reviewer**: Claude-Orchestrator validates all work before user approval.
+- **Clean repos**: Project files stay untouched; orchestrator files live in the sibling workspace.
+- **Fallback safety**: Tasks are automatically reassigned if an agent fails.
+
+## 📚 Documentation
+
+- **Core Rules**: See `ORCHESTRATOR.md` in the generated workspace.
+- **Agent Routing**: See `CLAUDE.md`.
+- **Architecture**: See `docs/architecture.md`.
+- **OpenSpec**: See `openspec/FLOW.md`.
+
+## 🤝 Acknowledgements
+
+Inspired by [Orquestador-AI](https://github.com/ariellontero/Orquestador-AI) by Ariel Lontero (MIT). 
+Built from scratch with a modern architecture: **Ink TUI + React, npm package, real-time fs.watch, multi-language templates, and multi-agent coordination**.

package/orchestrator.js

@@ -33,13 +33,11 @@ const CONFIG_TEMPLATE = {
     Backend: {
       cli: "claude",
       defaultRepo: "backend",
-      model: "sonnet",
       instructionsFile: "agents/BACKEND.md",
     },
     Frontend: {
       cli: "claude",
       defaultRepo: "frontend",
-      model: "sonnet",
       instructionsFile: "agents/FRONTEND.md",
     },
     Codex: {
@@ -1010,6 +1008,36 @@ function parseCompletedFromFile() {
 }
 
 const loggedUnknownAgents = new Set();
+let queueWatcher = null;
+
+function setupQueueWatcher() {
+  if (!fs.existsSync(QUEUE_FILE)) return;
+  
+  if (queueWatcher) {
+    try { queueWatcher.close(); } catch {}
+    queueWatcher = null;
+  }
+  
+  try {
+    queueWatcher = fs.watch(QUEUE_FILE, { persistent: false }, (eventType, filename) => {
+      if (eventType === 'change' && filename === path.basename(QUEUE_FILE)) {
+        log('DEBUG', `QUEUE.md changed, reloading queue immediately`);
+        reloadQueue();
+        scheduleNext();
+        renderDashboard();
+      }
+    });
+    queueWatcher.on('error', (err) => {
+      log('WARN', `fs.watch failed for QUEUE.md: ${err.message}, falling back to polling`);
+      queueWatcher = null;
+    });
+    log('INFO', 'Realtime QUEUE.md watcher enabled');
+  } catch (err) {
+    log('WARN', `Failed to setup QUEUE.md watcher: ${err.message}, using polling`);
+    queueWatcher = null;
+  }
+}
+
 function reloadQueue() {
   state.queue = parseQueue();
   const activeIds = new Set([
@@ -1954,14 +1982,55 @@ setInterval(() => {
   if (command) applyControlCommand(command);
 }, 1000);
 
-// Real-time queue detection — watches WORKSPACE directory (not the file directly)
-// because on Windows fs.watch on a file is unreliable; watching the parent dir
-// and filtering by filename is the stable pattern (same as AWAY MODE watcher).
+// Real-time queue detection — watches QUEUE.md directly with fallback to WORKSPACE directory
+// fs.watch on the file itself works reliably on Linux/macOS; fallback to WORKSPACE for Windows
 let _queueWatchDebounce = null;
+let _queueWatcher = null;
+
 function startQueueWatcher() {
+  if (_queueWatcher) {
+    try { _queueWatcher.close(); } catch {}
+    _queueWatcher = null;
+  }
+  
+  try {
+    // Try to watch the file directly first (best for Linux/macOS)
+    _queueWatcher = fs.watch(QUEUE_FILE, { persistent: false }, (eventType, filename) => {
+      if (_queueWatchDebounce) clearTimeout(_queueWatchDebounce);
+      _queueWatchDebounce = setTimeout(() => {
+        if (!fs.existsSync(QUEUE_FILE)) return;
+        const prevCount = state.queue.length;
+        reloadQueue();
+        if (!state.paused) scheduleNext();
+        renderDashboard();
+        if (state.queue.length > prevCount)
+          log("INFO", WORKSPACE_LANGUAGE === "es"
+            ? `Nueva tarea detectada en QUEUE.md (realtime)`
+            : `New task detected in QUEUE.md (realtime)`);
+      }, 10); // Faster debounce for direct file watch
+    });
+    _queueWatcher.on('error', () => {
+      // Fallback to WORKSPACE directory watch if direct file watch fails (Windows)
+      log('WARN', WORKSPACE_LANGUAGE === "es"
+        ? `No se pudo verificar QUEUE.md directamente, usando watcher de directorio`
+        : `Could not watch QUEUE.md directly, falling back to directory watcher`);
+      setupFallbackQueueWatcher();
+    });
+  } catch (err) {
+    log('WARN', `Queue watcher error: ${err.message}, using fallback`);
+    setupFallbackQueueWatcher();
+  }
+}
+
+function setupFallbackQueueWatcher() {
+  if (_queueWatcher) {
+    try { _queueWatcher.close(); } catch {}
+    _queueWatcher = null;
+  }
+  
   try {
     const watchName = path.basename(QUEUE_FILE);
-    const watcher = fs.watch(WORKSPACE, {persistent: false}, (eventType, filename) => {
+    _queueWatcher = fs.watch(WORKSPACE, { persistent: false }, (eventType, filename) => {
       if (filename !== watchName) return;
       if (_queueWatchDebounce) clearTimeout(_queueWatchDebounce);
       _queueWatchDebounce = setTimeout(() => {
@@ -1976,10 +2045,12 @@ function startQueueWatcher() {
             : `New task detected in QUEUE.md`);
       }, 50);
     });
-    watcher.on('error', () => {});
+    _queueWatcher.on('error', () => {});
   } catch {}
 }
+
 startQueueWatcher();
+setupQueueWatcher();
 
 // Slow fallback (5 min) — only runs if there is actually pending work or busy agents
 // fs.watch handles real-time; this is just a safety net

package/package.json

@@ -1,60 +1,63 @@
-{
-  "name": "@liriraid/agentflow-ai",
-  "version": "1.0.20",
-  "description": "Multi-agent workspace orchestrator with TUI. Coordinates AI coding agents over your real frontend and backend projects.",
-  "author": "LiriRaid",
-  "homepage": "https://github.com/LiriRaid/agentflow-ai#readme",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/LiriRaid/agentflow-ai.git"
-  },
-  "bugs": {
-    "url": "https://github.com/LiriRaid/agentflow-ai/issues"
-  },
-  "publishConfig": {
-    "access": "public"
-  },
-  "main": "orchestrator.js",
-  "bin": {
-    "agentflow": "bin/agentflow.mjs"
-  },
-  "files": [
-    "bin",
-    "src",
-    "templates",
-    "orchestrator.js",
-    "LICENSE"
-  ],
-  "scripts": {
-    "start": "node orchestrator.js",
-    "start:paused": "node orchestrator.js --paused",
-    "start:ink": "node src/ink/index.mjs",
-    "start:ink:paused": "node src/ink/index.mjs --paused",
-    "cli:help": "node bin/agentflow.mjs --help"
-  },
-  "keywords": [
-    "ai",
-    "agents",
-    "orchestrator",
-    "agentflow-ai",
-    "claude",
-    "codex",
-    "gemini",
-    "cursor",
-    "opencode",
-    "abacus",
-    "tui",
-    "multi-agent",
-    "coding-assistant",
-    "openspec",
-    "engram",
-    "skills",
-    "agent-config"
-  ],
-  "license": "MIT",
-  "dependencies": {
-    "blessed": "^0.1.81",
-    "ink": "^5.2.1",
-    "react": "^18.3.1"
-  }
-}
+{
+  "name": "@liriraid/agentflow-ai",
+  "version": "1.0.22",
+  "description": "Multi-agent workspace orchestrator with TUI. Coordinates AI coding agents over your real frontend and backend projects.",
+  "author": "LiriRaid",
+  "homepage": "https://github.com/LiriRaid/agentflow-ai#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/LiriRaid/agentflow-ai.git"
+  },
+  "bugs": {
+    "url": "https://github.com/LiriRaid/agentflow-ai/issues"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "main": "orchestrator.js",
+  "bin": {
+    "agentflow": "bin/agentflow.mjs"
+  },
+  "files": [
+    "bin",
+    "src",
+    "templates",
+    "orchestrator.js",
+    "LICENSE"
+  ],
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "keywords": [
+    "ai",
+    "agents",
+    "orchestrator",
+    "agentflow-ai",
+    "claude",
+    "codex",
+    "gemini",
+    "cursor",
+    "opencode",
+    "abacus",
+    "tui",
+    "multi-agent",
+    "coding-assistant",
+    "openspec",
+    "engram",
+    "skills",
+    "agent-config"
+  ],
+  "license": "MIT",
+  "dependencies": {
+    "blessed": "^0.1.81",
+    "ink": "^5.2.1",
+    "react": "^18.3.1"
+  },
+  "scripts": {
+    "start": "node orchestrator.js",
+    "start:paused": "node orchestrator.js --paused",
+    "start:ink": "node src/ink/index.mjs",
+    "start:ink:paused": "node src/ink/index.mjs --paused",
+    "cli:help": "node bin/agentflow.mjs --help"
+  }
+}

package/templates/en/.claude/hooks/notify-check.js

@@ -1,20 +1,20 @@
-#!/usr/bin/env node
-'use strict';
-// Reads NOTIFY.md from the workspace and writes its content to stdout so the
-// Claude Code hook injects it into the interactive session.
-// The file is deleted after reading to avoid repeating the notification.
-const fs = require('fs');
-const path = require('path');
-
-const notifyFile = path.join(process.cwd(), 'NOTIFY.md');
-if (!fs.existsSync(notifyFile)) process.exit(0);
-
-const content = fs.readFileSync(notifyFile, 'utf8').trim();
-if (!content) {
-  try { fs.unlinkSync(notifyFile); } catch {}
-  process.exit(0);
-}
-
-try { fs.unlinkSync(notifyFile); } catch {}
-
-process.stdout.write('\n' + content + '\n');
+#!/usr/bin/env node
+'use strict';
+// Reads NOTIFY.md from the workspace and writes its content to stdout so the
+// Claude Code hook injects it into the interactive session.
+// The file is deleted after reading to avoid repeating the notification.
+const fs = require('fs');
+const path = require('path');
+
+const notifyFile = path.join(process.cwd(), 'NOTIFY.md');
+if (!fs.existsSync(notifyFile)) process.exit(0);
+
+const content = fs.readFileSync(notifyFile, 'utf8').trim();
+if (!content) {
+  try { fs.unlinkSync(notifyFile); } catch {}
+  process.exit(0);
+}
+
+try { fs.unlinkSync(notifyFile); } catch {}
+
+process.stdout.write('\n' + content + '\n');

package/templates/en/.claude/settings.json

@@ -1,24 +1,24 @@
-{
-  "hooks": {
-    "Stop": [
-      {
-        "hooks": [
-          {
-            "type": "command",
-            "command": "node .claude/hooks/notify-check.js"
-          }
-        ]
-      }
-    ],
-    "UserPromptSubmit": [
-      {
-        "hooks": [
-          {
-            "type": "command",
-            "command": "node .claude/hooks/notify-check.js"
-          }
-        ]
-      }
-    ]
-  }
-}
+{
+  "hooks": {
+    "Stop": [
+      {
+        "hooks": [
+          {
+            "type": "command",
+            "command": "node .claude/hooks/notify-check.js"
+          }
+        ]
+      }
+    ],
+    "UserPromptSubmit": [
+      {
+        "hooks": [
+          {
+            "type": "command",
+            "command": "node .claude/hooks/notify-check.js"
+          }
+        ]
+      }
+    ]
+  }
+}