skills/heygen-com__hyperframes
1
0
Fork 0
mirror of https://github.com/heygen-com/hyperframes.git synced 2026-09-14 18:01:20 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
sync/hyperframes-codegen-62134ca4
heygen-com__hyperframes/docs/developers/cli.mdx
T

58 lines
2.1 KiB
Plaintext
Raw Permalink Normal View History

docs: add the Studio section, workflow guides, and section hubs Adds the pages the rebuilt navigation is organised around, and moves the sidebar onto that structure. Every entry points at a file that exists after this commit; nothing is rewritten or removed yet, and no redirect is claimed yet. - Studio (13 pages) — the editor had no section of its own - One guide per creation workflow, matching the shipped agent skills - Section hubs: Concepts, Catalog, Developers, Deploy, Workflows, Help, Go further, Product updates, 30 Days of HyperFrames Pages a later commit retires drop out of the sidebar here but still exist and still resolve, so the site stays navigable at this commit. Incidentally fixes a link to /concepts from the Lambda migration guide that is broken on main today — the destination did not exist.
2026-08-03 16:40:22 -07:00
---
title: "CLI guide"
description: "Find the HyperFrames command for creating, checking, rendering, publishing, and automating projects."
---
Use this page to choose a command. The [CLI reference](/packages/cli) contains
detailed flags, examples, and environment settings. The installed version
remains authoritative: run `npx hyperframes <command> --help`.
## Everyday project loop
| Task | Command |
| --- | --- |
| Create a project | `npx hyperframes init my-video` |
| Open Studio | `npx hyperframes preview` |
| Check HTML structure | `npx hyperframes lint` |
| Run browser, layout, motion, and contrast checks | `npx hyperframes check` |
| Capture review frames | `npx hyperframes snapshot --at 0,2,5` |
| Render a video | `npx hyperframes render --output output.mp4` |
| Publish a browser link | `npx hyperframes publish` |
| Diagnose the machine | `npx hyperframes doctor` |
## Work with media
| Task | Command |
| --- | --- |
| Inspect project metadata | `npx hyperframes info` |
| Transcribe speech | `npx hyperframes transcribe <file>` |
| Generate narration | `npx hyperframes tts <script>` |
| Capture a website | `npx hyperframes capture <url>` |
## Reuse and inspect
| Task | Command |
| --- | --- |
| Add a Catalog item | `npx hyperframes add <name>` |
| List compositions | `npx hyperframes compositions` |
| Inspect keyframe behavior | `npx hyperframes keyframes` |
docs: a compare example that works, and prose instead of a semicolon list `npx hyperframes compare` was shown with no arguments. The command needs two or more paths ("pass 2+ paths" in its own help), so a reader copying that line gets an error on their first try. It now shows two. The closing section was six bullets joined by semicolons — a sentence pretending to be a list. It is a sentence now. While writing that sentence I claimed every command can print JSON. It cannot: `snapshot` and bare `skills` have no --json, though `skills check` does. Changed to "most commands", which is true. Checked twelve commands against their own --help rather than against the page.
2026-08-04 14:12:21 -07:00
| Compare two or more versions | `npx hyperframes compare v1/ v2/` |
docs: add the Studio section, workflow guides, and section hubs Adds the pages the rebuilt navigation is organised around, and moves the sidebar onto that structure. Every entry points at a file that exists after this commit; nothing is rewritten or removed yet, and no redirect is claimed yet. - Studio (13 pages) — the editor had no section of its own - One guide per creation workflow, matching the shipped agent skills - Section hubs: Concepts, Catalog, Developers, Deploy, Workflows, Help, Go further, Product updates, 30 Days of HyperFrames Pages a later commit retires drop out of the sidebar here but still exist and still resolve, so the site stays navigable at this commit. Incidentally fixes a link to /concepts from the Lambda migration guide that is broken on main today — the destination did not exist.
2026-08-03 16:40:22 -07:00
## Rendering and automation
docs: a compare example that works, and prose instead of a semicolon list `npx hyperframes compare` was shown with no arguments. The command needs two or more paths ("pass 2+ paths" in its own help), so a reader copying that line gets an error on their first try. It now shows two. The closing section was six bullets joined by semicolons — a sentence pretending to be a list. It is a sentence now. While writing that sentence I claimed every command can print JSON. It cannot: `snapshot` and bare `skills` have no --json, though `skills check` does. Changed to "most commands", which is true. Checked twelve commands against their own --help rather than against the page.
2026-08-04 14:12:21 -07:00
The CLI also renders in batches and from variables, writes image sequences and
several video formats, and runs in the cloud — managed, on AWS Lambda, or on
Google Cloud Run. Most commands take `--json` when you need to read the result from a script.
docs: add the Studio section, workflow guides, and section hubs Adds the pages the rebuilt navigation is organised around, and moves the sidebar onto that structure. Every entry points at a file that exists after this commit; nothing is rewritten or removed yet, and no redirect is claimed yet. - Studio (13 pages) — the editor had no section of its own - One guide per creation workflow, matching the shipped agent skills - Section hubs: Concepts, Catalog, Developers, Deploy, Workflows, Help, Go further, Product updates, 30 Days of HyperFrames Pages a later commit retires drop out of the sidebar here but still exist and still resolve, so the site stays navigable at this commit. Incidentally fixes a link to /concepts from the Lambda migration guide that is broken on main today — the destination did not exist.
2026-08-03 16:40:22 -07:00
Start with the simple command, then open the [full reference](/packages/cli) for the exact options needed by automation or infrastructure.
<Tip>
Run `npx hyperframes <command> --help` for the installed version’s exact syntax.
</Tip>
## Related topics
- [Open the complete CLI reference](/packages/cli)
- [Choose a rendering path](/deploy/overview)
- [Diagnose a CLI or project problem](/guides/troubleshooting)
Reference in New Issue Copy Permalink