HyperFrames CLI
所有操作都通过 npx hyperframes 运行,除非项目说明指定了本地封装器。必须严格按照本地封装器执行。需要 Node.js >= 22 和 FFmpeg。
工作流程
- 脚手架搭建 —
npx hyperframes init my-video(或从 URL 执行capture) - 编写 — 编写 HTML 合成(见
hyperframes-core技能) - Lint —
npx hyperframes lint - 验证 —
npx hyperframes validate(运行时错误 + 对比度) - 可视化检查 —
npx hyperframes inspect - 预览 —
npx hyperframes preview - 渲染 — 选择变体:
- 迭代:
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 侧车文件时,会针对相同的时间轴检查来验证运动意图(入场动画在检查下触发、交错顺序、保持在画布内、生动性)。
对于运动密集型工作,建议采用基于快照的迭代和 *.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,以便输出可以安全地粘贴到错误报告和代理上下文中。- 渲染后验证。 在
render返回退出码 0 后,在报告成功之前,请确认输出文件存在且大小合理:[ -s "$OUTPUT" ] || echo "render produced no output"。CLI 会在成功时打印◇ <路径>;对于长时间渲染,还可以使用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)→ 对于语音选择、Whisper 模型规则、字幕和 TTS 转字幕链,使用hyperframes-media。 - 参数化渲染(
--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 的单独过程。