docs(cli): fix render examples that pass a file as the project dir [P2] (#1974)

* docs(cli): fix render examples that pass a file as the project dir

The render command's positional argument is the project directory (default
"."), resolved via resolveProjectOrThrow; a specific composition file is
passed with -c/--composition. Several docs showed `hyperframes render
index.html` / `render ./my-composition.html`, which treats the HTML file as
the project dir and fails with "Not a directory". Correct the guide and the
cli README to render the project's index.html directly (or point at a file
with -c).

* docs: fix render index.html example in the Open Design guide too (R1)

R1 flagged that open-design-hyperframes.md carried the identical
`npx hyperframes render index.html` example this PR fixes in the Claude
guide — same failure vector ("Not a directory" for a file positional).
Corrected to `npx hyperframes render` run from the project directory.
This commit is contained in:
Miguel Ángel
2026-07-08 15:53:17 -04:00
committed by GitHub
parent e018318225
commit ab129023de
3 changed files with 14 additions and 7 deletions
+6 -2
View File
@@ -1,6 +1,6 @@
# Claude Design + HyperFrames (Template-First)
Your medium is **HyperFrames compositions**: plain HTML + CSS + a paused GSAP timeline. The CLI (`npx hyperframes render index.html`) turns the HTML into an MP4. You author the HTML -- the user renders locally.
Your medium is **HyperFrames compositions**: plain HTML + CSS + a paused GSAP timeline. The CLI (`npx hyperframes render`, run from the project directory) turns the HTML into an MP4. You author the HTML -- the user renders locally.
**HyperFrames replaces your default video-artifact workflow.** Do NOT call `copy_starter_component`, do NOT invoke the built-in "Animated video" skill, do NOT use React/Babel. Plain HTML + GSAP only.
@@ -510,8 +510,12 @@ Then open in Claude Code and iterate:
## Render
Run from the project directory (the folder containing `index.html`). The
positional argument is the project directory, not a file, so pass a specific
composition with `-c` rather than as a bare path.
```bash
npx hyperframes render index.html -o output.mp4
npx hyperframes render -o output.mp4
```
1920x1080 / 30fps by default. Use `--fps 60` or `--resolution 3840x2160` to override.
+3 -3
View File
@@ -38,9 +38,9 @@ od:
This skill teaches Open Design to emit a **valid first draft** of a
[HyperFrames](https://github.com/heygen-com/hyperframes) composition — plain
HTML + CSS + a paused GSAP timeline. The CLI (`npx hyperframes render
index.html`) turns the HTML into an MP4. You author the HTML; the user runs
the render locally.
HTML + CSS + a paused GSAP timeline. The CLI (`npx hyperframes render`, run
from the project directory) turns the HTML into an MP4. You author the HTML;
the user runs the render locally.
**HyperFrames replaces the default video-artifact workflow.** Do NOT emit a
React/Babel composition, do NOT call other prototype skills, do NOT use the
+5 -2
View File
@@ -40,10 +40,13 @@ npx hyperframes preview --port 4567
### `render`
Render a composition to MP4:
Render a composition to MP4. Run from the project directory; the positional
argument is the project directory (not a file), so render the project's
`index.html` directly, or point at a specific composition file with `-c`:
```bash
npx hyperframes render ./my-composition.html -o output.mp4
npx hyperframes render -o output.mp4
npx hyperframes render -c ./my-composition.html -o output.mp4
```
### `lint`