### Start a Lambda Render with Variables

Source: https://hyperframes.heygen.com/packages/cli

Starts a Step Functions execution for rendering a template, providing dynamic variables for personalization. This example uses inline JSON for variables.

```bash
hyperframes lambda render ./my-template --site-id=abc1234deadbeef0 \
  --width=1920 --height=1080 \
  --variables '{"title":"Hello Alice","accent":"#ff0000"}'
```

--------------------------------

### Start Live Preview Server

Source: https://hyperframes.heygen.com/packages/cli

The preview command starts a live preview server with hot reload for your composition. You can specify a directory and a port for the server.

```bash
npx hyperframes preview [dir]
```

```bash
npx hyperframes preview --port 4567
```

--------------------------------

### Start a Lambda Render with Wait

Source: https://hyperframes.heygen.com/packages/cli

Starts a Step Functions execution for rendering a project. Use `--wait` to block until the render finishes and stream progress. This example sets specific dimensions, frame rate, and format.

```bash
hyperframes lambda render ./my-project \
  --width=1920 --height=1080 --fps=30 --format=mp4 \
  --chunk-size=240 --max-parallel-chunks=16 \
  --wait
```

--------------------------------

### Install Hyperframes CLI

Source: https://hyperframes.heygen.com/packages/cli

Install the Hyperframes CLI globally using npm or use it directly with npx. This is the first step to using the command-line interface.

```bash
npm install -g hyperframes
# or use directly with npx
npx hyperframes <command>
```

--------------------------------

### Initialize a New Hyperframes Project

Source: https://hyperframes.heygen.com/packages/cli

Scaffold a new composition from an example. You can specify the project name as an argument or be prompted.

```bash
npx hyperframes init --example warm-grain
```

```bash
npx hyperframes init my-video --example warm-grain
```

--------------------------------

### Preview Hyperframes Project in Browser

Source: https://hyperframes.heygen.com/packages/cli

Start the development server for live hot reloading. Navigate to the project directory first.

```bash
cd my-video
npx hyperframes preview
```

--------------------------------

### Browse Registry with Hyperframes CLI

Source: https://hyperframes.heygen.com/packages/cli

Browse the registry to list available blocks and components. You can filter by type or tag, get machine-readable JSON output, or use an interactive picker to select and install items.

```bash
npx hyperframes catalog
```

```bash
npx hyperframes catalog --type block
```

```bash
npx hyperframes catalog --type block --tag social
```

```bash
npx hyperframes catalog --json
```

```bash
npx hyperframes catalog --human-friendly
```

--------------------------------

### Start a Lambda Render with Variables File and Strictness

Source: https://hyperframes.heygen.com/packages/cli

Starts a Step Functions execution for rendering a template, using a JSON file for variables and enabling strict variable validation. This ensures all declared variables are provided.

```bash
hyperframes lambda render ./my-template --site-id=abc1234deadbeef0 \
  --width=1920 --height=1080 \
  --variables-file ./alice.json --strict-variables
```

--------------------------------

### Initialize New Composition Project

Source: https://hyperframes.heygen.com/packages/cli

Use the `init` command to create a new composition project. In agent mode, `--example` is required. You can also include Tailwind CSS support.

```bash
npx hyperframes init my-video --example blank --video video.mp4
```

```bash
npx hyperframes init my-video --example blank --tailwind
```

```bash
npx hyperframes init my-video
```

--------------------------------

### Start a Render on Cloud Run

Source: https://hyperframes.heygen.com/packages/cli

Starts a distributed render job on Google Cloud Run. Requires project directory and output dimensions. Supports various rendering options like frame rate, format, and quality.

```bash
hyperframes cloudrun render ./my-project --width 1920 --height 1080 --wait
```

--------------------------------

### Batch File Format Example

Source: https://hyperframes.heygen.com/packages/cli

Example of the JSON Lines (JSONL) format required for the batch render input file. Each line is a JSON object specifying output key, variables, and optionally an execution name.

