Skip to content

docs(cli): apply review notes from #5442 to open, timeline and history - #6110

Open
meghna810 wants to merge 1 commit into
heygen-com:mainfrom
meghna810:docs/cli-reference-followup
Open

meghna810 wants to merge 1 commit into
heygen-com:mainfrom
meghna810:docs/cli-reference-followup

Conversation

@meghna810

Copy link
Copy Markdown
Contributor

What

Applies the three optional notes @jrusso1020 left on #5442 to the CLI reference (docs/packages/cli.mdx). #5442 auto-merged before I got to them.

Why

Each note corrects something the page states:

  1. open: the desktop hand-off is macOS-only for now (HANDOFF_READY = process.platform === "darwin" in packages/cli/src/utils/desktopApp.ts), so on Windows and Linux open always exits 1 with the download link. The page didn't say so.
  2. timeline apply --plan: in text mode it prints only a count (planned 1 file, a2Commands.ts); the result and diff come with --json. The flag table said every --plan prints the result and the diff, which is true of the single verbs only.
  3. history undo --who: it undoes what is still in effect from that name's last turn, and refuses (rather than falling back to an older turn) when nothing from that turn is still in effect (turnTargets in history.ts). The table said "that name's newest turn still in effect", which reads like the fallback.

Related work

Follow-up to #5442 (review comments) · Refs #5386

How

Three wording changes in docs/packages/cli.mdx: one sentence after the open --json paragraph, and one cell each in the timeline flag table and the history command table. No other files.

Test plan

  • Checked each statement against current main and ran them with the CLI built from main on a fresh hyperframes init project:
    • timeline apply plan.json --plan prints planned 1 file; --plan --json returns before, after and diff, and nothing is written.
    • history undo --who claude with no entries from that name refuses with claude has no entry still in effect.
    • open --json without the app installed exits 1 with reason: "not-installed" and the downloadUrl (macOS). The Windows/Linux behaviour is from the HANDOFF_READY check; I don't have those machines to run it on.
  • node scripts/check-docs-cli-commands.mjs, bun run check:docs-snippet-motion and check:studio-copy-dashes pass.
  • npx mint broken-links --check-redirects passes (in docs/, Node 22). mint validate hung locally at "validating build…" without reporting an error, so I'm relying on the docs workflow for it.
  • Documentation updated

🤖 Generated with Claude Code

…and history

Note that the desktop hand-off in `open` is macOS-only for now, that
`timeline apply --plan` prints only a count without --json, and what
`history undo --who` reverts.

Refs heygen-com#5386

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
@mintlify

mintlify Bot commented Oct 23, 2026

Copy link
Copy Markdown

Preview approval required

This pull request comes from a fork, so Mintlify won't build a preview until someone with write access approves commit 6bd3854.

Approve preview

@meghna810
meghna810 marked this pull request as draft October 23, 2026 03:33

@jrusso1020 jrusso1020 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Checked all three wording changes against main, and each one matches the code:

  1. open: HANDOFF_READY = process.platform === "darwin" (packages/cli/src/utils/desktopApp.ts:29) is the default ready for both hand-off paths, so off macOS it always falls through to the exit-1 download link.
  2. timeline apply --plan: the text-mode summary is just planned N file(s) (a2Commands.ts:264). The result and diff come with --json.
  3. history undo --who: turnTargets (history.ts:247-262) takes the last turn's entries that are still in effect and throws "…last turn has no change still in effect; undo an older entry by its id" rather than falling back. The new "(its newest entry if it never used begin)" matches the doc comment at :244-245.

Docs-only, one file, no other changes. LGTM.

— Rames

@meghna810
meghna810 marked this pull request as ready for review October 23, 2026 05:07

This branch has not been deployed

No deployments
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.

2 participants