docs: Add egg-orch CLI documentation [doc-updater] - #651
Conversation
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: #636 Authored-by: egg
This comment has been minimized.
This comment has been minimized.
There was a problem hiding this comment.
Documentation-only PR. All three files checked against the actual implementation. Findings:
All documented commands verified against sandbox/egg_lib/orch_cli.py — every command group and subcommand listed in the README table exists in the implementation, and the --json claim is accurate (applied universally via _add_json_flag() helper).
One minor inconsistency:
STRUCTURE.md — inconsistent comment style for symlinks (docs/development/STRUCTURE.md):
egg-contract and egg-checkpoint are annotated as "Symlink to contract_cli.py" / "Symlink to checkpoint_cli.py", but the new egg-orch entry just says "Orchestrator API CLI". Since egg-orch is also a symlink (-> ../egg_lib/orch_cli.py), this should follow the same pattern:
│ ├── egg-orch # Symlink to orch_cli.py
This keeps the STRUCTURE.md internally consistent — the "what it does" description already lives on the egg_lib/orch_cli.py line below.
This is non-blocking. Everything else looks correct — the README table accurately reflects the CLI, the orchestrator.md cross-reference and anchor link are valid, and the egg_lib/ listing is properly structured.
— Authored by egg
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
|
Agreed. Updated the — Authored by egg |
This comment has been minimized.
This comment has been minimized.
There was a problem hiding this comment.
No agent-mode design concerns. The delta since last review is a single documentation consistency fix (STRUCTURE.md comment style) addressing the general review bot's feedback. No agent workflow, prompt, or output format changes involved.
— Authored by egg
This comment has been minimized.
This comment has been minimized.
There was a problem hiding this comment.
Re-review after commit 55d046a ("Fix STRUCTURE.md egg-orch comment to match symlink convention").
Previous feedback addressed: The egg-orch entry in STRUCTURE.md now follows the symlink annotation convention (# Symlink to orch_cli.py) consistent with egg-contract and egg-checkpoint. Verified correct.
Delta review: The only change since e7d5559 is this single-line comment fix in docs/development/STRUCTURE.md. No new issues.
Verification against implementation:
sandbox/bin/egg-orchconfirmed as symlink to../egg_lib/orch_cli.py- All command groups in README table (
health,pipeline,signal,phase,decision,container,gateway,env) verified againstorch_cli.pycommand parsers and handler functions --jsonflag confirmed applied universally via_add_json_flag()helper- Cross-reference anchor
README.md#egg-orch-cliresolves correctly to the### egg-orch CLIheading orchestrator.mdCLI Access section accurately describes the tool and its location
No issues found.
— Authored by egg
|
egg review completed. View run logs 5 previous review(s) hidden. |
Update documentation to reflect the addition of the egg-orch CLI tool introduced in #636.
Changes
README.md:
--jsonoutput and include helpdocs/development/STRUCTURE.md:
bin/egg-orchto the sandbox bin directory listingegg_lib/orch_cli.pyto the container utility libraries sectiondocs/architecture/orchestrator.md:
Context
The
egg-orchCLI provides programmatic command-line access to the orchestrator API for:This tool is available in sandbox containers for agent use and can also be run from the host with appropriate environment variables.
Triggered By
Merged PR: #636
Commit: a811096 "Add egg-orch CLI for orchestrator API"
Authored-by: egg