Skip to content

Update design docs for the CLI events hub and CLI-run sync - #4974

Merged
youknowriad merged 3 commits into
trunkfrom
fix-outdated-cli-event-docs
Oct 1, 2026
Merged

youknowriad merged 3 commits into
trunkfrom
fix-outdated-cli-event-docs

Conversation

@youknowriad

@youknowriad youknowriad commented Oct 1, 2026 •

Copy link
Copy Markdown
Contributor

Related issues

How AI was used in this PR

Claude Code (Opus 5.5) found the statements #4954–#4956 made outdated and rewrote them. It checked each new claim against the code (event channels, listeners, socket path) and dropped one sentence that overstated things. I reviewed the diff.

Proposed Changes

Docs only. These design docs described how Studio and the CLI communicate as it was before the events hub and CLI-run sync landed, so they would send a reader (or an agent) in the wrong direction:

  • cli.md:
    • The data-flow section described _events as one listener relaying only snapshot-event to Redux. It now covers every event type, each app's own event socket, how the desktop and studio ui relay events, and how the agentic UI renders them, whoever started the sync.
    • It now says that push, pull and preview report progress through sync activity events rather than logger messages.
    • "Studio calling the CLI" no longer says Studio only forks the CLI for preview sites.
  • studio-apps-and-surfaces.md:
    • Fixes the tools/common path (now packages/common) and the local server's SSE channel list.
    • Adds how CLI state changes reach both surfaces.
  • analytics-tracks.md:
    • Sync now has two implementations (Classic and the CLI). The agentic UI runs CLI push/pull with --suppress-tracks-event, and the old note that "an agentic-UI push runs the CLI export command, not CLI push" is gone.
    • The push event row now matches pull ("standalone only").

The new design doc and the AGENTS.md links proposed in #4963 (phase 0) are left for a separate PR.

Testing Instructions

  • Read the three diffs. Each changed statement can be checked against apps/cli/commands/_events.ts, apps/cli/lib/event-hub.ts, apps/local/src/index.ts, apps/studio/src/modules/cli/lib/cli-events-subscriber.ts and packages/common/sites/sync.ts.

Pre-merge Checklist

  • Have you checked for TypeScript, React or other console errors?

🤖 Generated with Claude Code

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
youknowriad and others added 2 commits October 1, 2026 09:04
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@youknowriad
youknowriad merged commit 6f6519f into trunk Oct 1, 2026
12 checks passed
@youknowriad
youknowriad deleted the fix-outdated-cli-event-docs branch October 1, 2026 08:54
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.

1 participant