```jsonl
{"outputKey": "renders/alice.mp4", "variables": {"name": "Alice", "accent": "#ff0000"}}
{"outputKey": "renders/bob.mp4",   "variables": {"name": "Bob",   "accent": "#0000ff"}}
{"outputKey": "renders/carol.mp4", "variables": {"name": "Carol"}, "executionName": "hf-carol-001"}
```

--------------------------------

### Install All Skills

Source: https://hyperframes.heygen.com/packages/cli

Installs HyperFrames skills to all default AI coding tool targets, including Claude Code, Gemini CLI, and Codex CLI.

```bash
npx hyperframes skills
```

--------------------------------

### Publish Project

Source: https://hyperframes.heygen.com/packages/cli

Upload your project and get a stable hyperframes.dev URL. The publish command zips the project, uploads it, and provides a URL for claiming and editing in the web app. You can skip the confirmation prompt with the --yes flag.

```bash
npx hyperframes publish [dir]
```

```bash
npx hyperframes publish --yes
```

--------------------------------

### Install Skills to Specific Tools

Source: https://hyperframes.heygen.com/packages/cli

Installs HyperFrames skills to specific AI coding tools. Multiple flags can be used to target several tools simultaneously.

```bash
npx hyperframes skills --claude
```

```bash
npx hyperframes skills --cursor
```

```bash
npx hyperframes skills --claude --gemini
```

--------------------------------

### CLI Commands for Human Mode

Source: https://hyperframes.heygen.com/packages/cli

Examples of using Hyperframes CLI commands in interactive human mode. This includes interactive project initialization and using the catalog with a human-friendly flag.

```bash
# Command-specific interactive flow
npx hyperframes init my-video

# Interactive picker supported by catalog
npx hyperframes catalog --human-friendly
```

--------------------------------

### Passive Update Notice Example

Source: https://hyperframes.heygen.com/packages/cli

Example of a passive update notice that appears on stderr when a newer version of the CLI is available.

```text
  Update available: 0.1.4 → 0.1.5
  Run: npx hyperframes@latest
```

--------------------------------

### Add a Block or Component using Hyperframes CLI

Source: https://hyperframes.heygen.com/packages/cli

Install a block (sub-composition scene) or a component (effect/snippet) from the registry into an existing project. You can target a different project directory or run headlessly for CI environments.

```bash
npx hyperframes add claude-code-window
```

```bash
npx hyperframes add shader-wipe
```

```bash
npx hyperframes add shader-wipe --dir ./my-video
```

```bash
npx hyperframes add shader-wipe --no-clipboard --json
```

--------------------------------

### Batch Render on Cloud Run

Source: https://hyperframes.heygen.com/packages/cli

Fans out multiple personalized renders from a JSONL batch file. Starts one execution per entry, capped by max concurrent executions. Supports dry runs to preview the manifest.

```bash
hyperframes cloudrun render-batch <projectDir> --batch users.jsonl
```

--------------------------------

### CLI Commands for Agent Mode

Source: https://hyperframes.heygen.com/packages/cli

Examples of using Hyperframes CLI commands in a fully non-interactive agent mode, where all inputs are provided via flags.

```bash
# Fully non-interactive — all inputs from flags
npx hyperframes init my-video --example blank --video video.mp4
npx hyperframes render --output output.mp4 --fps 30 --quality standard
npx hyperframes upgrade --check --json
```

--------------------------------

### Fetching Cloud Render Details

Source: https://hyperframes.heygen.com/packages/cli

Retrieve the full details for a specific render using `cloud get <render_id>`. This includes short-lived signed URLs for video and thumbnails.

```bash
hyperframes cloud get hfr_abc123
```

```bash
hyperframes cloud get hfr_abc123 --json
```

--------------------------------

### JSON Output with _meta Envelope

Source: https://hyperframes.heygen.com/packages/cli

