hyperframes init
Scaffold a new HyperFrames project with templates, package manager choice, and optional git and install steps.
hyperframes init creates a new project directory with a working composition, a package.json pinned to the current CLI version, and the recommended config. Reach for it when starting a new repo or adding a video sub-project to a monorepo.
Synopsis
bash
hyperframes init [name] [flags]If [name] is omitted, the current directory is used. The CLI refuses to overwrite a non-empty directory unless --force is passed.
Flags
| Flag | Default | Meaning |
|---|---|---|
--template <name> | blank | Starter template. See list below. |
--package-manager <pm> | pnpm | npm | pnpm | yarn | bun. Writes lockfile and scripts accordingly. |
--git / --no-git | --git | Initialize a git repo and make the first commit. |
--install / --no-install | --install | Run the package manager's install after scaffolding. |
--force | off | Allow scaffolding into a non-empty directory. |
--example <slug> | — | Copy one of the official examples as the entry composition. |
Templates
| Template | Contents |
|---|---|
blank | One comp.html, a config, and a README. |
marketing | Hero, lower-third, end-card. Good for product launches. |
social | 9x16 and 1x1 variants of one composition. |
agent | Headless-only setup. No preview UI, JSON output by default. |
Common invocations
$ hyperframes init my-clip --template marketing
created my-clip/
comp.html
hyperframes.config.ts
package.json
README.md
installed 142 packages in 4.1s
initialized git repositoryJSON output
json
{
"command": "init",
"status": "ok",
"exit_code": 0,
"path": "/Users/me/projects/my-clip",
"template": "marketing",
"package_manager": "pnpm",
"files_written": 6,
"git_initialized": true,
"installed": true,
"duration_ms": 4180
}Exit codes
0— project created.1— invalid flags, or target directory exists and--forcenot passed.5— git or package manager binary missing on PATH.
Tips
- Pair
--no-install --no-gitfor use inside larger scaffolding scripts; the CLI becomes a pure file-emitter. - The generated
hyperframes.config.tsis intentionally minimal — open it before your firstrenderto set width, height, and codec. - Templates are copied, not symlinked. You own every file in the new project from minute one.
--examplemakes onboarding a one-liner: pick a slug from the examples gallery and ship.
Next
- HyperFrames CLI — full command index.
hyperframes preview— open your new project in the live editor.