mirror of
https://github.com/heygen-com/hyperframes.git
synced 2026-10-30 17:27:09 +00:00
Miguel Ángel
0a5c235173
* feat(cli): hyperframes timeline prints a project's tracks and clips * docs(cli): list the timeline command * feat(cli): timeline command reports unreadable lanes; add skill docs * fix(cli): timeline stays inside the project, shares one start cache, keeps small volumes * fix(cli): timeline resolves symlinks before the project containment check * fix(cli): timeline accepts project folders whose name starts with two dots * refactor(cli): timeline and compositions share the engine's start resolver * docs(skills): point agents at the timeline command where they decide how to read a project * fix(cli): timeline prints absolute main-timeline times and the owning file for nested clips Nested rows carry absStart/absEnd on the main timeline and their owning file, alongside existing local start/end. Text prints absolute time first, local time in parentheses. Adds jq/node one-liners for common queries, tested against a fixture. * fix(cli): timeline places nested media at the runtime start and tests its query one-liners A nested media clip with a negative literal data-start was reported later than it plays, because the raw start was clamped before the host offset was added. The skill's jq and node one-liners now run against the fixture in the test suite. * fix(cli): timeline clamps a negative media start to 0 when its host starts at 0 The runtime skips the host-offset formula for a host at t=0 and clamps the start, so the timeline command now does the same. * refactor(core): one media-start rule shared by the runtime and the timeline command The runtime and the CLI each carried a copy of the rule for when a nested media clip's start takes the host offset, and the copies had drifted. Both now call resolveMediaStartSeconds. * test(cli): timeline fixture for a media start written as an expression parseNumeric and the runtime's parseStrictFiniteTimingNumber are the same function, so the two callers cannot disagree on what counts as a literal; this pins the expression case.
59 lines
2.2 KiB
Plaintext
59 lines
2.2 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` |
|
||
|
||
## 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/` |
|
||
|
||
## 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)
|