Example of JSON output from a Hyperframes CLI command, including the '_meta' field which contains version information for agent use.

```json
{
  "name": "my-video",
  "duration": 10.5,
  "_meta": {
    "version": "0.1.4",
    "latestVersion": "0.1.5",
    "updateAvailable": true
  }
}
```

--------------------------------

### Bypass Git Clone Protection for Skill Installation

Source: https://hyperframes.heygen.com/packages/cli

Temporarily bypasses Git clone protection for installing skills when Git LFS post-checkout hooks are active. This is a workaround for Git 2.45+ refusing to run hooks during clones.

```bash
GIT_CLONE_PROTECTION_ACTIVE=0 npx skills add heygen-com/hyperframes
```

--------------------------------

### Parametrized Render Example

Source: https://hyperframes.heygen.com/packages/cli

This HTML structure defines a composition with variables for title and theme, which can be overridden at render time. It demonstrates how to access these variables in a script to dynamically update content.

```html
<html
  data-composition-id="root"
  data-composition-variables='[
    {"id":"title","label":"Title","type":"string","default":"Hello"},
    {"id":"theme","label":"Theme","type":"enum","options":[
      {"value":"light","label":"Light"},
      {"value":"dark","label":"Dark"}
    ],"default":"light"}
  ]'>
  <body>
    <h1 id="hero" class="clip" data-start="0" data-duration="3"></h1>
    <script>
      const vars = window.__hyperframes.getVariables();
      document.getElementById("hero").textContent = vars.title;
      document.body.dataset.theme = vars.theme;
    </script>
  </body>
</html>
```

--------------------------------

### Benchmark Render Settings

Source: https://hyperframes.heygen.com/packages/cli

Find optimal render settings for your system by running multiple configurations and comparing timing and file size.

```bash
npx hyperframes benchmark [dir]
```

--------------------------------

### Create a Cloud Run Site

Source: https://hyperframes.heygen.com/packages/cli

Tarballs and uploads a project to Google Cloud Storage for reuse across renders. Optionally overrides the content hash with a site ID. Prints the GCS URI.

```bash
hyperframes cloudrun sites create <projectDir>
```

--------------------------------

### List Compositions in Project using Hyperframes CLI

Source: https://hyperframes.heygen.com/packages/cli

List all compositions within the current project. The output includes the composition's ID, duration, resolution, and element count. Use the --json flag for machine-readable output.

```bash
npx hyperframes compositions
```

```bash
npx hyperframes compositions --json
```

--------------------------------

### Get Browser Path

Source: https://hyperframes.heygen.com/packages/cli

Outputs the path to the cached browser. This is useful for scripting purposes where the path needs to be programmatically accessed.

```bash
npx hyperframes browser path
```

--------------------------------

### Render Composition with Options

Source: https://hyperframes.heygen.com/packages/cli

Renders a composition to an MP4 file with specified options for frames per second and quality. Adjust these parameters to control the output video characteristics.

```bash
# With options
npx hyperframes render --output output.mp4 --fps 60 --quality high
```

--------------------------------

### Cloud Rendering Workflow

Source: https://hyperframes.heygen.com/packages/cli

Render a HyperFrames composition on HeyGen's cloud. This involves logging in once, then using `cloud render` to zip, upload, poll, and download the video. Use `--no-wait` to submit and exit with the render ID.

```bash
hyperframes auth login
```

```bash
hyperframes cloud render ./my-video
```

```bash
hyperframes cloud render ./my-video --no-wait
```

```bash
hyperframes cloud list
```

--------------------------------

### Check Environment Dependencies

Source: https://hyperframes.heygen.com/packages/cli

Verify your environment for required dependencies like Node.js, FFmpeg, and Chrome. Output can be JSON for scripting.

```bash
npx hyperframes doctor
```

