HyperFrames CLI
所有操作均通过 npx hyperframes 运行。需要 Node.js >= 22 和 FFmpeg。
工作流程
- 脚手架 —
npx hyperframes init my-video - 编写 — 创作 HTML 合成(参见
hyperframes技能) - 代码检查 —
npx hyperframes lint - 可视化审查 —
npx hyperframes inspect - 预览 —
npx hyperframes preview - 渲染 —
npx hyperframes render
在预览前务必进行代码检查和可视化审查。lint 可检测缺失的 data-composition-id、重叠轨道以及未注册的时间线。inspect 在无头 Chrome 中打开渲染后的合成,沿时间线扫描,并报告气泡/容器或画布外的文本溢出问题。
脚手架
npx hyperframes init my-video # 交互式向导
npx hyperframes init my-video --example warm-grain # 选择一个示例
npx hyperframes init my-video --video clip.mp4 # 附带视频文件
npx hyperframes init my-video --audio track.mp3 # 附带音频文件
npx hyperframes init my-video --non-interactive # 跳过提示(CI/智能体使用)
模板:blank, warm-grain, play-mode, swiss-grid, vignelli, decision-tree, kinetic-type, product-promo, nyt-graph。
init 会创建正确的文件结构,复制媒体文件,使用 Whisper 转录音频,并安装 AI 编码技能。请使用此命令而不是手动创建文件。
代码检查
npx hyperframes lint # 当前目录
npx hyperframes lint ./my-project # 指定项目
npx hyperframes lint --verbose # 信息级发现
npx hyperframes lint --json # 机器可读
检查 index.html 和 compositions/ 目录下的所有文件。报告错误(必须修复)、警告(建议修复)和信息(使用 --verbose)。
可视化审查
npx hyperframes inspect # 检查沿时间线的渲染布局
npx hyperframes inspect ./my-project # 指定项目
npx hyperframes inspect --json # 智能体可读的发现
npx hyperframes inspect --samples 15 # 更密集的时间线扫描
npx hyperframes inspect --at 1.5,4,7.25 # 明确的英雄帧时间戳
在 lint 和 validate 之后使用此命令,特别是对于包含语音气泡、卡片、字幕或紧凑排版的合成。它会报告:
- 文本超出最近的视觉容器或气泡
- 文本被自己的固定宽度/高度框裁剪
- 文本超出合成画布
- 子元素逃逸裁剪容器
错误应在渲染前修复。警告供智能体审查;添加 --strict 可让警告也导致失败。默认情况下,重复的静态问题会被折叠,以便 JSON 输出保持紧凑,适合大语言模型上下文窗口。如果溢出是入场/出场动画的故意设计,请使用 data-layout-allow-overflow 标记元素或其祖先。如果装饰性元素不应被审计,请使用 data-layout-ignore 标记。
npx hyperframes layout 仍然可用,作为同一可视化审查过程的兼容别名。
预览
npx hyperframes preview # 提供当前目录服务
npx hyperframes preview --port 4567 # 自定义端口(默认 3002)
文件更改时热重载。自动在浏览器中打开工作室。
将项目交还给用户时,请使用 Studio 项目 URL,而不是源文件 index.html 路径:
http://localhost:<port>/#project/<project-name>
请使用预览输出中的实际端口和项目目录名称。例如,在 codex-openai-video 目录中执行 npx hyperframes preview --port 3017 后,应报告 http://localhost:3017/#project/codex-openai-video。
将 index.html 仅视为源代码上下文。它可以作为实现文件链接,但不要将其标记为项目或预览界面。
渲染
npx hyperframes render # 标准 MP4
npx hyperframes render --output final.mp4 # 指定输出名称
npx hyperframes render --quality draft # 快速迭代
npx hyperframes render --fps 60 --quality high # 最终交付
npx hyperframes render --format webm # 透明 WebM
npx hyperframes render --docker # 字节一致
| 标志 | 选项 | 默认值 | 说明 |
|---|---|---|---|
--output | 路径 | renders/name_timestamp.mp4 | 输出路径 |
--fps | 24, 30, 60 | 30 | 60fps 渲染时间翻倍 |
--quality | draft, standard, high | standard | draft 用于迭代 |
--format | mp4, webm | mp4 | WebM 支持透明度 |
--workers | 1-8 或 auto | auto | 每个 worker 启动一个 Chrome |
--docker | 标志 | off | 可复现输出 |
--gpu | 标志 | off | GPU 加速编码 |
--strict | 标志 | off | 遇到 lint 错误时失败 |
--strict-all | 标志 | off | 遇到错误和警告时均失败 |
质量指导: 迭代时使用 draft,审查时使用 standard,最终交付时使用 high。
转录
npx hyperframes transcribe audio.mp3
npx hyperframes transcribe video.mp4 --model medium.en --language en
npx hyperframes transcribe subtitles.srt # 导入现有字幕
npx hyperframes transcribe subtitles.vtt
npx hyperframes transcribe openai-response.json
文本转语音
npx hyperframes tts "Text here" --voice af_nova --output narration.wav
npx hyperframes tts script.txt --voice bf_emma
npx hyperframes tts --list # 显示所有语音
故障排查
npx hyperframes doctor # 检查环境(Chrome, FFmpeg, Node, 内存)
npx hyperframes browser # 管理捆绑的 Chrome
npx hyperframes info # 版本和环境详细信息
npx hyperframes upgrade # 检查更新
如果渲染失败,请先运行 doctor。常见问题:缺少 FFmpeg、缺少 Chrome、内存不足。
其他
npx hyperframes compositions # 列出项目中的合成
npx hyperframes docs # 打开文档
npx hyperframes benchmark . # 基准测试渲染性能