Skip to content

docs: add --since to message wait/wait-loop in CLI reference [doc-updater] - #1936

Merged
jwbron merged 1 commit into
mainfrom
egg/doc-update-wait-loop-since-flag
Apr 23, 2026
Merged

docs: add --since to message wait/wait-loop in CLI reference [doc-updater]#1936
jwbron merged 1 commit into
mainfrom
egg/doc-update-wait-loop-since-flag

Conversation

@james-in-a-box

Copy link
Copy Markdown
Contributor

Update orchestrator-cli.md to reflect the stream-tip default and
--since option introduced by #1933 (fix #1925).

#1933 added a "New events only" section to agent-wait-patterns.md
documenting that cursor-less wait/wait-loop calls now start at
the stream tip. That doc's zero-drop pattern explicitly uses
--since <id> with wait-loop, but the command table in
orchestrator-cli.md did not list --since for either message wait
or message wait-loop.

Changes:

  • Added [--since <id>] to the message wait and message wait-loop
    command signatures in the reference table
  • Noted the new-events-only default (stream-tip cursor) in both
    one-line descriptions so agents reading the CLI reference understand
    the behavior change without having to follow the link

Triggered by: #1933

Test Plan

  • Automated: no code changes; doc-only
  • Manual: verify table renders correctly in GitHub

Authored-by: egg

…ater]

Update orchestrator-cli.md command table to show [--since <id>] for
message wait and message wait-loop, and note the new-events-only
default (stream-tip cursor) introduced by #1925.

The agent-wait-patterns.md zero-drop pattern added in #1933 explicitly
uses --since with wait-loop, but the CLI reference table did not show
that flag for these commands.

Triggered by: #1933

Authored-by: egg

@egg-reviewer egg-reviewer Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Doc-only change, two lines in a single file. Verified against the implementation:

  • --since flag exists in both CLI parsers (sandbox/bin/egg-orch lines 2223, 2256) and flows through the handler (sandbox/egg_agent_tools/handlers/message.py) to the server endpoint.
  • Stream-tip default is accurate: orchestrator/routes/messages.py sets from_tip=since_id is None, so cursor-less calls skip already-seen events — matches the new description.
  • "zero-drop send→wait semantics" correctly describes the --since escape hatch documented in agent-wait-patterns.md §3.
  • The section links (§1, §3) are unchanged and still point to the correct anchors.

The usage examples later in the same file (lines 121-134) don't show --since, which is fine — they predate the stream-tip change and remain valid since --since is optional.

No issues found. Accurate, minimal, well-scoped update.

— Authored by egg

@james-in-a-box

Copy link
Copy Markdown
Contributor Author

egg review completed. View run logs

@jwbron
jwbron merged commit c1f34fc into main Apr 23, 2026
22 checks passed
james-in-a-box Bot added a commit that referenced this pull request Apr 24, 2026
…ater] (#1936)

Update orchestrator-cli.md command table to show [--since <id>] for
message wait and message wait-loop, and note the new-events-only
default (stream-tip cursor) introduced by #1925.

The agent-wait-patterns.md zero-drop pattern added in #1933 explicitly
uses --since with wait-loop, but the CLI reference table did not show
that flag for these commands.

Triggered by: #1933

Authored-by: egg

Co-authored-by: jwbron <8340608+jwbron@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

egg-orch message wait-loop returns already-seen messages immediately instead of blocking for new events

1 participant