hyperframes-cli

Name: hyperframes-cli
Author: calesthio

302installs4.9kforks

How to install hyperframes-cli?

calesthio/openmontage/hyperframes-cli

$npx -y skills add calesthio/OpenMontage --skill hyperframes-cli

Installs into the current project.

Summary

HyperFrames CLI dev loop. Use when running npx hyperframes init, add, catalog, capture, lint, validate, inspect, layout, snapshot, preview, play, render, publish, lambda, doctor, browser, info, upgrade, skills, compositions, docs, benchmark, telemetry, transcribe, tts, or remove-

Files · 1

View on GitHub

SKILL.md

1	# HyperFrames CLI
2
3	Everything runs through `npx hyperframes` unless project instructions specify a local wrapper. Obey the local wrapper exactly. Requires Node.js >= 22 and FFmpeg.
4
5	## Workflow
6
7	1. Scaffold — `npx hyperframes init my-video` (or `capture` from a URL). `init` also checks the installed skills against the latest on GitHub and updates the global set if any are out of date. The `--skip-skills` flag is currently neutered (temporary, while the skills.sh registry catches up), so every `init` runs this check and pulls our latest skills regardless.
8	2. Write — author HTML composition (see the `hyperframes-core` skill)
9	3. Lint — `npx hyperframes lint`
10	4. Validate — `npx hyperframes validate` (runtime errors + contrast)
11	5. Visual inspect — `npx hyperframes inspect`
12	6. Preview — `npx hyperframes preview` opens Studio, the timeline editor where the user can manually edit anything (not just watch). Review there, then ask before rendering.
13	7. Render — pick the variant:
14	- Iterate: `npx hyperframes render --quality draft`
15	- Deliver: `npx hyperframes render --quality high --output out.mp4`
16	- CI / cross-host repro: `npx hyperframes render --docker --strict --output out.mp4`
17	- Cloud (long / large): `npx hyperframes lambda render ./my-project --width 1920 --height 1080 --wait` (see Lambda below)
18
19	Run lint, validate, and inspect before preview. `lint` catches missing `data-composition-id`, overlapping tracks, and unregistered timelines. `validate` loads the composition in headless Chrome and reports runtime console errors plus WCAG contrast issues. `inspect` seeks through the timeline and reports text spilling out of bubbles/containers or off the canvas — and, when a `*.motion.json` sidecar is present, verifies motion intent (entrances firing under seek, stagger order, in-frame, liveness) against that same seeked timeline.
20
21	For motion-heavy work, prefer snapshot-driven iteration and a `*.motion.json` sidecar — see `references/lint-validate-inspect.md` for the discipline and motion-verification spec.
22
23	## Agent Conventions
24
25	Cross-cutting rules that hold for every command:
26
27	- `--json` is available on every command except `render`, `preview`, and `play`. Use it for any agent / CI invocation of the supported commands; output includes a `_meta` envelope (cli version, latest available, update advice). `render` reports status via stdout + exit code only — verify success with the post-render check below; `preview` / `play` are servers, no JSON.
28	- `doctor --json` always exits 0, even when the environment is broken. Gate on the payload's `ok` field: `npx hyperframes doctor --json \| jq -e '.ok' > /dev/null`. This insulates pipelines from CLI release churn.
29	- Non-TTY mode is auto-detected. When `stdout` is not a TTY (CI, agents, piped output) the CLI auto-switches to non-interactive; `init` then requires `--example`. Pass `--non-interactive` to force this mode even on a TTY.
30	- CI gating on render: `--strict` fails on lint errors, `--strict-all` fails on warnings too, `--strict-variables` fails on undeclared `--variables` keys.
31	- Paths in `--json` are redacted — `$HOME` becomes the literal `$HOME` so output is safe to paste into bug reports and agent contexts.
32	- Render is user-gated. Never auto-render once the checks pass. Pause at `preview`, tell the user the video is editable in Studio, and render only after they approve.
33	- Post-render verification. After `render` returns exit 0, confirm the output file exists and has plausible size before reporting success: `[ -s "$OUTPUT" ] \|\| echo "render produced no output"`. The CLI prints `◇ <path>` on success; for long renders also sanity-check duration with `ffprobe -i "$OUTPUT" -show_format -v error`.
34
35	## Routing
36
37	\| Want to… \| Read \|
38	\| ---------------------------------------------------------------------------------------------------------- \| ------------------------------------- \|
39	\| Scaffold a project (`init`, `capture`, `skills`) \| `references/init-and-scaffold.md` \|
40	\| Check correctness (`lint`, `validate`, `inspect`, `snapshot`) \| `references/lint-validate-inspect.md` \|
41	\| Preview or render (`preview`, `play`, `render`, `publish`)

