HyperFrames CLI
所有操作都透過 npx hyperframes 執行,除非專案說明指定了本機包裝器。請嚴格遵守本機包裝器。需要 Node.js >= 22 和 FFmpeg。
工作流程
- 建立骨架 —
npx hyperframes init my-video(或從 URL 使用capture) - 編寫 — 編寫 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 以了解規範和動作驗證規格。
代理程式規範
適用於每個命令的通用規則:
- 除了
render、preview和play之外,每個命令都可使用--json。 在任何代理程式 / CI 呼叫支援的命令時使用它;輸出包含一個_meta信封(cli 版本、最新可用版本、更新建議)。render僅透過 stdout + 退出碼回報狀態——請使用下方的渲染後檢查來驗證成功;preview/play是伺服器,沒有 JSON。 doctor --json總是退出 0,即使環境已損壞。根據負載的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)→ 在編輯類別或主題 token 前,使用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> 區塊留在 <template> 外部的 <head> 中(陷阱 1)—— 沒有 CSS 到達實際 DOM |
| SVG/圖示元素放大到畫布大小 | 同上——未套用寬度/高度限制 |
| 場景的主要元素完全遺失;僅顯示背景和浮水印 | 主機 id ≠ 模板 id(陷阱 2)—— 時間軸從未執行,畫格在初始狀態下捕捉 |
快照命令記錄 Sub-composition timelines not registered after 45000ms | 陷阱 2—— 直接確認 |
snapshots/ 可以在目視檢查後刪除;使用者最終的渲染是一個單獨的 npx hyperframes render 程序。