zilmate 1.9.9 → 1.10.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.agents/skills/ad-creative/SKILL.md +362 -0
- package/.agents/skills/ad-creative/evals/evals.json +90 -0
- package/.agents/skills/ad-creative/references/generative-tools.md +637 -0
- package/.agents/skills/ad-creative/references/platform-specs.md +213 -0
- package/.agents/skills/ai-seo/SKILL.md +489 -0
- package/.agents/skills/ai-seo/evals/evals.json +90 -0
- package/.agents/skills/ai-seo/references/content-patterns.md +285 -0
- package/.agents/skills/ai-seo/references/content-types.md +71 -0
- package/.agents/skills/ai-seo/references/okf.md +104 -0
- package/.agents/skills/ai-seo/references/platform-ranking-factors.md +154 -0
- package/.agents/skills/clerk-backend-api/SKILL.md +426 -0
- package/.agents/skills/clerk-backend-api/evals/evals.json +87 -0
- package/.agents/skills/clerk-backend-api/scripts/api-specs-context.sh +30 -0
- package/.agents/skills/clerk-backend-api/scripts/execute-request.sh +88 -0
- package/.agents/skills/clerk-backend-api/scripts/extract-endpoint-detail.sh +165 -0
- package/.agents/skills/clerk-backend-api/scripts/extract-tag-endpoints.sh +208 -0
- package/.agents/skills/clerk-backend-api/scripts/extract-tags.js +14 -0
- package/.agents/skills/copy-editing/SKILL.md +457 -0
- package/.agents/skills/copy-editing/evals/evals.json +89 -0
- package/.agents/skills/copy-editing/references/checklist.md +66 -0
- package/.agents/skills/copy-editing/references/content-refresh.md +38 -0
- package/.agents/skills/copy-editing/references/plain-english-alternatives.md +394 -0
- package/.agents/skills/hyperframes/SKILL.md +163 -0
- package/.agents/skills/hyperframes-cli/SKILL.md +109 -0
- package/.agents/skills/hyperframes-cli/references/doctor-browser.md +45 -0
- package/.agents/skills/hyperframes-cli/references/init-and-scaffold.md +51 -0
- package/.agents/skills/hyperframes-cli/references/lambda.md +132 -0
- package/.agents/skills/hyperframes-cli/references/lint-validate-inspect.md +121 -0
- package/.agents/skills/hyperframes-cli/references/preview-render.md +109 -0
- package/.agents/skills/hyperframes-cli/references/upgrade-info-misc.md +75 -0
- package/.agents/skills/hyperframes-media/SKILL.md +97 -0
- package/.agents/skills/hyperframes-media/assets/sfx/CREDITS.md +35 -0
- package/.agents/skills/hyperframes-media/assets/sfx/manifest.json +97 -0
- package/.agents/skills/hyperframes-media/references/bgm.md +72 -0
- package/.agents/skills/hyperframes-media/references/captions/authoring.md +159 -0
- package/.agents/skills/hyperframes-media/references/captions/motion.md +87 -0
- package/.agents/skills/hyperframes-media/references/captions/transcript-handling.md +97 -0
- package/.agents/skills/hyperframes-media/references/remove-background.md +143 -0
- package/.agents/skills/hyperframes-media/references/requirements.md +29 -0
- package/.agents/skills/hyperframes-media/references/sfx.md +42 -0
- package/.agents/skills/hyperframes-media/references/transcribe.md +52 -0
- package/.agents/skills/hyperframes-media/references/tts-to-captions.md +24 -0
- package/.agents/skills/hyperframes-media/references/tts.md +135 -0
- package/.agents/skills/hyperframes-media/scripts/audio.mjs +282 -0
- package/.agents/skills/hyperframes-media/scripts/heygen-tts.mjs +121 -0
- package/.agents/skills/hyperframes-media/scripts/lib/bgm.mjs +235 -0
- package/.agents/skills/hyperframes-media/scripts/lib/heygen.mjs +131 -0
- package/.agents/skills/hyperframes-media/scripts/lib/sfx.mjs +128 -0
- package/.agents/skills/hyperframes-media/scripts/lib/tts.mjs +220 -0
- package/.agents/skills/hyperframes-media/scripts/lyria-recipe.py +128 -0
- package/.agents/skills/hyperframes-media/scripts/wait-bgm.mjs +167 -0
- package/.agents/skills/hyperframes-registry/SKILL.md +101 -0
- package/.agents/skills/hyperframes-registry/examples/add-block.md +51 -0
- package/.agents/skills/hyperframes-registry/examples/add-component.md +73 -0
- package/.agents/skills/hyperframes-registry/references/contributing.md +166 -0
- package/.agents/skills/hyperframes-registry/references/demo-html-pattern.md +54 -0
- package/.agents/skills/hyperframes-registry/references/discovery.md +215 -0
- package/.agents/skills/hyperframes-registry/references/install-locations.md +45 -0
- package/.agents/skills/hyperframes-registry/references/templates.md +417 -0
- package/.agents/skills/hyperframes-registry/references/wiring-blocks.md +61 -0
- package/.agents/skills/hyperframes-registry/references/wiring-components.md +39 -0
- package/.agents/skills/marketing-psychology/SKILL.md +455 -0
- package/.agents/skills/marketing-psychology/evals/evals.json +88 -0
- package/.agents/skills/mintlify/SKILL.md +328 -0
- package/.agents/skills/product-launch-video/SKILL.md +206 -0
- package/.agents/skills/product-launch-video/references/cut-catalog.md +220 -0
- package/.agents/skills/product-launch-video/references/motion-language.md +156 -0
- package/.agents/skills/product-launch-video/references/story-design.md +373 -0
- package/.agents/skills/product-launch-video/references/visual-design.md +126 -0
- package/.agents/skills/product-launch-video/scripts/assemble-index.mjs +570 -0
- package/.agents/skills/product-launch-video/scripts/audio.mjs +253 -0
- package/.agents/skills/product-launch-video/scripts/build-frame.mjs +536 -0
- package/.agents/skills/product-launch-video/scripts/captions.mjs +508 -0
- package/.agents/skills/product-launch-video/scripts/lib/assets.mjs +55 -0
- package/.agents/skills/product-launch-video/scripts/lib/dimensions.mjs +45 -0
- package/.agents/skills/product-launch-video/scripts/lib/storyboard.mjs +249 -0
- package/.agents/skills/product-launch-video/scripts/lib/tokens.mjs +204 -0
- package/.agents/skills/product-launch-video/scripts/lib/transition-registry.mjs +38 -0
- package/.agents/skills/product-launch-video/scripts/lib/transitions.json +71 -0
- package/.agents/skills/product-launch-video/scripts/stage-assets.mjs +39 -0
- package/.agents/skills/product-launch-video/scripts/transitions.mjs +320 -0
- package/.agents/skills/product-launch-video/sub-agents/frame-worker.md +74 -0
- package/.agents/skills/prompt-engineering-patterns/SKILL.md +144 -0
- package/.agents/skills/prompt-engineering-patterns/assets/few-shot-examples.json +106 -0
- package/.agents/skills/prompt-engineering-patterns/assets/prompt-template-library.md +264 -0
- package/.agents/skills/prompt-engineering-patterns/references/chain-of-thought.md +412 -0
- package/.agents/skills/prompt-engineering-patterns/references/details.md +338 -0
- package/.agents/skills/prompt-engineering-patterns/references/few-shot-learning.md +386 -0
- package/.agents/skills/prompt-engineering-patterns/references/prompt-optimization.md +428 -0
- package/.agents/skills/prompt-engineering-patterns/references/prompt-templates.md +484 -0
- package/.agents/skills/prompt-engineering-patterns/references/system-prompts.md +195 -0
- package/.agents/skills/prompt-engineering-patterns/scripts/optimize-prompt.py +279 -0
- package/.agents/skills/remotion-to-hyperframes/SKILL.md +127 -0
- package/.agents/skills/remotion-to-hyperframes/assets/.gitkeep +0 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/run.sh +249 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-1-title-card/README.md +41 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-1-title-card/expected.json +26 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-1-title-card/hf-src/index.html +61 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-1-title-card/remotion-src/package.json +14 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-1-title-card/remotion-src/remotion.config.ts +13 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-1-title-card/remotion-src/src/Root.tsx +13 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-1-title-card/remotion-src/src/TitleCard.tsx +34 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-1-title-card/remotion-src/src/index.ts +4 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-1-title-card/remotion-src/tsconfig.json +15 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-2-multi-scene/README.md +54 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-2-multi-scene/expected.json +29 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-2-multi-scene/hf-src/index.html +118 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-2-multi-scene/remotion-src/package.json +14 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-2-multi-scene/remotion-src/remotion.config.ts +13 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-2-multi-scene/remotion-src/src/MultiScene.tsx +105 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-2-multi-scene/remotion-src/src/Root.tsx +13 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-2-multi-scene/remotion-src/src/index.ts +4 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-2-multi-scene/remotion-src/tsconfig.json +15 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-2-multi-scene/setup.sh +34 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-3-data-driven/README.md +85 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-3-data-driven/expected.json +41 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-3-data-driven/hf-src/index.html +269 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-3-data-driven/remotion-src/package.json +15 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-3-data-driven/remotion-src/remotion.config.ts +13 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-3-data-driven/remotion-src/src/Root.tsx +27 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-3-data-driven/remotion-src/src/Stargazed.tsx +37 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-3-data-driven/remotion-src/src/components/AnimatedNumber.tsx +23 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-3-data-driven/remotion-src/src/components/StatCard.tsx +59 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-3-data-driven/remotion-src/src/components/UnderlinedText.tsx +47 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-3-data-driven/remotion-src/src/index.ts +4 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-3-data-driven/remotion-src/src/scenes/OutroScene.tsx +18 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-3-data-driven/remotion-src/src/scenes/StatsScene.tsx +34 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-3-data-driven/remotion-src/src/scenes/TitleScene.tsx +55 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-3-data-driven/remotion-src/tsconfig.json +15 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-4-escape-hatch/README.md +51 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-4-escape-hatch/cases/01-use-state.tsx +29 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-4-escape-hatch/cases/02-use-effect-deps.tsx +29 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-4-escape-hatch/cases/03-async-metadata.tsx +39 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-4-escape-hatch/cases/04-third-party-react.tsx +30 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-4-escape-hatch/cases/05-lambda-config.tsx +38 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-4-escape-hatch/cases/06-warnings-only.tsx +36 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-4-escape-hatch/cases/07-custom-hook.tsx +28 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-4-escape-hatch/cases/08-mixed.tsx +41 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-4-escape-hatch/expected.json +85 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-4-escape-hatch/validate.sh +110 -0
- package/.agents/skills/remotion-to-hyperframes/references/api-map.md +142 -0
- package/.agents/skills/remotion-to-hyperframes/references/escape-hatch.md +115 -0
- package/.agents/skills/remotion-to-hyperframes/references/eval.md +140 -0
- package/.agents/skills/remotion-to-hyperframes/references/fonts.md +112 -0
- package/.agents/skills/remotion-to-hyperframes/references/limitations.md +136 -0
- package/.agents/skills/remotion-to-hyperframes/references/lottie.md +121 -0
- package/.agents/skills/remotion-to-hyperframes/references/media.md +149 -0
- package/.agents/skills/remotion-to-hyperframes/references/parameters.md +167 -0
- package/.agents/skills/remotion-to-hyperframes/references/sequencing.md +195 -0
- package/.agents/skills/remotion-to-hyperframes/references/timing.md +165 -0
- package/.agents/skills/remotion-to-hyperframes/references/transitions.md +114 -0
- package/.agents/skills/remotion-to-hyperframes/scripts/.gitkeep +0 -0
- package/.agents/skills/remotion-to-hyperframes/scripts/frame_strip.sh +107 -0
- package/.agents/skills/remotion-to-hyperframes/scripts/lint_source.py +358 -0
- package/.agents/skills/remotion-to-hyperframes/scripts/render_diff.sh +103 -0
- package/.agents/skills/remotion-to-hyperframes/scripts/tests/fixtures/blocker.tsx +50 -0
- package/.agents/skills/remotion-to-hyperframes/scripts/tests/fixtures/clean.tsx +46 -0
- package/.agents/skills/remotion-to-hyperframes/scripts/tests/smoke.sh +90 -0
- package/.agents/skills/seo-audit/SKILL.md +497 -0
- package/.agents/skills/seo-audit/evals/evals.json +136 -0
- package/.agents/skills/seo-audit/references/ai-writing-detection.md +200 -0
- package/.agents/skills/seo-audit/references/international-seo.md +230 -0
- package/README.md +4 -2
- package/SDK.md +64 -1
- package/dist/agents/coding.agent.d.ts +558 -0
- package/dist/agents/coding.agent.d.ts.map +1 -1
- package/dist/agents/coding.agent.js +8 -0
- package/dist/agents/coding.agent.js.map +1 -1
- package/dist/agents/developer-helper.agent.d.ts +712 -0
- package/dist/agents/developer-helper.agent.d.ts.map +1 -1
- package/dist/agents/developer-helper.agent.js +6 -0
- package/dist/agents/developer-helper.agent.js.map +1 -1
- package/dist/agents/docs-research.agent.d.ts +8 -0
- package/dist/agents/docs-research.agent.d.ts.map +1 -1
- package/dist/agents/finance.agent.d.ts +8 -0
- package/dist/agents/finance.agent.d.ts.map +1 -1
- package/dist/agents/manager.d.ts +837 -2
- package/dist/agents/manager.d.ts.map +1 -1
- package/dist/agents/manager.js +28 -0
- package/dist/agents/manager.js.map +1 -1
- package/dist/agents/security.agent.d.ts +165 -3
- package/dist/agents/security.agent.d.ts.map +1 -1
- package/dist/agents/security.agent.js +3 -0
- package/dist/agents/security.agent.js.map +1 -1
- package/dist/agents/swarm/main.js +1 -1
- package/dist/agents/swarm/main.js.map +1 -1
- package/dist/agents/swarm/registry.d.ts.map +1 -1
- package/dist/agents/swarm/registry.js +232 -26
- package/dist/agents/swarm/registry.js.map +1 -1
- package/dist/cli/doctor.d.ts +14 -0
- package/dist/cli/doctor.d.ts.map +1 -1
- package/dist/cli/doctor.js +91 -0
- package/dist/cli/doctor.js.map +1 -1
- package/dist/cli/menu.d.ts.map +1 -1
- package/dist/cli/menu.js +102 -0
- package/dist/cli/menu.js.map +1 -1
- package/dist/cli/setup.d.ts +10 -0
- package/dist/cli/setup.d.ts.map +1 -1
- package/dist/cli/setup.js +178 -0
- package/dist/cli/setup.js.map +1 -1
- package/dist/cli/swarm.d.ts +1 -0
- package/dist/cli/swarm.d.ts.map +1 -1
- package/dist/cli/swarm.js +47 -8
- package/dist/cli/swarm.js.map +1 -1
- package/dist/cli/theme.d.ts +0 -24
- package/dist/cli/theme.d.ts.map +1 -1
- package/dist/cli/theme.js +6 -2
- package/dist/cli/theme.js.map +1 -1
- package/dist/config/env.d.ts +10 -0
- package/dist/config/env.d.ts.map +1 -1
- package/dist/config/env.js +38 -17
- package/dist/config/env.js.map +1 -1
- package/dist/index.js +96 -5
- package/dist/index.js.map +1 -1
- package/dist/jobs/trigger-orchestrator.d.ts +5 -1
- package/dist/jobs/trigger-orchestrator.d.ts.map +1 -1
- package/dist/jobs/trigger-orchestrator.js +29 -9
- package/dist/jobs/trigger-orchestrator.js.map +1 -1
- package/dist/jobs/trigger-router.d.ts.map +1 -1
- package/dist/jobs/trigger-router.js +3 -2
- package/dist/jobs/trigger-router.js.map +1 -1
- package/dist/memory/corporate-wiki.d.ts +15 -0
- package/dist/memory/corporate-wiki.d.ts.map +1 -0
- package/dist/memory/corporate-wiki.js +152 -0
- package/dist/memory/corporate-wiki.js.map +1 -0
- package/dist/memory/scratchpad.d.ts +2 -0
- package/dist/memory/scratchpad.d.ts.map +1 -1
- package/dist/memory/scratchpad.js +27 -0
- package/dist/memory/scratchpad.js.map +1 -1
- package/dist/observability/doctor.d.ts.map +1 -1
- package/dist/observability/doctor.js +12 -4
- package/dist/observability/doctor.js.map +1 -1
- package/dist/observability/traces.d.ts +72 -0
- package/dist/observability/traces.d.ts.map +1 -0
- package/dist/observability/traces.js +1134 -0
- package/dist/observability/traces.js.map +1 -0
- package/dist/runtime/swarm.d.ts +1 -1
- package/dist/runtime/swarm.d.ts.map +1 -1
- package/dist/runtime/swarm.js +54 -25
- package/dist/runtime/swarm.js.map +1 -1
- package/dist/safety/approvals.d.ts +2 -2
- package/dist/safety/approvals.d.ts.map +1 -1
- package/dist/safety/approvals.js +47 -1
- package/dist/safety/approvals.js.map +1 -1
- package/dist/safety/redaction.d.ts.map +1 -1
- package/dist/safety/redaction.js +10 -0
- package/dist/safety/redaction.js.map +1 -1
- package/dist/tools/cloud.tool.d.ts +394 -0
- package/dist/tools/cloud.tool.d.ts.map +1 -0
- package/dist/tools/cloud.tool.js +784 -0
- package/dist/tools/cloud.tool.js.map +1 -0
- package/dist/tools/computer-use.tool.d.ts +2 -2
- package/dist/tools/corporate-wiki.tool.d.ts +22 -0
- package/dist/tools/corporate-wiki.tool.d.ts.map +1 -0
- package/dist/tools/corporate-wiki.tool.js +43 -0
- package/dist/tools/corporate-wiki.tool.js.map +1 -0
- package/dist/tools/devops.tool.d.ts +162 -0
- package/dist/tools/devops.tool.d.ts.map +1 -0
- package/dist/tools/devops.tool.js +377 -0
- package/dist/tools/devops.tool.js.map +1 -0
- package/dist/tools/multimedia.tool.d.ts +126 -0
- package/dist/tools/multimedia.tool.d.ts.map +1 -0
- package/dist/tools/multimedia.tool.js +533 -0
- package/dist/tools/multimedia.tool.js.map +1 -0
- package/dist/tools/osint.tool.d.ts +6 -6
- package/dist/tools/sandbox-dev.tool.d.ts +15 -0
- package/dist/tools/sandbox-dev.tool.d.ts.map +1 -0
- package/dist/tools/sandbox-dev.tool.js +146 -0
- package/dist/tools/sandbox-dev.tool.js.map +1 -0
- package/dist/tools/scratchpad.tool.d.ts +8 -0
- package/dist/tools/scratchpad.tool.d.ts.map +1 -1
- package/dist/tools/scratchpad.tool.js +40 -1
- package/dist/tools/scratchpad.tool.js.map +1 -1
- package/dist/tools/setup-assistant.tool.d.ts +1 -1
- package/dist/tools/swarm-ops.tool.d.ts +14 -0
- package/dist/tools/swarm-ops.tool.d.ts.map +1 -1
- package/dist/tools/swarm-ops.tool.js +47 -0
- package/dist/tools/swarm-ops.tool.js.map +1 -1
- package/dist/tools/sysops.tool.d.ts +157 -0
- package/dist/tools/sysops.tool.d.ts.map +1 -0
- package/dist/tools/sysops.tool.js +643 -0
- package/dist/tools/sysops.tool.js.map +1 -0
- package/dist/voice/deepgram.d.ts.map +1 -1
- package/dist/voice/deepgram.js +30 -2
- package/dist/voice/deepgram.js.map +1 -1
- package/package.json +8 -1
- package/scripts/release-github.mjs +23 -16
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
# doctor, browser
|
|
2
|
+
|
|
3
|
+
Environment diagnosis and bundled-Chrome management. Run these first when a render or preview fails.
|
|
4
|
+
|
|
5
|
+
## doctor
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npx hyperframes doctor
|
|
9
|
+
npx hyperframes doctor --json # CI / agent output (always exit 0; gate on payload `ok`)
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
Runs independent checks and reports each as ok/warn/fail:
|
|
13
|
+
|
|
14
|
+
- **Version** — installed CLI vs latest on npm (hints upgrade when stale)
|
|
15
|
+
- **Node.js** — ≥ 22 required
|
|
16
|
+
- **CPU**, **Memory**, **Disk** — host resources
|
|
17
|
+
- **Environment** — env vars that affect the renderer
|
|
18
|
+
- **FFmpeg** / **FFprobe** — found, version, codecs
|
|
19
|
+
- **Chrome** — bundled or system, version, path
|
|
20
|
+
- **Docker** / **Docker running** — required only for `render --docker`
|
|
21
|
+
- **/dev/shm** — inside containers only
|
|
22
|
+
|
|
23
|
+
Run `doctor` first when:
|
|
24
|
+
|
|
25
|
+
- `render` fails with a Chrome or FFmpeg error.
|
|
26
|
+
- `preview` opens but the composition fails to load.
|
|
27
|
+
- A fresh machine has never run HyperFrames.
|
|
28
|
+
|
|
29
|
+
Common issues:
|
|
30
|
+
|
|
31
|
+
- **Missing FFmpeg** — install via `brew install ffmpeg` (macOS) or your package manager.
|
|
32
|
+
- **Missing bundled Chrome** — run `npx hyperframes browser ensure`.
|
|
33
|
+
- **Low memory** — close other Chromes, reduce `--workers`, or use `--quality draft`.
|
|
34
|
+
|
|
35
|
+
## browser
|
|
36
|
+
|
|
37
|
+
```bash
|
|
38
|
+
npx hyperframes browser ensure # find or download the pinned Chrome
|
|
39
|
+
npx hyperframes browser path # print the browser executable path (for scripting)
|
|
40
|
+
npx hyperframes browser clear # remove the cached Chrome download
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
Manage the Chrome build HyperFrames uses for rendering. The pinned version exists because pixel output drifts across Chrome versions — using the bundled build keeps rendered output reproducible across machines.
|
|
44
|
+
|
|
45
|
+
Use `path` to embed the binary in scripts: `$(npx hyperframes browser path)`.
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
# init, capture, skills
|
|
2
|
+
|
|
3
|
+
Scaffolding commands. Use these instead of creating files by hand — they set up the right file structure, copy media, run transcription, and install AI coding skills.
|
|
4
|
+
|
|
5
|
+
## init
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npx hyperframes init my-video # TTY: interactive wizard
|
|
9
|
+
npx hyperframes init my-video --example warm-grain # pick an example
|
|
10
|
+
npx hyperframes init my-video --example blank --resolution portrait
|
|
11
|
+
npx hyperframes init my-video --video clip.mp4 # with video file
|
|
12
|
+
npx hyperframes init my-video --audio track.mp3 # with audio file
|
|
13
|
+
npx hyperframes init my-video --example blank --tailwind # Tailwind v4 browser runtime
|
|
14
|
+
npx hyperframes init my-video --non-interactive --example blank # CI/agents — flag-only
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
**Default depends on TTY**: in a terminal, the CLI prompts for example/options. Outside a TTY (CI, agents, piped output) it auto-switches to non-interactive and **requires `--example`** (the CLI errors with a usage example if missing). Pass `--non-interactive` to force flag-only mode even on a TTY.
|
|
18
|
+
|
|
19
|
+
Templates: `blank`, `warm-grain`, `play-mode`, `swiss-grid`, `vignelli`, `decision-tree`, `kinetic-type`, `product-promo`, `nyt-graph`.
|
|
20
|
+
|
|
21
|
+
Other useful flags:
|
|
22
|
+
|
|
23
|
+
- `--resolution` — preset: `landscape` (1920×1080), `portrait` (1080×1920), `landscape-4k`, `portrait-4k`, `square` (1080×1080), `square-4k`. Aliases: `1080p`, `4k`, `uhd`, `1080p-square`, `4k-square`.
|
|
24
|
+
- `--skip-skills` — don't install AI coding skills after scaffold.
|
|
25
|
+
- `--skip-transcribe` — don't auto-transcribe `--audio` / `--video` with Whisper.
|
|
26
|
+
- `--model`, `--language` — Whisper model / language for the auto-transcription.
|
|
27
|
+
|
|
28
|
+
When using `--tailwind`, invoke the `hyperframes-core` (Tailwind reference) skill before editing classes or theme tokens. The scaffold uses Tailwind v4 browser runtime patterns, not Studio's Tailwind v3 setup.
|
|
29
|
+
|
|
30
|
+
When `--audio` or `--video` is supplied, `init` transcribes the file with Whisper. For voice/model selection see the `hyperframes-media` skill.
|
|
31
|
+
|
|
32
|
+
## capture
|
|
33
|
+
|
|
34
|
+
```bash
|
|
35
|
+
npx hyperframes capture https://stripe.com # scaffold from a website
|
|
36
|
+
npx hyperframes capture https://linear.app -o linear-video # custom output directory
|
|
37
|
+
npx hyperframes capture https://example.com --json # JSON output for agents
|
|
38
|
+
npx hyperframes capture https://example.com --skip-assets # skip image/SVG download
|
|
39
|
+
npx hyperframes capture https://example.com --max-screenshots 12
|
|
40
|
+
npx hyperframes capture https://example.com --timeout 60000 # page-load timeout in ms
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
Captures a live URL as an editable HyperFrames project: screenshots become layered scenes, assets are downloaded locally, and the result is a normal project you can `lint` / `preview` / `render`. Use this when the user supplies a URL as the starting point for a video.
|
|
44
|
+
|
|
45
|
+
## skills
|
|
46
|
+
|
|
47
|
+
```bash
|
|
48
|
+
npx hyperframes skills # install HyperFrames skills for AI coding tools
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
One-time setup that adds the HyperFrames skill pack (`hyperframes-core`, `-creative`, `-animation`, `-cli`, `-registry`, `-media`, plus the `product-launch-video` and `hyperframes` orchestrators) to the local AI coding environment so agents follow the framework conventions. Re-run after major HyperFrames upgrades.
|
|
@@ -0,0 +1,132 @@
|
|
|
1
|
+
# lambda — Cloud Rendering on AWS Lambda
|
|
2
|
+
|
|
3
|
+
Deploy HyperFrames distributed rendering to AWS Lambda and drive renders from your laptop or CI. Wraps `@hyperframes/aws-lambda` SDK plus AWS SAM. End-to-end is three commands:
|
|
4
|
+
|
|
5
|
+
```bash
|
|
6
|
+
npx hyperframes lambda deploy
|
|
7
|
+
npx hyperframes lambda render ./my-project --width 1920 --height 1080 --wait
|
|
8
|
+
npx hyperframes lambda destroy
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## When to Use Lambda vs Local Render
|
|
12
|
+
|
|
13
|
+
- **Local `render`** — dev-loop iteration, single host, anything under a few minutes at 1080p.
|
|
14
|
+
- **`lambda render`** — long videos, 4K, large parallel batches, or anything where local Chrome would time out / exhaust RAM. Pay-per-invocation, no idle cost.
|
|
15
|
+
|
|
16
|
+
For one-off short renders Lambda is not worth the deploy overhead.
|
|
17
|
+
|
|
18
|
+
## Prerequisites
|
|
19
|
+
|
|
20
|
+
- AWS credentials configured (env vars, `~/.aws/credentials`, SSO, or IMDS).
|
|
21
|
+
- AWS SAM CLI on `PATH`.
|
|
22
|
+
- `bun` on `PATH` (builds the Lambda handler ZIP).
|
|
23
|
+
|
|
24
|
+
## Subcommands
|
|
25
|
+
|
|
26
|
+
### deploy
|
|
27
|
+
|
|
28
|
+
```bash
|
|
29
|
+
npx hyperframes lambda deploy \
|
|
30
|
+
--stack-name=hyperframes-prod \
|
|
31
|
+
--region=us-east-1 \
|
|
32
|
+
--concurrency=8 \
|
|
33
|
+
--memory=10240
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
Builds `packages/aws-lambda/dist/handler.zip` and SAM-deploys the stack (Lambda + Step Functions + S3 + IAM). Idempotent — re-running on the same `--stack-name` is a no-op when nothing changed. Writes `<cwd>/.hyperframes/lambda-stack-<name>.json` so later subcommands don't need to call `describe-stacks`.
|
|
37
|
+
|
|
38
|
+
| Flag | Default | Description |
|
|
39
|
+
| --------------- | ------------------------------- | ----------------------------- |
|
|
40
|
+
| `--stack-name` | `hyperframes-default` | CloudFormation stack name |
|
|
41
|
+
| `--region` | `AWS_REGION` env or `us-east-1` | AWS region |
|
|
42
|
+
| `--profile` | `AWS_PROFILE` env | Named AWS credentials profile |
|
|
43
|
+
| `--concurrency` | `8` | Lambda reserved concurrency |
|
|
44
|
+
| `--memory` | `10240` | Lambda memory in MB |
|
|
45
|
+
| `--skip-build` | off | Reuse existing `handler.zip` |
|
|
46
|
+
|
|
47
|
+
### sites create
|
|
48
|
+
|
|
49
|
+
```bash
|
|
50
|
+
npx hyperframes lambda sites create ./my-project
|
|
51
|
+
# → siteId: abc1234deadbeef0 (stable across re-runs of the same tree)
|
|
52
|
+
|
|
53
|
+
npx hyperframes lambda render ./my-project --site-id=abc1234deadbeef0 ...
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
Tars + uploads `<projectDir>` to S3 with a content-addressed key. Returns a stable `siteId` you can reuse — re-renders of the same tree skip the upload.
|
|
57
|
+
|
|
58
|
+
### render
|
|
59
|
+
|
|
60
|
+
```bash
|
|
61
|
+
npx hyperframes lambda render ./my-project \
|
|
62
|
+
--width 1920 --height 1080 --fps 30 --format mp4 \
|
|
63
|
+
--chunk-size 240 --max-parallel-chunks 16 \
|
|
64
|
+
--wait
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
Starts a Step Functions execution. Returns immediately with a `renderId` unless `--wait` is set, in which case the CLI blocks until completion and streams per-chunk progress lines. Add `--json` for machine-parseable output.
|
|
68
|
+
|
|
69
|
+
| Flag | Description |
|
|
70
|
+
| ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
71
|
+
| `--width` / `--height` | Output dimensions in pixels |
|
|
72
|
+
| `--output-resolution` | Supersampling preset (engages Chrome `deviceScaleFactor`) — `landscape` / `landscape-4k` / `portrait` / `portrait-4k` / `square` / `square-4k`, plus aliases (`1080p`, `4k`, `uhd`, `hd`, `1080p-portrait`, `4k-portrait`, `1080p-square`, `4k-square`). Use this to render an authored-at-1080p composition at 4K without re-laying-out — see footgun below. |
|
|
73
|
+
| `--fps` | `24` / `30` / `60` |
|
|
74
|
+
| `--format` | `mp4` / `mov` / `png-sequence` (default `mp4`) |
|
|
75
|
+
| `--codec` | `h264` / `h265` (mp4 only) |
|
|
76
|
+
| `--quality` | `draft` / `standard` / `high` |
|
|
77
|
+
| `--chunk-size` | Frames per chunk (default `240`) |
|
|
78
|
+
| `--max-parallel-chunks` | Max concurrent chunks (default `16`) |
|
|
79
|
+
| `--site-id` | Reuse an existing site (skip upload) |
|
|
80
|
+
| `--wait` | Block until completion, stream progress |
|
|
81
|
+
| `--json` | Machine-parseable progress snapshot |
|
|
82
|
+
|
|
83
|
+
**`--width` / `--height` footgun.** Setting `--width 3840 --height 2160` against a composition whose `data-width="1920"` silently produces 1080p — the runtime lays out the page at the composition's authored dimensions and the CLI flags are ignored for layout. To actually output at 4K, use `--output-resolution 4k` (supersamples via `deviceScaleFactor`). The CLI now prints a warning when CLI dimensions disagree with the composition's `data-width` / `data-height` and `--output-resolution` is not set; the warning is suppressed when `--json` is on or `index.html` isn't on disk (`--site-id` flows).
|
|
84
|
+
|
|
85
|
+
### progress
|
|
86
|
+
|
|
87
|
+
```bash
|
|
88
|
+
npx hyperframes lambda progress hf-render-abcd1234
|
|
89
|
+
npx hyperframes lambda progress arn:aws:states:us-east-1:...:execution:...
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
Prints one snapshot — overall percent, frames rendered, Lambda invocations, accrued cost, and any errors. Accepts a bare `renderId` (resolved against the stack's state-machine ARN) or a full SFN execution ARN.
|
|
93
|
+
|
|
94
|
+
### destroy
|
|
95
|
+
|
|
96
|
+
```bash
|
|
97
|
+
npx hyperframes lambda destroy
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
Calls `sam delete --no-prompts` and drops the local state file. **The render S3 bucket is configured `Retain`** so it survives stack destruction — empty + delete it via the AWS console / CLI if you want the storage back.
|
|
101
|
+
|
|
102
|
+
### Non-retryable errors
|
|
103
|
+
|
|
104
|
+
A subset of failures the Step Functions state machine short-circuits instead of running through its 4× 15-min retry budget. `progress` surfaces these immediately with the error class name; do not re-issue `lambda render` blindly when you see one.
|
|
105
|
+
|
|
106
|
+
- **`ChromeBinaryUnavailableError`** — `@sparticuz/chromium` returned an empty/missing executable path. A prior chunk hit `Sandbox.Timedout` mid-extraction and the warm instance is wedged until the execution environment recycles. Remedy: bump a Lambda env var (forces a new exec env) or `lambda deploy` again. Not a transient render failure; retries will burn budget on the same wedged instance.
|
|
107
|
+
- **`FFMPEG_VERSION_MISMATCH`** / **`PLAN_HASH_MISMATCH`** — planner / executor version drift. Re-deploy.
|
|
108
|
+
|
|
109
|
+
### policies
|
|
110
|
+
|
|
111
|
+
Print or validate the minimum IAM permissions the CLI needs.
|
|
112
|
+
|
|
113
|
+
```bash
|
|
114
|
+
npx hyperframes lambda policies user # inline policy for an IAM user
|
|
115
|
+
npx hyperframes lambda policies role --principal=cloudformation # { TrustRelationship, InlinePolicy }
|
|
116
|
+
npx hyperframes lambda policies validate ./infra/iam/hf-deploy.json # CI gate
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
`validate` reads a JSON policy doc and checks the union of its `Effect: Allow` actions (expanding `s3:*` / `s3:Get*` / `*` wildcards) against the CLI's required action set. Missing actions print to stderr; the command exits non-zero. Wire it into CI to catch policy drift before the next deploy fails.
|
|
120
|
+
|
|
121
|
+
The default action set is deliberately broad (`Resource: "*"`) because CloudFormation creates new ARNs on every adopter's first deploy. Tighten `Resource` after that first run if security posture requires it.
|
|
122
|
+
|
|
123
|
+
## State Files
|
|
124
|
+
|
|
125
|
+
`hyperframes lambda` stores per-stack metadata under `<cwd>/.hyperframes/lambda-stack-<name>.json` (bucket name, state-machine ARN, region). Not secret, but AWS-account-identifying. Commit it to a repo or `.gitignore` it per your workflow.
|
|
126
|
+
|
|
127
|
+
## Cost and Cleanup
|
|
128
|
+
|
|
129
|
+
- `lambda destroy` removes the SAM stack but **leaves the S3 bucket** (`Retain`). Delete it manually if you want the storage back.
|
|
130
|
+
- Lambda billing is per-invocation + duration. `progress` reports the accrued cost.
|
|
131
|
+
- `--concurrency` caps parallel Lambda invocations — keep it aligned with your account quota.
|
|
132
|
+
- `--chunk-size` and `--max-parallel-chunks` trade off per-chunk overhead against parallelism; larger chunks reduce coordinator overhead, smaller chunks parallelize more aggressively.
|
|
@@ -0,0 +1,121 @@
|
|
|
1
|
+
# lint, validate, inspect, snapshot
|
|
2
|
+
|
|
3
|
+
The correctness pipeline. Run in this order: `lint` (static, fast) → `validate` (runtime, headless Chrome) → `inspect` (layout sweep). `snapshot` is a separate utility for capturing still frames.
|
|
4
|
+
|
|
5
|
+
## Discipline (motion-heavy work)
|
|
6
|
+
|
|
7
|
+
When the composition is animation-driven, run the checks before you reach for `preview` or `render`:
|
|
8
|
+
|
|
9
|
+
- Run `lint` after the first HTML pass — earlier, not later.
|
|
10
|
+
- Capture `snapshot` at meaningful timeline states; look at the PNGs.
|
|
11
|
+
- Inspect snapshots _before_ tuning automated warnings — your eye catches what the auditor misses.
|
|
12
|
+
- Treat layout warnings as defects unless a snapshot proves the overflow is intentional, in which case mark it with `data-layout-allow-overflow`.
|
|
13
|
+
- State motion intent in a `*.motion.json` sidecar so `inspect` checks it automatically — entrances firing under seek, stagger order, in-frame, liveness. This is the closest automated proxy for "watch the MP4" and catches render-≠-preview bugs the eye misses (see **Motion verification** below).
|
|
14
|
+
|
|
15
|
+
## lint
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
npx hyperframes lint # current directory
|
|
19
|
+
npx hyperframes lint ./my-project # specific project
|
|
20
|
+
npx hyperframes lint --verbose # info-level findings
|
|
21
|
+
npx hyperframes lint --json # machine-readable
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
Lints `index.html` and all files in `compositions/`. Reports errors (must fix), warnings (should fix), and info (with `--verbose`). Catches missing `data-composition-id`, overlapping tracks on the same `data-track-index`, and unregistered timelines.
|
|
25
|
+
|
|
26
|
+
**Blind spot — media inside a sub-composition (not yet a lint rule).** A `<video>`/`<audio>` inside a `compositions/*.html` `<template>` (or nested in a wrapper `<div>` anywhere) is never seeked/decoded and renders blank/black; `lint`/`validate`/`inspect` all pass. Media must be a direct child of the host root (`index.html`) — see `hyperframes-core` → `variables-and-media.md`. Until a rule exists, check manually before render:
|
|
27
|
+
|
|
28
|
+
```bash
|
|
29
|
+
grep -nE '<(video|audio)\b' compositions/*.html # expect NO matches; media belongs in index.html
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
A non-empty result is a defect. Then `snapshot` each scene that has a video and confirm the panel actually shows footage (a blank/black panel where a clip should play is a bug, not a placeholder — treat it as render-blocking).
|
|
33
|
+
|
|
34
|
+
## validate
|
|
35
|
+
|
|
36
|
+
```bash
|
|
37
|
+
npx hyperframes validate # current directory
|
|
38
|
+
npx hyperframes validate ./my-project # specific project
|
|
39
|
+
npx hyperframes validate --json # agent-readable findings
|
|
40
|
+
npx hyperframes validate --timeout 5000 # ms to wait for scripts (default 3000)
|
|
41
|
+
npx hyperframes validate --no-contrast # skip WCAG contrast audit while iterating
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
Static lint is fast but blind to runtime failures. `validate` loads the composition in headless Chrome, plays through it, and reports:
|
|
45
|
+
|
|
46
|
+
- JavaScript console errors and unhandled exceptions
|
|
47
|
+
- Failed network requests (media-file `ERR_ABORTED` filtered out)
|
|
48
|
+
- WCAG AA contrast violations on visible text — sampled at 5 timestamps across the timeline. Disable with `--no-contrast`.
|
|
49
|
+
|
|
50
|
+
**Fixing contrast warnings** — thresholds are 4.5:1 for normal text, 3:1 for large text (24px+, or 19px+ bold):
|
|
51
|
+
|
|
52
|
+
- On dark backgrounds, brighten the failing color until it clears the threshold; on light backgrounds, darken it.
|
|
53
|
+
- Stay within the palette family — don't invent a new color, adjust the existing one.
|
|
54
|
+
- Re-run `validate` until clean.
|
|
55
|
+
|
|
56
|
+
Run `validate` before `inspect` when an animation has scripts, fetched data, or theming. Combine with `render --strict` in CI.
|
|
57
|
+
|
|
58
|
+
## inspect
|
|
59
|
+
|
|
60
|
+
```bash
|
|
61
|
+
npx hyperframes inspect # inspect rendered layout over the timeline
|
|
62
|
+
npx hyperframes inspect ./my-project # specific project
|
|
63
|
+
npx hyperframes inspect --json # agent-readable findings (schemaVersion, samples, issues, bboxes)
|
|
64
|
+
npx hyperframes inspect --samples 15 # denser timeline sweep (default 9)
|
|
65
|
+
npx hyperframes inspect --at 1.5,4,7.25 # explicit hero-frame timestamps
|
|
66
|
+
npx hyperframes inspect --tolerance 4 # allowed overflow in px before reporting (default 2)
|
|
67
|
+
npx hyperframes inspect --strict # exit non-zero on warnings too (default: only errors)
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
Use this after `lint` and `validate`, especially for compositions with speech bubbles, cards, captions, or tight typography. It reports:
|
|
71
|
+
|
|
72
|
+
- Text extending outside the nearest visual container or bubble
|
|
73
|
+
- Text clipped by its own fixed-width/fixed-height box
|
|
74
|
+
- Text extending outside the composition canvas
|
|
75
|
+
- Children escaping clipping containers
|
|
76
|
+
|
|
77
|
+
Errors should be fixed before rendering. Warnings are surfaced for agent review; add `--strict` to fail on warnings too. Repeated static issues are collapsed by default so JSON output stays compact for LLM context windows.
|
|
78
|
+
|
|
79
|
+
**Escape hatches:**
|
|
80
|
+
|
|
81
|
+
- `data-layout-allow-overflow` — mark an element or ancestor when overflow is intentional for an entrance/exit animation.
|
|
82
|
+
- `data-layout-ignore` — mark a decorative element that should never be audited.
|
|
83
|
+
|
|
84
|
+
`npx hyperframes layout` remains available as a compatibility alias for the same visual inspection pass.
|
|
85
|
+
|
|
86
|
+
### Motion verification (`*.motion.json` sidecar)
|
|
87
|
+
|
|
88
|
+
`inspect` also checks **motion intent** against the same seeked timeline the renderer uses — the closest automated proxy for "render the MP4 and watch it". It catches render-≠-preview bugs layout sampling can't: an entrance reveal the seek lands past, a broken stagger order, an element drifting off-frame mid-tween, a frozen shot.
|
|
89
|
+
|
|
90
|
+
Drop a `*.motion.json` sidecar next to the composition (matching the html basename when several compositions share a dir). `inspect` discovers it automatically — no flag, no authoring-framework changes. With no sidecar, `inspect` behaves exactly as before.
|
|
91
|
+
|
|
92
|
+
```json
|
|
93
|
+
{
|
|
94
|
+
"duration": 6,
|
|
95
|
+
"assertions": [
|
|
96
|
+
{ "kind": "appearsBy", "selector": "#headline", "bySec": 0.5 },
|
|
97
|
+
{ "kind": "before", "a": "#headline", "b": "#cta" },
|
|
98
|
+
{ "kind": "staysInFrame", "selector": ".card" },
|
|
99
|
+
{ "kind": "keepsMoving", "withinSelector": ".scene" }
|
|
100
|
+
]
|
|
101
|
+
}
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
| Assertion | Fails (code) when |
|
|
105
|
+
| ------------------------------ | --------------------------------------------------------------------------- |
|
|
106
|
+
| `appearsBy(selector, bySec)` | not visible (opacity ≥ 0.5) by `bySec` — `motion_appears_late` |
|
|
107
|
+
| `before(a, b)` | `a` does not first appear strictly before `b` — `motion_out_of_order` |
|
|
108
|
+
| `staysInFrame(selector)` | once visible, its box leaves the canvas — `motion_off_frame` |
|
|
109
|
+
| `keepsMoving(withinSelector?)` | a fully-static window exceeds `maxStaticSec` (default 2s) — `motion_frozen` |
|
|
110
|
+
|
|
111
|
+
`duration`, `withinSelector`, and `maxStaticSec` are optional. Findings are **errors by default** (a failed assertion fails the run, like a layout error — `--strict` still gates warnings) and appear in the same human and `--json` output as layout findings. A selector that matches nothing is reported as `motion_selector_missing` rather than silently passing — so a typo'd selector fails loudly. Use this in the feedback loop instead of eyeballing the render: assert what the motion is supposed to do, and let `inspect` tell you when the seek diverges from intent.
|
|
112
|
+
|
|
113
|
+
## snapshot
|
|
114
|
+
|
|
115
|
+
```bash
|
|
116
|
+
npx hyperframes snapshot # 5 key frames as PNG
|
|
117
|
+
npx hyperframes snapshot ./my-project # specific project
|
|
118
|
+
npx hyperframes snapshot --frames 10 # evenly-spaced N frames
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
Captures still PNGs from the composition for visual diffing, thumbnails, or attaching to a PR. Faster than rendering a video when you only need a few hero frames. Output lands in the project's snapshots directory.
|
|
@@ -0,0 +1,109 @@
|
|
|
1
|
+
# preview, play, render, publish
|
|
2
|
+
|
|
3
|
+
Serve, render, and share commands.
|
|
4
|
+
|
|
5
|
+
## preview
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npx hyperframes preview # serve current directory
|
|
9
|
+
npx hyperframes preview --port 4567 # custom port (default 3002)
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
Hot-reloads on file changes. Opens Studio in the browser automatically — the full timeline editor, where the user can play the video and edit anything by hand before rendering. This is the review surface, not just a viewer.
|
|
13
|
+
|
|
14
|
+
When handing a project back to the user, use the Studio project URL, not the source `index.html` path:
|
|
15
|
+
|
|
16
|
+
```text
|
|
17
|
+
http://localhost:<port>/#project/<project-name>
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
Use the actual port and project directory name; treat `index.html` as source-code context, not the preview surface. For example, after `npx hyperframes preview --port 3017` in `codex-openai-video`, report `http://localhost:3017/#project/codex-openai-video`.
|
|
21
|
+
|
|
22
|
+
## play (lightweight player)
|
|
23
|
+
|
|
24
|
+
```bash
|
|
25
|
+
npx hyperframes play # current project, port 3003
|
|
26
|
+
npx hyperframes play ./my-video # specific project
|
|
27
|
+
npx hyperframes play --port 8080 # custom port
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
`play` serves the composition through the embeddable `<hyperframes-player>` web component instead of the full Studio UI. Use it when sharing a preview link or when Studio is heavier than needed (no editor, no panels). `play` reports the plain `http://localhost:<port>` URL — no `#project/<name>` fragment (that's a Studio routing convention only `preview` uses).
|
|
31
|
+
|
|
32
|
+
The player's `playback-rate` attribute (preview speed control, drives the timeline's `timeScale`) is clamped to `[0.1, 5]`; values `≤ 0` or non-finite fall back to `1`. This is a preview/playback knob, not a composition `data-*` attribute — authored motion still renders at `1×`.
|
|
33
|
+
|
|
34
|
+
### Launching with an external browser (preview + play)
|
|
35
|
+
|
|
36
|
+
Both `preview` and `play` can open inside an explicit Chromium-compatible browser instead of the OS default. Two use cases: isolated Chromium profile, or external CDP attach (DevTools / Playwright / Puppeteer / browser-MCP). **HyperFrames itself does not own CDP automation** — this only exposes the endpoint; whatever connects to it is your problem. Not to be confused with `--browser-gpu` (a `render` flag controlling Chrome GPU access during capture).
|
|
37
|
+
|
|
38
|
+
| Flag | Type | Notes |
|
|
39
|
+
| ------------------------- | --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
40
|
+
| `--browser-path` | path | Absolute path to a Chromium-compatible executable (`/usr/bin/chromium`, `/Applications/Brave Browser.app/...`). |
|
|
41
|
+
| `--user-data-dir` | path | Chromium-compatible profile directory. Requires `--browser-path`. Use a throwaway directory to keep state out of your main profile. |
|
|
42
|
+
| `--remote-debugging-port` | integer 1-65535 | Open a Chromium CDP endpoint on the given port. **Requires both** `--browser-path` and `--user-data-dir` — refused otherwise, so a CDP endpoint cannot leak into your main profile by accident. |
|
|
43
|
+
|
|
44
|
+
```bash
|
|
45
|
+
# Open preview in an isolated Chromium profile
|
|
46
|
+
npx hyperframes preview --browser-path /usr/bin/chromium --user-data-dir /tmp/hf-profile
|
|
47
|
+
|
|
48
|
+
# Same plus a CDP endpoint on :9222 (attach DevTools / Playwright / etc.)
|
|
49
|
+
npx hyperframes play --browser-path /usr/bin/chromium --user-data-dir /tmp/hf-profile --remote-debugging-port 9222
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
Validation runs before any server boots, so an invalid value exits cleanly without leaving a listening socket behind.
|
|
53
|
+
|
|
54
|
+
## render
|
|
55
|
+
|
|
56
|
+
> Render only after the user has reviewed in `preview` and approved. Don't auto-render when the checks pass.
|
|
57
|
+
|
|
58
|
+
```bash
|
|
59
|
+
npx hyperframes render # standard MP4 from cwd
|
|
60
|
+
npx hyperframes render ./my-video --output ./out.mp4 # render from outside the project dir
|
|
61
|
+
npx hyperframes render --output final.mp4 # named output (no timestamp)
|
|
62
|
+
npx hyperframes render -c compositions/intro.html -o intro.mp4 # render a specific sub-composition file
|
|
63
|
+
npx hyperframes render --quality draft # fast iteration
|
|
64
|
+
npx hyperframes render --fps 60 --quality high # final delivery
|
|
65
|
+
npx hyperframes render --format webm # transparent WebM
|
|
66
|
+
npx hyperframes render --docker # byte-identical
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
> Default `--output` is `renders/<project-name>_<YYYY-MM-DD>_<HH-MM-SS>.<ext>` — timestamped per render so successive runs don't clobber each other. Pass `--output` to get a stable name.
|
|
70
|
+
|
|
71
|
+
| Flag | Options | Default | Notes |
|
|
72
|
+
| ------------------------------------ | -------------------------------------------------------------------------------------------------- | ------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
73
|
+
| `dir` (positional) | path | cwd | Project directory. Omit to use current working directory. |
|
|
74
|
+
| `--composition`, `-c` | path to composition file | `index.html` | Render a specific composition file (e.g. `compositions/intro.html`) instead of the project's `index.html`. |
|
|
75
|
+
| `--output`, `-o` | path | `renders/<project>_<ts>.<ext>` | Output path. Default is timestamped (`<project-name>_YYYY-MM-DD_HH-MM-SS.<ext>`). |
|
|
76
|
+
| `--fps` | 24, 30, 60 | 30 | 60fps doubles render time |
|
|
77
|
+
| `--quality` | draft, standard, high | standard | draft for iterating |
|
|
78
|
+
| `--format` | mp4, webm, mov, gif, png-sequence | mp4 | WebM/MOV render with transparency; gif for inline autoplay in GitHub PRs/READMEs/docs (two-pass palette encode, fps capped at 30 — prefer `--fps 15` — no audio, 1-bit transparency only, HDR falls back to SDR); png-sequence writes RGBA frames to a directory (AE/Nuke/Fusion ingest) |
|
|
79
|
+
| `--gif-loop` | 0-65535 | 0 | GIF loop count; `0` loops forever. Only with `--format gif`. |
|
|
80
|
+
| `--resolution` | landscape, portrait, landscape-4k, portrait-4k, square, square-4k (+ aliases `1080p`, `4k`, `uhd`) | — | Supersample via Chrome `deviceScaleFactor`. Aspect ratio must match composition; scale must be an integer. Not with `--hdr`. |
|
|
81
|
+
| `--crf` | 0-51 | — | Encoder CRF (lower = higher quality). Mutually exclusive with `--video-bitrate`. |
|
|
82
|
+
| `--video-bitrate` | e.g. `10M`, `5000k` | — | Target bitrate. Mutually exclusive with `--crf`. |
|
|
83
|
+
| `--hdr` | flag | off | Force HDR output even with SDR sources. MP4 only. |
|
|
84
|
+
| `--sdr` | flag | off | Force SDR even with HDR sources. |
|
|
85
|
+
| `--workers` | number or `auto` | auto | Each worker spawns Chrome (~256 MB) |
|
|
86
|
+
| `--docker` | flag | off | Reproducible output across hosts |
|
|
87
|
+
| `--gpu` | flag | off | GPU-accelerated FFmpeg encoding (NVENC / VideoToolbox / VAAPI / QSV) |
|
|
88
|
+
| `--browser-gpu` / `--no-browser-gpu` | flag | auto (local), off (docker) | Host GPU for Chrome/WebGL capture |
|
|
89
|
+
| `--browser-timeout` | seconds (0.001–86400) | 60 | Puppeteer page-navigation timeout for the entry HTML. Raise when heavy compositions (many videos / fonts / remote assets) can't reach `domcontentloaded` within the 60s default. |
|
|
90
|
+
| `--quiet` | flag | off | Suppress verbose output |
|
|
91
|
+
| `--strict` | flag | off | Fail on lint errors |
|
|
92
|
+
| `--strict-all` | flag | off | Fail on lint errors AND warnings |
|
|
93
|
+
| `--variables` | JSON object | — | Override values declared in `data-composition-variables` |
|
|
94
|
+
| `--variables-file` | path | — | JSON file with variable values (alternative to `--variables`) |
|
|
95
|
+
| `--strict-variables` | flag | off | Fail render on undeclared keys or type mismatches in `--variables` |
|
|
96
|
+
|
|
97
|
+
**Quality guidance:** `draft` while iterating, `standard` for review, `high` for final delivery.
|
|
98
|
+
|
|
99
|
+
**Parametrized renders:** the composition declares its variables on the `<html>` root with **`data-composition-variables`** — a JSON **array of declarations** (`{id, type, label, default}` per entry) that defines the schema. Scripts inside read the resolved values via `window.__hyperframes.getVariables()`. The CLI `--variables '{"title":"Q4 Report"}'` is a JSON **object keyed by id** that overrides those declared defaults for one render; missing keys fall through, so the same composition runs unchanged in dev preview and in production. Sub-comp hosts can also override per-instance with `data-variable-values`. See the `hyperframes-core` skill for the full pattern.
|
|
100
|
+
|
|
101
|
+
## publish
|
|
102
|
+
|
|
103
|
+
```bash
|
|
104
|
+
npx hyperframes publish # upload current project, return public URL
|
|
105
|
+
npx hyperframes publish ./my-video # specific project
|
|
106
|
+
npx hyperframes publish --yes # skip the confirmation prompt (scripts/CI)
|
|
107
|
+
```
|
|
108
|
+
|
|
109
|
+
Uploads the project's source (HTML + assets) and returns a stable public URL that renders in the browser. Use this for sharing a draft for review before rendering MP4, or for embedding the composition elsewhere. Lint findings are surfaced before upload but do not block.
|
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
# info, upgrade, compositions, docs, benchmark, telemetry, asset preprocessing
|
|
2
|
+
|
|
3
|
+
Catch-all reference for commands that don't fit the main dev loop.
|
|
4
|
+
|
|
5
|
+
## info
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npx hyperframes info # project metadata
|
|
9
|
+
npx hyperframes info ./my-video # specific project
|
|
10
|
+
npx hyperframes info --json
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Prints **project** metadata: name, resolution, duration, element counts by type, track count, and total project size. Project-level — not environment. For environment health use `doctor`.
|
|
14
|
+
|
|
15
|
+
## upgrade
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
npx hyperframes upgrade # check + interactive prompt
|
|
19
|
+
npx hyperframes upgrade --check # check and exit, no prompt (agent-friendly)
|
|
20
|
+
npx hyperframes upgrade --check --json # machine-readable: current / latest / updateAvailable
|
|
21
|
+
npx hyperframes upgrade --yes # print upgrade commands without prompting
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
Compares the installed CLI version against npm latest.
|
|
25
|
+
|
|
26
|
+
## compositions, docs
|
|
27
|
+
|
|
28
|
+
```bash
|
|
29
|
+
npx hyperframes compositions # list compositions in project
|
|
30
|
+
npx hyperframes compositions --json
|
|
31
|
+
npx hyperframes docs # list available topics
|
|
32
|
+
npx hyperframes docs rendering # print one topic inline in the terminal
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
`compositions` lists every `data-composition-id` in the project (including sub-comps) with duration, resolution, and element count.
|
|
36
|
+
|
|
37
|
+
`docs` prints inline documentation **in the terminal** — it does not open a browser. Topics: `data-attributes`, `examples`, `rendering`, `gsap`, `troubleshooting`, `compositions`. Run without a topic to see the list.
|
|
38
|
+
|
|
39
|
+
## benchmark
|
|
40
|
+
|
|
41
|
+
```bash
|
|
42
|
+
npx hyperframes benchmark # run the preset matrix in current project
|
|
43
|
+
npx hyperframes benchmark ./my-video # specific project
|
|
44
|
+
npx hyperframes benchmark --runs 5 # repeat each config N times (default 3)
|
|
45
|
+
npx hyperframes benchmark --json
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
Renders the project with 5 preset configurations — `30fps draft 2w`, `30fps standard 2w`, `30fps high 2w`, `30fps standard 4w`, `60fps standard 4w` — and prints a comparison of render speed and output file size. Use it to find the fastest acceptable preset for your machine. Not a single-render-with-stage-breakdown.
|
|
49
|
+
|
|
50
|
+
## telemetry
|
|
51
|
+
|
|
52
|
+
```bash
|
|
53
|
+
npx hyperframes telemetry status # show telemetry state
|
|
54
|
+
npx hyperframes telemetry disable # disable anonymous usage telemetry
|
|
55
|
+
npx hyperframes telemetry enable # re-enable telemetry
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
Telemetry is anonymous usage counters only. Disable globally with `HYPERFRAMES_NO_TELEMETRY=1` if env-var control is preferred over the subcommand.
|
|
59
|
+
|
|
60
|
+
Events include two fingerprint properties used to distinguish managed-sandbox runs from real laptops — no PII, no env-var **values**, only existence checks:
|
|
61
|
+
|
|
62
|
+
- **`sandbox_runtime`**: `gvisor` / `firecracker` / `docker` / `kvm` / `wsl` / `null`. gVisor via kernel string + `/proc/version`. Firecracker via `/dev/vsock` + DMI sys_vendor. Docker via `/.dockerenv` + cgroup.
|
|
63
|
+
- **`agent_runtime`**: `claude_code` / `codex` / `cursor` / `copilot_agent` / `jules` / `replit` / `devin` / `aider` / `gemini_cli` / `hermes` / `openclaw` / `null`. Detected by the existence of well-known vendor env vars; the values themselves are never read.
|
|
64
|
+
|
|
65
|
+
## Asset Preprocessing
|
|
66
|
+
|
|
67
|
+
```bash
|
|
68
|
+
npx hyperframes tts
|
|
69
|
+
npx hyperframes transcribe
|
|
70
|
+
npx hyperframes remove-background
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
These produce assets (narration audio, word-level transcripts, transparent video) that get dropped into a composition. Each may download its own model on first run.
|
|
74
|
+
|
|
75
|
+
For voice selection, Whisper model rules, output format choice, and the TTS → transcript → captions chain, invoke the `hyperframes-media` skill. This skill stays focused on the dev loop.
|