```bash
hyperframes doctor

  ✓ Version          0.1.4 (latest)
  ✓ Node.js          v22.x (linux x64)
  ✓ FFmpeg            7.x
  ✓ FFprobe           7.x
  ✓ Chrome            (system or cached)
  ✓ Docker            24.x
  ✓ Docker running    Running

  ◇  All checks passed
```

--------------------------------

### View Inline Documentation

Source: https://hyperframes.heygen.com/packages/cli

Displays inline documentation for specified topics within the terminal. Run without a topic to see a full list of available topics.

```bash
npx hyperframes docs [topic]
```

--------------------------------

### Render Video with Variables

Source: https://hyperframes.heygen.com/packages/cli

Override render variables at runtime using a JSON string or a file. Missing keys fall back to declared defaults.

```bash
npx hyperframes render --variables '{"title":"Q4 Report","theme":"dark"}' --output q4.mp4
```

```bash
npx hyperframes render --variables-file ./vars.json --output out.mp4
```

--------------------------------

### Manage Chrome Browser for Rendering

Source: https://hyperframes.heygen.com/packages/cli

Ensure the correct Chrome browser is available for rendering or print its executable path for scripting.

```bash
# Find or download Chrome for rendering
npx hyperframes browser ensure
```

```bash
# Print the browser executable path (for scripting)
```

--------------------------------

### Default Cloud Render

Source: https://hyperframes.heygen.com/packages/cli

Renders the current directory using default settings. This initiates the full cloud rendering process.

```bash
hyperframes cloud render
```

--------------------------------

### Render Composition to MP4

Source: https://hyperframes.heygen.com/packages/cli

Renders a composition to an MP4 file using local mode for fast iteration. Ensure the output path is specified.

```bash
# Local mode (fast iteration)
npx hyperframes render --output output.mp4
```

--------------------------------

### Render Composition with Docker

Source: https://hyperframes.heygen.com/packages/cli

Renders a composition to an MP4 file using Docker mode for deterministic output. This ensures consistent results across different environments.

```bash
# Docker mode (deterministic output)
npx hyperframes render --docker --output output.mp4
```

--------------------------------

### Listing Cloud Renders

Source: https://hyperframes.heygen.com/packages/cli

Paginate through recent renders using `cloud list`. Use `--limit` to cap results per page, `--token` to resume pagination, and `--all` to retrieve the entire list.

```bash
hyperframes cloud list
```

```bash
hyperframes cloud list --limit 50 --json
```

```bash
hyperframes cloud list --all
```

--------------------------------

### Render Composition to WebM with Transparency

Source: https://hyperframes.heygen.com/packages/cli

Renders a composition to a WebM file, supporting transparency. This format is suitable for overlays, captions, or lower thirds.

```bash
# WebM with transparency (for overlays, captions, lower thirds)
npx hyperframes render --format webm --output overlay.webm
```

--------------------------------

### Cloud Render with Specific Composition and Output

Source: https://hyperframes.heygen.com/packages/cli

Renders a specified composition file from the current directory and saves the output to a custom path. This allows for targeted rendering of specific project parts.

```bash
hyperframes cloud render . \
  --composition compositions/intro.html \
  --output ./renders/intro.mp4
```

--------------------------------

### Capture Composition Screenshots

Source: https://hyperframes.heygen.com/packages/cli

Capture key frames from a composition as PNG screenshots to verify visual output. Specify frames using --at for specific timestamps or --frames for a number of evenly spaced frames.

```bash
npx hyperframes snapshot my-project --at 2.9,10.4,18.7
```

```bash
npx hyperframes snapshot my-project --frames 10
```

--------------------------------

### Check for Updates and Show Instructions

Source: https://hyperframes.heygen.com/packages/cli

Check for Hyperframes CLI updates and display upgrade instructions. Options include checking without prompting and machine-readable JSON output.

```bash
npx hyperframes upgrade
```

```bash
npx hyperframes upgrade --check
```

```bash
npx hyperframes upgrade --check --json
```

