HyperFrames CLI
所有操作通过 npx hyperframes 执行,除非项目说明指定了本地包装器。必须严格遵循本地包装器。需要 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 侧车文件时,还会对照同一搜索的时间线验证运动意图(入场触发、交错顺序、帧内可见性、活跃度)。
对于运动密集型工作,建议优先使用基于快照的迭代和 *.motion.json 侧车文件 — 参见 references/lint-validate-inspect.md 了解规范和运动验证规格。
代理约定
适用于所有命令的通用规则:
- 所有命令(
render、preview和play除外)均支持--json。 在代理或 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声明;完整 schema 参见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。
参见 references/lambda.md 了解先决条件、全部 6 个子命令(deploy、sites create、render、progress、destroy、policies)、IAM 策略验证、状态文件以及成本/清理规则。
最小完成门控
静态门控
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 执行的独立步骤。