Skip to content

docs: Add egg-orch CLI documentation [doc-updater] #651

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jwbron merged 2 commits into from
Feb 14, 2026
Merged

docs: Add egg-orch CLI documentation [doc-updater] #651

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e7d5559
docs: Add egg-orch CLI documentation [doc-updater]
jwbron Feb 14, 2026
55d046a
Fix STRUCTURE.md egg-orch comment to match symlink convention
egg-reviewer[bot] Feb 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -233,6 +233,23 @@ For watching a specific pipeline's progress with DAG visualization:
| `bin/egg-pipeline-watch <pipeline-id> --once` | Show current state and exit (no streaming) |
| `bin/egg-pipeline-watch <pipeline-id> --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 <command> --help` for detailed usage.

### Flags

| Flag | Description |
Expand Down
3 changes: 3 additions & 0 deletions docs/architecture/orchestrator.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 3 additions & 1 deletion docs/development/STRUCTURE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down