mirror of
https://github.com/heygen-com/hyperframes.git
synced 2026-10-30 09:16:55 +00:00
Miguel Ángel
663b02297d
* feat(cli): add hyperframes clean to find and remove what HyperFrames left on disk `hyperframes clean` lists leftover render work dirs, debug renders, the history of projects that no longer exist, idle video proxies and extracted video frames, with sizes, and removes them. `--dry-run` removes nothing, `--json` is for agents, `--snapshots` also removes snapshot folders (otherwise listed as reclaimable). It never touches outputs, sources or anything a running render or preview still owns. * docs(cli): say that clean does not search a project's subfolders * fix(cli): clean test compares folder names on Windows and the skills manifest is regenerated * fix(studio-server): the proxy cache sweep removes only files the transcoder named It removed any idle .mp4 or .webm in .transcode-cache, so a user file placed there, or reached through a symlinked cache folder, could go. Proxies are always <sha256>.<ext> and their temp files .tmp-<uuid>-<proxy name>; nothing else is swept. * style(producer): keep a renderDirOwner doc comment within 120 columns
62 lines
2.6 KiB
Plaintext
62 lines
2.6 KiB
Plaintext
---
|
||
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` |
|
||
| Free disk space HyperFrames used | `npx hyperframes clean` |
|
||
|
||
## 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` |
|
||
| Print tracks and clips | `npx hyperframes timeline` (`--json` for agents) |
|
||
| Inspect keyframe behavior | `npx hyperframes keyframes` |
|
||
| Compare two or more versions | `npx hyperframes compare v1/ v2/` |
|
||
|
||
`hyperframes timeline` also accepts agent editing verbs. Use `move`, `trim`, `split`, or `delete` with a row ref; add `--plan` to inspect the before/after rows and diff without writing, or `--json` for a machine-readable receipt. Time values accept seconds, relative offsets, frames, and anchors such as `after:#intro`.
|
||
|
||
## Rendering and automation
|
||
|
||
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.
|
||
|
||
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)
|