HyperFrames CLI
所有操作都透過 npx hyperframes 執行,除非專案說明指定了本地包裝器。請完全遵循本地包裝器的指示。需要 Node.js >= 22 和 FFmpeg。
工作流程
- 建構 —
npx hyperframes init my-video(或從 URLcapture) - 編寫 — 撰寫 HTML 合成(參見
../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 以了解規範和運動驗證規格。
代理慣例
適用於每個指令的跨領域規則:
- 除
render、preview和play外,每個指令都提供--json。 在任何代理 / 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 未產生輸出"。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)→ 在編輯類別或主題權杖之前,請參閱../core/references/tailwind.md。 - Registry 區塊/元件(
hyperframes add、hyperframes catalog)→ 請參閱../registry以了解安裝路徑、子合成接線和程式碼片段合併。 - 參數化渲染(
--variables)→ 在<html>上透過data-composition-variables宣告;完整結構請參閱../core/references/variables-and-media.md。
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 掛載子合成,因此無法捕捉跨檔案掛載失敗(請參閱 ../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/圖示元素放大到畫布大小 | 同上 — 沒有套用 width/height 限制 |
| 場景的主角元素完全消失;僅可見背景和浮水印 | 主機 ID ≠ 模板 ID(陷阱 2)— 時間軸從未執行,畫面在初始狀態被捕捉 |
快照指令記錄 Sub-composition timelines not registered after 45000ms | 陷阱 2 — 直接確認 |
snapshots/ 可以在目視檢查後刪除;最終面對使用者的渲染是使用 npx hyperframes render 的獨立步驟。