From df4249aa05b7332bd7e8f79d460491fb69bb4f41 Mon Sep 17 00:00:00 2001 From: Miguel Angel Simon Sierra Date: Sun, 5 Jul 2026 22:42:15 -0400 Subject: [PATCH 1/2] 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/guides/claude-design-hyperframes.md | 8 ++++++-- packages/cli/README.md | 7 +++++-- 2 files changed, 11 insertions(+), 4 deletions(-) diff --git a/docs/guides/claude-design-hyperframes.md b/docs/guides/claude-design-hyperframes.md index 86f5bb0f69..20a112affe 100644 --- a/docs/guides/claude-design-hyperframes.md +++ b/docs/guides/claude-design-hyperframes.md @@ -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. diff --git a/packages/cli/README.md b/packages/cli/README.md index 882f26b754..fffe6cc26e 100644 --- a/packages/cli/README.md +++ b/packages/cli/README.md @@ -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` From 9c991abc2c1dd45cc4d7df139479ddf387d83a82 Mon Sep 17 00:00:00 2001 From: Miguel Angel Simon Sierra Date: Wed, 8 Jul 2026 15:14:47 -0400 Subject: [PATCH 2/2] docs: fix render index.html example in the Open Design guide too (R1) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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. --- docs/guides/open-design-hyperframes.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/guides/open-design-hyperframes.md b/docs/guides/open-design-hyperframes.md index a3899a6fb7..b56bc07a15 100644 --- a/docs/guides/open-design-hyperframes.md +++ b/docs/guides/open-design-hyperframes.md @@ -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