HyperFrames CLI
所有操作都通过 npx hyperframes 执行,除非项目说明指定了本地包装器(wrapper)。必须严格遵守本地包装器的指示。需要 Node.js >= 22 和 FFmpeg。
工作流
- 脚手架搭建 —
npx hyperframes init my-video(或从 URL 执行capture) - 编写 — 编写 HTML 合成(参见
hyperframes-core技能) - 代码检查 —
npx hyperframes lint - 验证 —
npx hyperframes validate(运行时错误 + 对比度) - 可视化检查 —
npx hyperframes inspect - 预览 —
npx hyperframes preview打开 Studio,这是一个时间线编辑器,用户可以在其中手动编辑任何内容(而不仅仅是观看)。在此处审查,然后请求进行渲染。 - 渲染 — 选择变体:
- 迭代:
npx hyperframes render --quality draft - 交付:
npx hyperframes render --quality high --output out.mp4 - CI / 跨主机复现:
npx hyperframes render --docker --strict --output out.mp4 - 云(长/大型):
npx hyperframes lambda render ./my-project --width 1920 --height 1080 --wait(参见下面的 Lambda)
- 迭代:
在预览之前运行 lint、validate 和 inspect。lint 可捕获缺失的 data-composition-id、重叠轨道以及未注册的时间线。validate 在无头 Chrome 中加载合成,并报告运行时控制台错误以及 WCAG 对比度问题。inspect 会遍历时间线,并报告文本溢出气泡/容器或画布的情况——并且,当存在 *.motion.json 伴生文件时,它会根据相同的遍历时间线验证运动意图(入场在 seek 时触发、交错顺序、在帧内、活跃性)。
对于运动密集型工作,建议优先使用基于快照(snapshot)的迭代和 *.motion.json 伴生文件——有关规范和实践,请参阅 references/lint-validate-inspect.md。
代理约定
适用于每个命令的交叉规则:
--json在所有命令上都可用,但render、preview和play除外。 对于任何代理/CI 调用的支持命令,请使用它;输出包含一个_meta信封(cli 版本、最新可用版本、更新建议)。render仅通过 stdout + 退出码报告状态——通过下面的渲染后检查验证成功;preview/play是服务器,不支持 JSON。doctor --json始终以 0 退出,即使环境已损坏。通过检查载荷的ok字段来判定:npx hyperframes doctor --json | jq -e '.ok' > /dev/null。这可以使流水线免受 CLI 版本更新的影响。- 非 TTY 模式是自动检测的。 当
stdout不是 TTY(CI、代理、管道输出)时,CLI 会自动切换到非交互模式;此时init需要--example。传递--non-interactive以在 TTY 上强制启用此模式。 - CI 渲染门控:
--strict在 lint 错误时失败,--strict-all在警告时也失败,--strict-variables在未声明的--variables键上失败。 --json中的路径会被清除 —$HOME变成字面量$HOME,以便输出可以安全地粘贴到错误报告和代理上下文中。- 渲染需用户许可。 检查通过后绝不要自动渲染。在
preview处暂停,告知用户视频在 Studio 中可编辑,并且仅在他们批准后才渲染。 - 渲染后验证。 在
render返回退出码 0 后,请确认输出文件存在且大小合理,然后再报告成功:[ -s "$OUTPUT" ] || echo "render produced no output"。CLI 成功时会打印◇ <path>;对于长时间渲染,还可以使用ffprobe -i "$OUTPUT" -show_format -v error做健全性检查。
路由
| 目的… | 请阅读 |
|---|---|
搭建项目脚手架(init、capture、skills) | references/init-and-scaffold.md |
检查正确性(lint、validate、inspect、snapshot) | references/lint-validate-inspect.md |
预览或渲染(preview、play、render、publish) | references/preview-render.md |
诊断环境(doctor、browser) | references/doctor-browser.md |
在 AWS Lambda 上进行云端渲染(lambda deploy / sites / render / progress / destroy / policies) | references/lambda.md |
其他一切(info、upgrade、compositions、docs、benchmark、telemetry、资源预处理) | references/upgrade-info-misc.md |
跨技能交接
- Tailwind 项目(
init --tailwind)→ 在编辑类或主题令牌之前,使用hyperframes-core(Tailwind 参考)。 - 注册表块/组件(
hyperframes add、hyperframes catalog)→ 使用hyperframes-registry获取安装路径、子合成接线和代码片段合并。 - 资源预处理(
tts、transcribe、remove-background)→ 使用hyperframes-media进行语音选择、Whisper 模型规则、字幕以及 TTS 到字幕的链式处理。 - 参数化渲染(
--variables)→ 通过<html>上的data-composition-variables声明;完整架构请参见hyperframes-core。
Lambda(云端渲染)
hyperframes lambda 将分布式渲染部署到 AWS Lambda,并从您的笔记本电脑或 CI 驱动渲染。端到端需要三个命令:
npx hyperframes lambda deploy # 配置 SAM 堆栈(Lambda + Step Functions + S3)
npx hyperframes lambda render ./my-project --width 1920 --height 1080 --wait
npx hyperframes lambda destroy # 拆除(S3 存储桶会被保留)
当一个渲染对于单个主机而言太长/太大(多分钟视频、4K、大量并行批次)并且您已配置 AWS 凭据时,请使用 Lambda。对于开发循环迭代,请坚持使用本地 render。
有关先决条件、全部 6 个子命令(deploy、sites create、render、progress、destroy、policies)、IAM 策略验证、状态文件以及成本/清理规则,请参阅 references/lambda.md。
最小完成门控
静态门控
npx hyperframes lint
npx hyperframes validate
对于布局敏感的工作,添加 inspect;在 CI 中添加 render --strict 以便在 lint 错误时失败。
视觉冒烟测试——当项目使用子合成时必需
lint / validate / inspect 各自独立地评估每个合成。它们从不加载 index.html 并通过 data-composition-src 挂载子合成,因此它们无法捕获跨文件挂载失败(参见 hyperframes-core → references/sub-compositions.md,“常见陷阱”)。唯一能捕获它们的门控是实际加载 index.html 并遍历时间线的门控。
使用 hyperframes snapshot——它加载项目的方式与 render 相同(因此它执行相同的挂载路径),但只捕获您请求的时间戳,因此只需几秒钟而不是完整渲染:
# 在每个子合成的中点捕获一帧。
# 中点 = index.html 中每个宿主插槽的 data-start + data-duration/2。
npx hyperframes snapshot --at <t1>,<t2>,<t3>,...
# 或者,如果您不需要针对每个场景,可以使用均匀间隔的样本:
npx hyperframes snapshot --frames 9
输出位于 snapshots/frame-NN-at-Xs.png。目视检查每一帧是否与场景计划相符。
每帧的红色标记(每个都对应静态门控遗漏的特定失败模式):
| 您看到的内容 | 根本原因 |
|---|---|
| 文本在左上角显示为微小且无样式 | <style> 块被留在 <head> 中,位于 <template> 之外(陷阱 1)——没有 CSS 到达实时 DOM |
| SVG/图标元素放大到画布尺寸 | 同上——未应用宽度/高度约束 |
| 场景的主角元素完全缺失;仅背景和水印可见 | 宿主 id ≠ 模板 id(陷阱 2)——时间线从未运行,帧在初始状态捕获 |
快照命令记录 Sub-composition timelines not registered after 45000ms | 陷阱 2——直接确认 |
snapshots/ 可以在目视检查后删除;面向用户的最终渲染是另一个独立的 npx hyperframes render 过程。