HyperFrames CLI
所有操作都透過 npx hyperframes 執行。需要 Node.js >= 22 和 FFmpeg。
工作流程
- Scaffold —
npx hyperframes init my-video - 撰寫 — 編寫 HTML 組合(請參閱
hyperframes技能) - Lint —
npx hyperframes lint - 視覺檢查 —
npx hyperframes inspect - 預覽 —
npx hyperframes preview - 渲染 —
npx hyperframes render
請在預覽前先進行 Lint 和檢查。lint 會捕捉遺失的 data-composition-id、重疊的軌道以及未註冊的時間軸。inspect 會在無頭 Chrome 中開啟渲染的組合,在時間軸上搜尋,並回報文字溢出氣泡/容器或畫布的情況。
Scaffolding
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/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 | 在錯誤和警告時皆失敗 |
--variables | JSON 物件 | — | 覆寫 data-composition-variables 中宣告的變數值 |
--variables-file | 路徑 | — | 包含變數值的 JSON 檔案(--variables 的替代方案) |
--strict-variables | 標誌 | off | 若 --variables 中有未宣告的鍵或型別不符,則渲染失敗 |
品質指引: 迭代時使用 draft,審查時使用 standard,最終交付時使用 high。
參數化渲染: 組合在 <html> 根元素上使用 data-composition-variables 宣告其變數 — 這是一個 JSON 宣告陣列(每個條目包含 {id, type, label, default}),定義了結構描述。內部的腳本透過 window.__hyperframes.getVariables() 讀取解析後的值。CLI 的 --variables '{"title":"Q4 Report"}' 是一個 JSON 以 id 為鍵的物件,會覆寫針對一次渲染宣告的預設值;遺漏的鍵會回退,因此同一個組合在開發預覽和生產環境中都能不變地運作。(子組合宿主也可以使用 data-variable-values 為每個實例進行覆寫 — 物件結構相同,但作用範圍僅限於子組合的一次掛載。完整模式請參閱 hyperframes 技能。)
資產預處理
npx hyperframes tts、transcribe 和 remove-background 會產生資產(旁白音訊、逐字轉錄稿、透明影片),這些資產會被放入組合中。每個指令在首次執行時都會下載其自己的模型。關於語音選擇、Whisper 模型規則(.en 會翻譯非英語語言的陷阱)、輸出格式選擇(VP9 Alpha WebM vs ProRes)以及 TTS → 轉錄 → 字幕鏈,請調用 hyperframes-media 技能。
問題排除
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 . # 基準測試渲染效能