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技能) - 检查 —
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 了解相关规范及运动验证规范。
代理约定
适用于每个命令的横向规则:
--json可用于除render、preview和play之外的所有命令。 在支持的命令的任何代理/CI 调用中使用它;输出包含一个_meta信封(cli 版本、最新可用版本、更新建议)。render仅通过 stdout + 退出码报告状态——通过下面的渲染后检查验证成功;preview/play是服务器,不输出 JSON。doctor --json始终以退出码 0 退出,即使环境有问题。通过 payload 的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 "渲染未产生输出"。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)—— 时间线从未运行,在初始状态捕获帧 |
快照命令日志显示 在 45000ms 后子合成时间线未注册 | 陷阱 2 —— 直接确认 |
snapshots/ 可以在肉眼检查后删除;面向用户的最终渲染是使用 npx hyperframes render 进行的单独步骤。