> ## Documentation Index
> Fetch the complete documentation index at: https://hyperframes.heygen.com/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`                     |

## 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`    |
| Compare outputs           | `npx hyperframes compare`      |

## Rendering and automation

The CLI also supports:

* batch and variable-driven output;
* image sequences and several video formats;
* managed cloud rendering;
* AWS Lambda and Google Cloud Run workflows;
* machine-readable JSON output;
* publishing and shared spaces.

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

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