From e7d5559a08758e2c3db8a0b4a70faf183dfae3cd Mon Sep 17 00:00:00 2001 From: jwbron <8340608+jwbron@users.noreply.github.com> Date: Sat, 14 Feb 2026 00:06:41 +0000 Subject: [PATCH 1/2] docs: Add egg-orch CLI documentation [doc-updater] Update documentation to reflect the addition of the egg-orch CLI tool from commit a811096 (Add egg-orch CLI for orchestrator API #636). Changes: - README.md: Added egg-orch CLI section with command group overview - STRUCTURE.md: Documented new bin/egg-orch and egg_lib/orch_cli.py files - orchestrator.md: Added CLI Access section referencing egg-orch The egg-orch CLI provides programmatic access to orchestrator APIs (pipelines, signals, phases, decisions, containers) for both agents and humans. Triggered by: https://github.com/jwbron/egg/pull/636 Authored-by: egg --- README.md | 17 +++++++++++++++++ docs/architecture/orchestrator.md | 3 +++ docs/development/STRUCTURE.md | 4 +++- 3 files changed, 23 insertions(+), 1 deletion(-) 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..7ddc077499 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 # Orchestrator API CLI │ └── 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 From 55d046a29ac53b1b6993f7aa1e9fec27821c16b3 Mon Sep 17 00:00:00 2001 From: "egg-reviewer[bot]" <261018737+egg-reviewer[bot]@users.noreply.github.com> Date: Sat, 14 Feb 2026 00:11:18 +0000 Subject: [PATCH 2/2] Fix STRUCTURE.md egg-orch comment to match symlink convention --- docs/development/STRUCTURE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/development/STRUCTURE.md b/docs/development/STRUCTURE.md index 7ddc077499..eebbd4ead9 100644 --- a/docs/development/STRUCTURE.md +++ b/docs/development/STRUCTURE.md @@ -129,7 +129,7 @@ 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 # Orchestrator API CLI +│ ├── egg-orch # Symlink to orch_cli.py │ └── git-credential-github-token ├── egg_lib/ # Container utility libraries │ ├── contract_cli.py # SDLC contract CLI implementation