@elizaos/plugin-agent-orchestrator 0.1.0 → 0.2.0

package/README.md

@@ -2,6 +2,8 @@
 
 Orchestrate CLI-based coding agents (Claude Code, Codex, Gemini CLI, Aider, Pi) via PTY sessions and manage git workspaces for autonomous coding tasks.
 
+Built for [Milady](https://github.com/milady-ai/milady). The plugin registers ElizaOS-compatible actions and services, so any ElizaOS agent can spawn and manage coding agents via chat. The full experience — live xterm terminal views, real-time PTY output streaming, and the swarm monitoring dashboard — requires the Milady frontend and server.
+
 ## Features
 
 - **PTY Session Management**: Spawn, control, and monitor coding agents running in pseudo-terminals
@@ -9,14 +11,33 @@ Orchestrate CLI-based coding agents (Claude Code, Codex, Gemini CLI, Aider, Pi)
 - **PR Workflow**: Commit changes, push to remote, create pull requests
 - **Multi-Agent Support**: Claude Code, Codex, Gemini CLI, Aider, Pi, or generic shell
 
-## Installation
+## Prerequisites
+
+This plugin spawns CLI coding agents in PTY sessions. You need **at least one** of the following installed on your machine:
+
+| Agent | Install | Docs |
+|-------|---------|------|
+| **Claude Code** | `npm install -g @anthropic-ai/claude-code` | [claude.ai/claude-code](https://claude.ai/claude-code) |
+| **Codex** | `npm install -g @openai/codex` | [github.com/openai/codex](https://github.com/openai/codex) |
+| **Gemini CLI** | `npm install -g @google/gemini-cli` | [github.com/google-gemini/gemini-cli](https://github.com/google-gemini/gemini-cli) |
+| **Aider** | `pip install aider-chat` | [aider.chat](https://aider.chat) |
+
+Each agent also requires its own API key (e.g., `ANTHROPIC_API_KEY` for Claude Code, `OPENAI_API_KEY` for Codex, `GOOGLE_GENERATIVE_AI_API_KEY` for Gemini). Set these in your environment or runtime settings.
 
-This plugin is part of the Milady monorepo. It requires the following peer dependencies:
+The plugin auto-detects which agents are available at spawn time and will report if a requested agent isn't installed.
+
+## Installation
 
 ```bash
-pnpm add pty-manager git-workspace-service
+npm install @elizaos/plugin-agent-orchestrator
 ```
 
+The following peer dependencies will be installed automatically:
+
+- `pty-manager` — PTY session management
+- `git-workspace-service` — git workspace provisioning
+- `coding-agent-adapters` — CLI agent adapter layer
+
 ## Usage
 
 ### Register the Plugin
@@ -24,7 +45,7 @@ pnpm add pty-manager git-workspace-service
 ```typescript
 import { codingAgentPlugin } from "@elizaos/plugin-agent-orchestrator";
 
-// Add to your ElizaOS agent configuration
+// Add to your Milady or ElizaOS agent configuration
 const agent = {
   plugins: [codingAgentPlugin],
   // ... other config
@@ -161,8 +182,10 @@ runtime.setSetting("CODING_WORKSPACE_CONFIG", {
 
 ## Dependencies
 
-- `pty-manager` - PTY session management with adapter pattern
-- `git-workspace-service` - Git workspace provisioning and PR creation
+- `pty-manager` - PTY session management with stall detection and auto-response
+- `coding-agent-adapters` - Adapter layer for Claude Code, Codex, Gemini CLI, Aider CLIs
+- `git-workspace-service` - Git workspace provisioning, credential management, and PR creation
+- `pty-console` - Terminal bridge for xterm.js frontend integration
 
 ## License