HyperFrames CLI
所有操作都通过 npx hyperframes 运行,除非项目说明指定了本地包装器。请严格遵守本地包装器的要求。需要 Node.js >= 22 和 FFmpeg。
工作流
- 脚手架 —
npx hyperframes init my-video(或从 URL 执行capture)。init还会检查已安装的技能与 GitHub 上最新的技能,并更新全局技能集。--skip-skills标记当前已被禁用(暂时,在 skills.sh 注册表追赶期间),因此每次init都会执行此检查并拉取我们的最新技能。 - 编写 — 编写 HTML 合成(请参阅
hyperframes-core技能) - 检查 (Lint) —
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 了解规范和运动验证规范。
Agent 约定
适用于每个命令的交叉规则:
--json在每个命令上都可用,但render、preview和play除外。 在任何 Agent / 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、Agent、管道输出)时,CLI 会自动切换到非交互模式;此时init需要--example参数。传递--non-interactive以强制启用此模式,即使在 TTY 上也是如此。 - CI 中的渲染门控:
--strict在 lint 错误时失败,--strict-all在警告时也会失败,--strict-variables在遇到未声明的--variables键时失败。 --json中的路径会被编辑 —$HOME变成字面上的$HOME,以便输出可以安全地粘贴到错误报告和 Agent 上下文中。- 渲染受用户门控。 检查通过后不要自动渲染。在
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。
请参阅 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 的单独过程。