diff --git a/README.md b/README.md index 689f6fdbcf..a649aee5e7 100644 --- a/README.md +++ b/README.md @@ -233,6 +233,23 @@ For watching a specific pipeline's progress with DAG visualization: | `bin/egg-pipeline-watch --once` | Show current state and exit (no streaming) | | `bin/egg-pipeline-watch --ascii` | Use ASCII-only characters (no Unicode) | +### egg-orch CLI + +For programmatic interaction with the orchestrator API (usable by both agents and humans): + +| Command Group | Description | +|---------------|-------------| +| `egg-orch health` | Check orchestrator + gateway health | +| `egg-orch pipeline list/get/create/status/delete` | Pipeline management | +| `egg-orch signal complete/progress/error/heartbeat` | Send agent signals | +| `egg-orch phase get/advance/start/complete` | Phase transitions | +| `egg-orch decision list/create/resolve/status` | HITL decision queue | +| `egg-orch container list/spawn/get/stop/logs` | Container operations | +| `egg-orch gateway health/phase/permissions` | Gateway operations | +| `egg-orch env` | Show orchestrator environment variables | + +All commands support `--json` for machine-readable output. Run `egg-orch --help` for detailed usage. + ### Flags | Flag | Description | diff --git a/docs/architecture/orchestrator.md b/docs/architecture/orchestrator.md index efa69ed1f7..33ac349c5d 100644 --- a/docs/architecture/orchestrator.md +++ b/docs/architecture/orchestrator.md @@ -210,6 +210,9 @@ Fixed IPs: - `POST /pipelines/{id}/signal` - Sandbox signals (complete, progress, error) - `GET /pipelines/{id}/decisions` - HITL decision queue +**CLI Access:** +The `egg-orch` CLI (`sandbox/bin/egg-orch`) provides command-line access to all orchestrator API endpoints. Available in sandbox containers for agent use, or can be run from the host with appropriate environment variables. See the [README CLI Reference](../../README.md#egg-orch-cli) for command details. + ### Signal Flow 1. **Orchestrator → Sandbox**: Container spawn with env vars diff --git a/docs/development/STRUCTURE.md b/docs/development/STRUCTURE.md index bcdebaba4f..eebbd4ead9 100644 --- a/docs/development/STRUCTURE.md +++ b/docs/development/STRUCTURE.md @@ -129,10 +129,12 @@ sandbox/ │ ├── egg-contract # Symlink to contract_cli.py │ ├── egg-checkpoint # Symlink to checkpoint_cli.py │ ├── egg-pipeline-watch # Real-time pipeline progress viewer via SSE +│ ├── egg-orch # Symlink to orch_cli.py │ └── git-credential-github-token ├── egg_lib/ # Container utility libraries │ ├── contract_cli.py # SDLC contract CLI implementation -│ └── checkpoint_cli.py # Checkpoint browsing CLI wrapper +│ ├── checkpoint_cli.py # Checkpoint browsing CLI wrapper +│ └── orch_cli.py # Orchestrator API CLI implementation ├── llm/ # Claude Code / Agent SDK integration ├── tools/ # Interactive tools │ ├── discover-tests.py # Test framework discovery