From 6bd38543b60ad4a46889f910d1e8c6d2c4a041c1 Mon Sep 17 00:00:00 2001 From: meghna810 Date: Thu, 22 Oct 2026 20:29:41 -0700 Subject: [PATCH] docs(cli): apply review notes from #5442 to open, timeline 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 #5386 Co-authored-by: Claude Opus 5.5 --- docs/packages/cli.mdx | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/packages/cli.mdx b/docs/packages/cli.mdx index f8621df07e..1b18c8a7e0 100644 --- a/docs/packages/cli.mdx +++ b/docs/packages/cli.mdx @@ -945,7 +945,8 @@ npx hyperframes open --json # for agents When it runs under Claude Code, Codex, or Grok, the app's chat picks up that conversation. When it cannot open the app, for example because the app is not installed, `open` exits 1 and prints a download link. With `--json`, the result -names the `reason` and the `downloadUrl`. +names the `reason` and the `downloadUrl`. The hand-off works on macOS only for +now: on Windows and Linux, `open` always exits 1 with the download link. `catch-up` is the other half of that hand-off. Run it when the person is back from the desktop app, before you change anything: it lists what they asked and @@ -1345,7 +1346,7 @@ use is refused before anything is written. | Flag | Applies to | Description | | ------------- | -------------------------------------------------------------- | ------------------------------------------------------------- | -| `--plan` | `move`, `trim`, `split`, `delete`, `set`, `duplicate`, `apply` | Print the result and the diff without writing | +| `--plan` | `move`, `trim`, `split`, `delete`, `set`, `duplicate`, `apply` | Print the result and the diff without writing. `apply --plan` prints only a count (`planned 1 file`); add `--json` for the result and diff. | | `--overwrite` | `move`, `trim` | Allow the clip to overlap a neighbour on its track | | `--snap` | `move`, `trim`, `split`, `delete`, `duplicate` | Round times to whole frames. Needs `data-fps` on the project. | | `--at` | `duplicate` | Where the copy starts | @@ -1379,7 +1380,7 @@ npx hyperframes history undo --who claude # undo your newest turn | Command | What it does | | ----------------------- | ------------------------------------------------------------------------------------------------------ | | `show [--diff]` | One entry's files, before and after. `--diff` prints a text diff (needs `git`). | -| `undo [ref]` | Undo an entry, or with `--who ` and no ref, that name's newest turn still in effect | +| `undo [ref]` | Undo an entry, or with `--who ` and no ref, whatever is still in effect from that name's last turn (its newest entry if it never used `begin`). If nothing from that turn is still in effect, it refuses rather than undoing an older turn. | | `restore [--who]` | Make the files what they were right after an entry, a time, or `start` | | `peek [path]` | List the files at an entry, a time, or `start` without changing anything; with a path, print that file | | `pin [--off]` | Keep an entry, and what it needs, when old history is trimmed. `--off` unpins it. |