mirror of
https://github.com/heygen-com/hyperframes.git
synced 2026-10-30 09:16:55 +00:00
James RussoandClaude Opus 5.5
f180ffca64
* fix(cli): reap only orphaned browsers HyperFrames launched Orphan cleanup on preview and render killed every PPID-1 process of the current user whose args named chrome-headless-shell or a Puppeteer temp profile, which included detached browsers started by other tools. Every HyperFrames Chrome launch now passes an inert --hyperframes-owned-browser switch, and the reaper only kills PPID-1 processes that carry it as a whole argument. Fixes #6203 Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> * fix(core): serve the browser marker from its own subpath The GCP image's BeginFrame contract step imports the engine's browserManager straight from source before core's generated runtime exists, so pulling the marker from the core root entry broke it. A dependency-free @hyperframes/core/browser-marker subpath keeps that import chain as light as it was. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> * test(cli): expect the browser marker in the capture fallback launches Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> * docs(cli): say orphan cleanup runs before preview and render The cleanup only stops browsers HyperFrames launched, so the opt-out is no longer needed to protect other tools' browsers. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
74 lines
3.1 KiB
Plaintext
74 lines
3.1 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.
|
||
|
||
Before preview and render, HyperFrames stops headless Chrome processes left
|
||
behind by crashed HyperFrames sessions. It only stops browsers that HyperFrames
|
||
launched, so detached browsers from other tools keep running. To skip this
|
||
cleanup, set `HYPERFRAMES_NO_ORPHAN_CLEANUP=1` in the calling environment:
|
||
|
||
```bash
|
||
HYPERFRAMES_NO_ORPHAN_CLEANUP=1 npx hyperframes preview ./my-video
|
||
```
|
||
|
||
Cleanup remains enabled by default. Disabling it leaves browsers from crashed
|
||
HyperFrames sessions running until you stop them yourself.
|
||
|
||
<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)
|