Install

The CLI is a single npm package with a bundled Chromium and a sniffed FFmpeg. Most installs are one command.

What you'll learn

• Install on macOS, Linux, Windows, or via Docker
• Pin the right FFmpeg version
• Use hyperframes doctor to catch environment drift early

Install

# Homebrew handles ffmpeg + node
brew install node ffmpeg
npm install -g hyperframes
hyperframes doctor

Pin FFmpeg

If your distro is stuck on FFmpeg 4 or 5, use the static builds from BtbN/FFmpeg-Builds or run the Docker image — it bundles 6.1.

Verify with doctor

hyperframes doctor runs a non-destructive audit of every binary the renderer touches. Run it after installing, after upgrading the OS, and any time CI starts behaving oddly.

$ hyperframes doctor

  HyperFrames CLI         2.4.0
  Node                    v20.11.1            ok
  Chromium (bundled)      124.0.6367.91       ok
  FFmpeg                  6.1.1               ok
  libvpx                  1.13.1              ok
  Disk space (/tmp)       42 GB free          ok
  GPU (optional)          Apple M2            ok

  All checks passed.

If anything is missing or out of date, doctor prints the exact install command for your platform.

Update and uninstall

hyperframes upgrade            # update to the latest stable
hyperframes upgrade --channel next   # opt into the next-release channel
npm uninstall -g hyperframes

The bundled Chromium lives in ~/.hyperframes/chrome — hyperframes browser clean purges it if you need the disk back.

Next

• Quickstart — your first composition in five minutes
• hyperframes CLI reference — every command and flag