HyperFrames CLI
所有操作都透過 npx hyperframes 執行,除非專案說明指定了本地包裝器。請嚴格遵守本地包裝器。需要 Node.js >= 22 和 FFmpeg。
工作流程
- 建立專案 —
npx hyperframes init my-video(或從 URLcapture) - 撰寫 — 編寫 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 了解規範和動作驗證規格。
代理約定
適用於每個指令的橫切規則:
--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 "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)—— 時間軸從未執行,影格在初始狀態時被捕捉 |
Snapshot 指令記錄 Sub-composition timelines not registered after 45000ms | 陷阱 2——直接確認 |
目視檢查後可以刪除 snapshots/;面向使用者的最終渲染是使用 npx hyperframes render 進行的單獨步驟。