```bash
npx hyperframes upgrade --yes
```

--------------------------------

### Batch Render from JSONL File

Source: https://hyperframes.heygen.com/packages/cli

Fans out multiple personalized renders from a JSONL batch file. This command deploys the site and invokes `renderToLambda` for each row, managing concurrency.

```bash
hyperframes lambda render-batch ./my-template \
  --batch ./users.jsonl \
  --width 1920 --height 1080 \
  --max-concurrent 10
```

--------------------------------

### Login with API Key

Source: https://hyperframes.heygen.com/packages/cli

Save a HeyGen API key using the `auth login --api-key` command. The key is verified before being saved. It can be provided interactively or piped from stdin.

```bash
hyperframes auth login --api-key
```

```bash
echo "$HEYGEN_API_KEY" | hyperframes auth login --api-key
```

--------------------------------

### Display Project Metadata

Source: https://hyperframes.heygen.com/packages/cli

Show project metadata such as name, resolution, duration, element counts, and total project size. Output can be JSON.

```bash
npx hyperframes info [dir]
```

--------------------------------

### Safe Cloud Rendering with Idempotency Key

Source: https://hyperframes.heygen.com/packages/cli

Use the `--idempotency-key` flag with `cloud render` to prevent duplicate assets and charges when uploading zip files. The key is reused for both upload and submit calls.

```bash
hyperframes cloud render . --idempotency-key "$(uuidgen)"
```

--------------------------------

### Render WebM with Transparency

Source: https://hyperframes.heygen.com/packages/cli

Render compositions with a transparent background using the WebM format. This is useful for creating caption overlays.

```bash
npx hyperframes render --format webm --output captions.webm
```

```bash
ffmpeg -c:v libvpx-vp9 -i captions.webm -i background.mp4 \
  -filter_complex "[1:v][0:v]overlay=0:0" -y composited.mp4
```

--------------------------------

### Creating a Lambda Render Site

Source: https://hyperframes.heygen.com/packages/cli

Upload a project directory to S3 for use with HyperFrames Lambda rendering. This command returns a stable `siteId` that can be reused across multiple renders to skip re-uploading the same project.

```bash
hyperframes lambda sites create ./my-project
```

```bash
hyperframes lambda render ./my-project --site-id=abc1234deadbeef0 --width 1920 --height 1080
```

--------------------------------

### Transcribe Audio/Video with Hyperframes CLI

Source: https://hyperframes.heygen.com/packages/cli

Transcribe audio or video files to word-level timestamps using local whisper.cpp, or import existing transcripts from various formats. Specify model and language for transcription.

```bash
npx hyperframes transcribe audio.mp3
```

```bash
npx hyperframes transcribe video.mp4 --model medium.en --language en
```

```bash
npx hyperframes transcribe subtitles.srt
```

```bash
npx hyperframes transcribe captions.vtt
```

```bash
npx hyperframes transcribe openai-response.json
```

--------------------------------

### Render Composition with Hardware FFmpeg Encoding

Source: https://hyperframes.heygen.com/packages/cli

Renders a composition to an MP4 file utilizing hardware FFmpeg encoding. This can significantly speed up the rendering process on compatible hardware.

```bash
# Add hardware FFmpeg encoding
npx hyperframes render --gpu --output gpu.mp4
```

--------------------------------

### Inspect Detected Providers

Source: https://hyperframes.heygen.com/packages/cli

Inspects and prints the detected execution providers (e.g., CPU, CoreML, CUDA) without performing any rendering. This command is useful for diagnosing device availability.

```bash
npx hyperframes remove-background --info
```

--------------------------------

### Cloud Render from Public URL

Source: https://hyperframes.heygen.com/packages/cli

Renders a project hosted at a public HTTPS URL, bypassing the need for local project directory or upload. This is ideal for rendering publicly accessible zip archives.

```bash
hyperframes cloud render --url https://cdn.example.com/site.zip
```

