HyperFrames CLI
所有操作都透過 npx hyperframes 執行。需要 Node.js >= 22 和 FFmpeg。
工作流程
- 建立腳手架 —
npx hyperframes init my-video - 撰寫 — 編寫 HTML 合成(請參閱
hyperframes技能) - Lint —
npx hyperframes lint - 視覺檢查 —
npx hyperframes inspect - 預覽 —
npx hyperframes preview - 渲染 —
npx hyperframes render
在預覽前先執行 lint 和 inspect。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 --example blank --tailwind # 使用 Tailwind v4 瀏覽器運行時
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 編寫技能。請使用它而非手動建立檔案。
使用 --tailwind 時,請在編輯類別或主題 token 之前呼叫 tailwind 技能。腳手架使用 Tailwind v4.2 的瀏覽器運行時,而非 Studio 的 Tailwind v3 設定。
Linting
npx hyperframes lint # 當前目錄
npx hyperframes lint ./my-project # 指定專案
npx hyperframes lint --verbose # 資訊級別的發現
npx hyperframes lint --json # 機器可讀
Lint 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 輸出精簡,適合 LLM 上下文視窗。如果溢出是為了入場/出場動畫而故意為之,請在元素或祖先元素上標記 data-layout-allow-overflow。如果裝飾元素永遠不應該被審計,請標記 data-layout-ignore。
npx hyperframes layout 仍可作為相同視覺檢查階段的相容別名使用。
預覽
npx hyperframes preview # 提供當前目錄服務
npx hyperframes preview --port 4567 # 自訂連接埠(預設 3002)
檔案變更時會熱重載。會自動在瀏覽器中開啟 Studio。
將專案交還給使用者時,請使用 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/名稱_時間戳.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 | 標記 | 關閉 | 可重現的輸出 |
--gpu | 標記 | 關閉 | GPU 加速編碼 |
--strict | 標記 | 關閉 | 在 lint 錯誤時失敗 |
--strict-all | 標記 | 關閉 | 在錯誤和警告時皆失敗 |
--variables | JSON 物件 | — | 覆寫 data-composition-variables 中宣告的變數值 |
--variables-file | 路徑 | — | 包含變數值的 JSON 檔案(--variables 的替代方案) |
--strict-variables | 標記 | 關閉 | 在 --variables 中存在未宣告的鍵或類型不符時渲染失敗 |
品質建議: 迭代時使用 draft,審查時使用 standard,最終交付時使用 high。
參數化渲染: 合成在 <html> 根元素上使用 data-composition-variables 宣告其變數 — 這是一個 JSON 宣告陣列(每項包含 {id, type, label, default}),定義了架構。內部的腳本透過 window.__hyperframes.getVariables() 讀取解析後的值。CLI 的 --variables '{"title":"Q4 Report"}' 是一個以 id 為鍵的 JSON 物件,用於覆寫一次渲染的宣告預設值;缺少的鍵會沿用預設值,因此同一個合成在開發預覽和生產環境中都可以不變地運行。(子合成宿主也可以使用 data-variable-values 為每個實例進行覆寫 — 物件結構相同,作用範圍限定於子合成的一次掛載。完整模式請參閱 hyperframes 技能。)
資產前置處理
npx hyperframes tts、transcribe 和 remove-background 會產生資產(旁白音訊、逐字稿、透明影片),這些資產會被放入合成中。每個指令在首次執行時都會下載自己的模型。關於語音選擇、whisper 模型規則(.en 會翻譯非英語的陷阱)、輸出格式選擇(VP9 Alpha WebM 與 ProRes)以及 TTS → 轉錄 → 字幕的鏈路,請呼叫 hyperframes-media 技能。
疑難排解
npx hyperframes doctor # 檢查環境(Chrome、FFmpeg、Node、記憶體)
npx hyperframes browser # 管理 bundled Chrome
npx hyperframes info # 版本和環境詳情
npx hyperframes upgrade # 檢查更新
如果渲染失敗,先執行 doctor。常見問題:缺少 FFmpeg、缺少 Chrome、記憶體不足。
其他
npx hyperframes compositions # 列出專案中的合成
npx hyperframes docs # 開啟文件
npx hyperframes benchmark . # 基準測試渲染效能