You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit cf7c1d7
Browse filesBrowse the repository at this point in the historyBrowse files
docs(cli,skills): teach check as the canonical verification gate
Scaffolded projects' npm run check now invokes the single check command
instead of chaining lint, validate, and inspect (three Chrome boots
become one). The CLI skill, its correctness reference, the entry skill's
capability map, README/docs catalog rows, the Mintlify CLI page (new
check section, deprecation banner on inspect), template CLAUDE/AGENTS
(byte-identical), root CLAUDE/AGENTS, and every creation-workflow skill
that taught the old sequence all point at check. snapshot keeps its
standalone sections; validate/inspect stay documented as deprecated
aliases with their check equivalents.
-`/media-use` — the media OS: resolve any media need (BGM, SFX, image, icon, logo, voice, color grade, LUT) into a frozen local file or paste-ready block + ledger record; generate via TTS / music / image models when the catalog misses; transcribe, caption, remove backgrounds, and reuse assets across projects. One shared `scripts/audio.mjs` engine + manifest tracking; keeps search noise on disk.
-`/hyperframes-registry` — install and wire registry blocks and components into compositions via `hyperframes add`. Covers authoring a new block or component to contribute upstream.
44
44
-`/figma` — import Figma assets, tokens, components, and storyboard sections → reconstructed motion (frames read as states, not slides) (REST/CLI) plus Motion animations (MCP) and shaders (MCP source / native export) into a composition.
45
45
@@ -81,7 +81,7 @@ After creating or editing any `.html` composition:
81
81
82
82
```bash
83
83
npx hyperframes lint # Static HTML structure check
|`/media-use`| The media OS — resolve any media need (BGM, SFX, image, icon, logo, voice, color grade, LUT) into a frozen local file or paste-ready block + ledger record, generate via TTS/music/image models when the catalog misses, transcribe, caption, remove backgrounds, and reuse assets across projects. One shared audio engine + manifest tracking. |
|`/hyperframes-registry`| Install and wire registry blocks and components into compositions via `hyperframes add`. Authoring a new block or component to contribute upstream. |
95
95
|`/figma`| Import Figma assets, tokens, components, and storyboard sections → reconstructed motion (frames read as states, not slides) (REST/CLI) plus Motion animations (MCP) and shaders (MCP source / native export) into a composition. |
Copy file name to clipboardExpand all lines: docs/guides/prompting.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -268,7 +268,7 @@ Things that cause friction (or wrong output):
268
268
-**Don't ask for React / Vue components.** Hyperframes compositions are plain HTML with `data-*` attributes and a GSAP timeline. Asking for "a React component for the intro" forces the agent to translate later.
269
269
-**Don't ask for 4K or 60fps unless you need it.** Defaults (1920×1080, 30fps) render fast and look great. Higher specs slow rendering meaningfully.
270
270
-**Don't skip the slash command.** Without `/hyperframes`, the agent may guess at HTML video conventions instead of using the framework's actual rules (`class="clip"` on timed elements, `window.__timelines` registration, etc.).
271
-
-**Don't paste long error logs into the prompt without context.** Run `npx hyperframes lint` and `npx hyperframes validate` first — lint catches structural issues, validate catches runtime errors (JS exceptions, missing assets, contrast problems).
271
+
-**Don't paste long error logs into the prompt without context.** Run `npx hyperframes check` first — lint catches structural issues, validate catches runtime errors (JS exceptions, missing assets, contrast problems).
272
272
-**Don't assume the agent knows your assets.** Mention file paths explicitly (`assets/intro.mp4`, `assets/logo.png`) — the agent will check what's there but a hint speeds it up.
|`/media-use`| The media OS — resolve any media need (BGM, SFX, image, icon, logo, voice, color grade, LUT) into a frozen local file or paste-ready block + ledger record, generate via TTS/music/image models when the catalog misses, transcribe, caption, remove backgrounds, and reuse assets across projects. One shared audio engine + manifest tracking. |
|`/hyperframes-registry`| Install and wire registry blocks and components into compositions via `hyperframes add`. Authoring a new block or component to contribute upstream. |
104
104
|`/figma`| Import Figma assets, tokens, components, and storyboard sections → reconstructed motion (frames read as states, not slides) (REST/CLI) plus Motion animations (MCP) and shaders (MCP source / native export) into a composition. |
Copy file name to clipboardExpand all lines: docs/guides/video-editor-cheatsheet.mdx
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -27,7 +27,7 @@ Before showing or rendering a project:
27
27
28
28
```bash
29
29
npx hyperframes lint
30
-
npx hyperframes validate
30
+
npx hyperframes check
31
31
npx hyperframes render --quality standard --output review.mp4
32
32
```
33
33
@@ -174,8 +174,8 @@ I moved the hero title and resized the CTA manually in Studio. Inspect the chang
174
174
|`npx hyperframes capture https://example.com`| Capture a website as source material for a video |
175
175
|`npx hyperframes preview`| Open the live Studio preview |
176
176
|`npx hyperframes lint`| Catch structural mistakes before preview or render |
177
-
|`npx hyperframes validate`| Run the composition in headless Chrome to catch runtime errors |
178
-
|`npx hyperframes inspect`| Find text overflow and layout problems across the timeline |
177
+
|`npx hyperframes check`| Run the composition in headless Chrome to catch runtime errors |
178
+
|`npx hyperframes check`| Find text overflow and layout problems across the timeline |
179
179
|`npx hyperframes snapshot --at 1,3,5`| Save PNG checks at exact timestamps |
180
180
|`npx hyperframes render --output final.mp4`| Render the video |
181
181
|`npx hyperframes publish`| Upload the project and get a shareable HyperFrames URL |
@@ -278,9 +278,9 @@ For editor-facing changes, keep `npx hyperframes preview` running, then have the
278
278
| --- | --- |
279
279
| Preview will not start |`npx hyperframes doctor`|
280
280
| Port already in use |`npx hyperframes preview --port 4567`|
281
-
| Render fails |`npx hyperframes lint` then `npx hyperframes validate`|
281
+
| Render fails |`npx hyperframes lint` then `npx hyperframes check`|
282
282
| Need exact frame checks |`npx hyperframes snapshot --at 1,2.5,5`|
283
-
| Text overflows in the frame |`npx hyperframes inspect`|
283
+
| Text overflows in the frame |`npx hyperframes check`|
284
284
| Final render is too slow | Try `--quality draft`, reduce image sizes, or lower `--fps`|
285
285
| Need to share editable project |`npx hyperframes publish`|
Copy file name to clipboardExpand all lines: docs/packages/cli.mdx
+30Lines changed: 30 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -520,6 +520,34 @@ Word-level transcripts (whisper output) are grouped into readable caption cues o
520
520
521
521
The linter detects missing attributes, missing adapter libraries (GSAP, Lottie, Three.js), structural problems, and more. See [Common Mistakes](/guides/common-mistakes) for details on each rule.
522
522
523
+
### `check`
524
+
525
+
The browser verification gate: everything the old `validate` → `inspect` → `snapshot` loop did, in **one** command with one browser session:
npx hyperframes check [dir] --strict # exit non-zero on warnings too
533
+
```
534
+
535
+
`check` runs the linter first (browser skipped entirely on lint errors), then loads the bundled composition once and sweeps one seek grid running every audit per sample: runtime console errors and failed requests, layout defects (overflow, clipping, held overlaps, occlusion), `*.motion.json` sidecar assertions, and WCAG AA contrast.
536
+
537
+
| Flag | Description |
538
+
|------|-------------|
539
+
|`--json`| Aggregated machine-readable envelope; every finding carries selector, `data-*` identity, source file, bbox, and sample time |
540
+
|`--snapshots`| Write overview frames (annotated with labeled finding boxes when there are errors) plus `finding-NN-<code>.png` crops |
541
+
|`--samples` / `--at` / `--at-transitions`| Control the seek grid (default 9 samples; `--at-transitions` adds tween boundaries) |
542
+
|`--tolerance`| Allowed overflow in px before reporting (default 2) |
543
+
|`--timeout`| Initial settle budget in ms (default 3000) |
544
+
|`--no-contrast`| Skip the WCAG audit while iterating |
545
+
|`--strict`| Exit non-zero on warnings too (default: only errors) |
546
+
|`--caption-zone "<x0=..;y0=..;x1=..;y1=..>"`| Opt-in band gate: flags content whose center sits inside the fractional band (optional `severity`, `seek`) |
547
+
|`--frame-check`| Opt-in media out-of-frame detection (img/svg/video/canvas) |
548
+
549
+
Contrast failures are **errors** and include the sampled fg/bg colors, measured vs required ratio, and a suggested compliant color. Severity is persistence-aware: single-sample transients demote to info, held findings gate the exit code, and a frozen timeline on a 3s+ composition fails with `sweep_static`.
550
+
523
551
### `beats`
524
552
525
553
Detect the beats in a composition's music track and write them to a beat file the Studio uses to draw beat guides on the timeline:
@@ -549,6 +577,8 @@ Word-level transcripts (whisper output) are grouped into readable caption cues o
549
577
550
578
### `inspect`
551
579
580
+
<Warning>Deprecated: use [`check`](#check) — it covers this layout sweep plus runtime, motion, and contrast in one browser session. `inspect` keeps working and marks `_meta.deprecated: true` in JSON output.</Warning>
581
+
552
582
Inspect rendered visual layout across the composition timeline:
0 commit comments