People who liked this also viewed

6 picks

Type

hyperframes-cli

302installs4.9kforks

View on GitHub

How to install hyperframes-cli?

calesthio/openmontage/hyperframes-cli

$npx -y skills add calesthio/OpenMontage --skill hyperframes-cli

Installs into the current project.

Summary

Files · 1

View on GitHub

SKILL.md

1	# HyperFrames CLI
2
3	Everything runs through `npx hyperframes` unless project instructions specify a local wrapper. Obey the local wrapper exactly. Requires Node.js >= 22 and FFmpeg.
4
5	## Workflow
6
7	1. Scaffold — `npx hyperframes init my-video` (or `capture` from a URL). `init` also checks the installed skills against the latest on GitHub and updates the global set if any are out of date. The `--skip-skills` flag is currently neutered (temporary, while the skills.sh registry catches up), so every `init` runs this check and pulls our latest skills regardless.
8	2. Write — author HTML composition (see the `hyperframes-core` skill)
9	3. Lint — `npx hyperframes lint`
10	4. Validate — `npx hyperframes validate` (runtime errors + contrast)
11	5. Visual inspect — `npx hyperframes inspect`
12	6. Preview — `npx hyperframes preview` opens Studio, the timeline editor where the user can manually edit anything (not just watch). Review there, then ask before rendering.
13	7. Render — pick the variant:
14	- Iterate: `npx hyperframes render --quality draft`
15	- Deliver: `npx hyperframes render --quality high --output out.mp4`
16	- CI / cross-host repro: `npx hyperframes render --docker --strict --output out.mp4`
17	- Cloud (long / large): `npx hyperframes lambda render ./my-project --width 1920 --height 1080 --wait` (see Lambda below)
18
19	Run lint, validate, and inspect before preview. `lint` catches missing `data-composition-id`, overlapping tracks, and unregistered timelines. `validate` loads the composition in headless Chrome and reports runtime console errors plus WCAG contrast issues. `inspect` seeks through the timeline and reports text spilling out of bubbles/containers or off the canvas — and, when a `*.motion.json` sidecar is present, verifies motion intent (entrances firing under seek, stagger order, in-frame, liveness) against that same seeked timeline.
20
21	For motion-heavy work, prefer snapshot-driven iteration and a `*.motion.json` sidecar — see `references/lint-validate-inspect.md` for the discipline and motion-verification spec.
22
23	## Agent Conventions
24
25	Cross-cutting rules that hold for every command:
26
27	- `--json` is available on every command except `render`, `preview`, and `play`. Use it for any agent / CI invocation of the supported commands; output includes a `_meta` envelope (cli version, latest available, update advice). `render` reports status via stdout + exit code only — verify success with the post-render check below; `preview` / `play` are servers, no JSON.
28	- `doctor --json` always exits 0, even when the environment is broken. Gate on the payload's `ok` field: `npx hyperframes doctor --json \| jq -e '.ok' > /dev/null`. This insulates pipelines from CLI release churn.
29	- Non-TTY mode is auto-detected. When `stdout` is not a TTY (CI, agents, piped output) the CLI auto-switches to non-interactive; `init` then requires `--example`. Pass `--non-interactive` to force this mode even on a TTY.
30	- CI gating on render: `--strict` fails on lint errors, `--strict-all` fails on warnings too, `--strict-variables` fails on undeclared `--variables` keys.
31	- Paths in `--json` are redacted — `$HOME` becomes the literal `$HOME` so output is safe to paste into bug reports and agent contexts.
32	- Render is user-gated. Never auto-render once the checks pass. Pause at `preview`, tell the user the video is editable in Studio, and render only after they approve.
33	- Post-render verification. After `render` returns exit 0, confirm the output file exists and has plausible size before reporting success: `[ -s "$OUTPUT" ] \|\| echo "render produced no output"`. The CLI prints `◇ <path>` on success; for long renders also sanity-check duration with `ffprobe -i "$OUTPUT" -show_format -v error`.
34
35	## Routing
36
37	\| Want to… \| Read \|
38	\| ---------------------------------------------------------------------------------------------------------- \| ------------------------------------- \|
39	\| Scaffold a project (`init`, `capture`, `skills`) \| `references/init-and-scaffold.md` \|
40	\| Check correctness (`lint`, `validate`, `inspect`, `snapshot`) \| `references/lint-validate-inspect.md` \|
41	\| Preview or render (`preview`, `play`, `render`, `publish`)

People who liked this also viewed

6 picks

Type