HyperFrames CLI
所有操作通过 npx hyperframes 运行,除非项目说明指定了本地包装器。请严格遵循本地包装器的指示。需要 Node.js >= 22 和 FFmpeg。
工作流
- Scaffold(搭建) —
npx hyperframes init my-video(或从 URLcapture)。init还会检查已安装的技能是否与 GitHub 上的最新版本一致,并更新过时的全局技能集。--skip-skills标志目前被禁用(临时情况,等待 skills.sh 注册表跟上),因此每次init都会执行此检查并拉取最新的技能。 - 编写(Write) — 创作 HTML 合成(参见
hyperframes-core技能) - 检查(Lint) —
npx hyperframes lint - 验证(Validate) —
npx hyperframes validate(运行时错误 + 对比度) - 可视化检查(Visual inspect) —
npx hyperframes inspect - 预览(Preview) —
npx hyperframes preview打开 Studio,这是一个时间线编辑器,用户可以在其中手动编辑任何内容(而不仅仅是观看)。在此处审查,然后询问是否渲染。 - 渲染(Render) — 选择变体:
- 迭代开发:
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,因此输出可以安全地粘贴到错误报告和代理上下文中。- 渲染需要用户批准。 检查通过后绝不自动渲染。在
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 create / 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。
参见 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 过程。