--------------------------------

### Render Hyperframes Composition to MP4

Source: https://hyperframes.heygen.com/packages/cli

Produce the final video output in MP4 format. You can specify the output file name and optionally render a specific composition file.

```bash
npx hyperframes render --output output.mp4
```

```bash
npx hyperframes render -c compositions/intro.html -o intro.mp4
```

```bash
npx hyperframes render --docker --output output.mp4
```

--------------------------------

### Cloud Render with Higher Quality and FPS

Source: https://hyperframes.heygen.com/packages/cli

Renders a project with enhanced quality settings and a higher frame rate. Use this for demanding visual outputs.

```bash
hyperframes cloud render --quality high --fps 60
```

--------------------------------

### Track Lambda Render Progress

Source: https://hyperframes.heygen.com/packages/cli

Prints the progress snapshot for a specific render. Accepts either a bare `renderId` or a full Step Functions execution ARN.

```bash
hyperframes lambda progress hf-render-abcd1234
```

--------------------------------

### Lint Project Code

Source: https://hyperframes.heygen.com/packages/cli

Run the linter on your project directory to identify errors and warnings. Use --verbose to include info-level findings and --json for machine-readable output.

```bash
npx hyperframes lint [dir] --verbose
```

```bash
npx hyperframes lint [dir] --json
```

--------------------------------

### Print IAM Policies for User

Source: https://hyperframes.heygen.com/packages/cli

Prints the minimum inline IAM policy required for a user to run the Hyperframes CLI commands related to Lambda deployment and execution.

```bash
# Print an inline-policy doc you can attach to an IAM user that runs the CLI.
hyperframes lambda policies user

```

--------------------------------

### Hyperframes Project Configuration

Source: https://hyperframes.heygen.com/packages/cli

The hyperframes.json file is generated by `hyperframes init` and configures project layout and registry settings. Edit this file to customize your project structure or point to a custom registry.

```json
{
  "$schema": "https://hyperframes.heygen.com/schema/hyperframes.json",
  "registry": "https://raw.githubusercontent.com/heygen-com/hyperframes/main/registry",
  "paths": {
    "blocks": "compositions",
    "components": "compositions/components",
    "assets": "assets"
  }
}
```

--------------------------------

### Re-render Existing Asset

Source: https://hyperframes.heygen.com/packages/cli

Initiates a cloud render using an already uploaded asset ID, skipping the zip and upload steps. This is efficient for re-rendering specific compositions without re-uploading the entire project.

```bash
hyperframes cloud render --asset-id asst_abc123
```

--------------------------------

### Inspect Layout (Alias)

Source: https://hyperframes.heygen.com/packages/cli

An alias for the inspect command to check visual layout. Use --json for agent-readable output.

```bash
npx hyperframes layout [dir] --json
```

--------------------------------

### Monitor Cloud Run Render Progress

Source: https://hyperframes.heygen.com/packages/cli

Prints the progress and cost for an in-flight or completed Cloud Run render. Shows coarse running progress and exact frame counts/cost upon completion.

```bash
hyperframes cloudrun progress <executionName>
```

--------------------------------

### Capture Website Assets

Source: https://hyperframes.heygen.com/packages/cli

Use the capture command to extract screenshots, design tokens, fonts, assets, and animations from a website for video production. You can specify an output directory and whether to output structured JSON.

```bash
npx hyperframes capture https://stripe.com
```

```bash
npx hyperframes capture https://linear.app -o captures/linear
```

```bash
npx hyperframes capture https://example.com --json
```

--------------------------------

### Enable Telemetry

Source: https://hyperframes.heygen.com/packages/cli

Enables anonymous usage telemetry collection for the HyperFrames CLI.

```bash
npx hyperframes telemetry enable
```

--------------------------------

### Upgrade Check JSON Output

Source: https://hyperframes.heygen.com/packages/cli

