> ## Documentation Index
> Fetch the complete documentation index at: https://hyperframes-release-v0-8-87.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# CLI guide

> 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)


## Related topics

- [CLI](/packages/cli.md)
- [How HyperFrames fits into an application](/developers/overview.md)
- [Prompt Guide](/prompting/overview.md)