Machine-readable JSON output from `hyperframes upgrade --check --json` detailing current, latest, and update availability.

```json
{
  "current": "0.1.4",
  "latest": "0.1.5",
  "updateAvailable": true,
  "_meta": { "version": "0.1.4", "latestVersion": "0.1.5", "updateAvailable": true }
}
```

--------------------------------

### Render with Declared Defaults

Source: https://hyperframes.heygen.com/packages/cli

This bash command renders a composition using the default variables declared in the HTML. This is useful for previewing or generating output with standard settings.

```bash
npx hyperframes render --output default.mp4
```

--------------------------------

### Render Composition Opting Out of Browser GPU

Source: https://hyperframes.heygen.com/packages/cli

Renders a composition to an MP4 file while opting out of local browser GPU capture. This forces rendering to use the CPU, which can be useful for debugging or specific hardware configurations.

```bash
# Opt out of local browser GPU capture
npx hyperframes render --no-browser-gpu --output cpu-browser.mp4
```

--------------------------------

### Deploy HyperFrames to Cloud Run

Source: https://hyperframes.heygen.com/packages/cli

Deploys HyperFrames distributed rendering to Google Cloud Run and Cloud Workflows. This command enables required APIs, builds and pushes the render image, and applies Terraform to provision necessary resources.

```bash
hyperframes cloudrun deploy --project my-gcp-project
```

```bash
hyperframes cloudrun deploy --project my-gcp-project --region us-central1
```

```bash
hyperframes cloudrun deploy --project my-gcp-project --image us-central1-docker.pkg.dev/my-gcp-project/hyperframes/hyperframes-render:v1
```

--------------------------------

### Gate CI on Doctor JSON Output

Source: https://hyperframes.heygen.com/packages/cli

Use `hyperframes doctor --json` piped through `jq` to gate CI pipelines based on environment health. The `ok` field indicates success.

```bash
npx hyperframes doctor --json | jq -e '.ok' > /dev/null || handle_failure
```

--------------------------------

### Print IAM Policies for Lambda Role

Source: https://hyperframes.heygen.com/packages/cli

Prints the TrustRelationship and InlinePolicy for a specified IAM role. Defaults to the cloudformation principal.

```bash
hyperframes lambda policies role --principal=cloudformation
```

--------------------------------

### List Available TTS Voices

Source: https://hyperframes.heygen.com/packages/cli

To see all available voice options for the text-to-speech command, use the `--list` flag.

```bash
npx hyperframes tts --list
```

--------------------------------

### Inspect Visual Layout

Source: https://hyperframes.heygen.com/packages/cli

Inspect the rendered visual layout of a composition across its timeline. This command helps identify elements that overflow their containers. Use --json for agent-readable output.

```bash
npx hyperframes inspect [dir]
```

```bash
npx hyperframes inspect [dir] --json
```

```bash
npx hyperframes inspect [dir] --samples 15
```

```bash
npx hyperframes inspect [dir] --at 1.5,4,7.25
```

--------------------------------

### Check Authentication Status

Source: https://hyperframes.heygen.com/packages/cli

Display the active credential's source, type, and verified identity using `auth status`. This command is useful for scripts to check sign-in state, exiting non-zero if no configuration is found or the credential is rejected. Use `--json` for machine-readable output.

```bash
hyperframes auth status
```

```bash
hyperframes auth status --json
```

--------------------------------

### Output Result as JSON

Source: https://hyperframes.heygen.com/packages/cli

Outputs the result of the background removal process in JSON format. This is useful for programmatic integration and further processing of the results.

```bash
npx hyperframes remove-background avatar.mp4 --json
```

--------------------------------

### Submit Feedback with Rating and Comment

Source: https://hyperframes.heygen.com/packages/cli

Enables submitting anonymous feedback including a satisfaction rating and optional detailed comments.

```bash
npx hyperframes feedback --rating 3 --comment "render succeeded but GSAP timeline didn't animate"
```