HyperFrames CLI
所有操作都透過 npx hyperframes 執行,除非專案說明指定了本地包裝器。必須完全遵循本地包裝器的指示。需要 Node.js >= 22 和 FFmpeg。
工作流程
- 搭建 —
npx hyperframes init my-video(或從 URLcapture) - 編寫 — 撰寫 HTML 組合(參見
hyperframes-core技能) - 語法檢查 —
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 會捕捉遺失的 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 "渲染未產生輸出"。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/圖示元素放大到畫布大小 | 同上 — 未應用任何寬度/高度約束 |
| 場景的主要元素完全遺失;只有背景和浮水印可見 | Host-id ≠ template id(陷阱 2)— 時間軸從未執行,幀在初始狀態下捕捉 |
快照命令記錄 Sub-composition timelines not registered after 45000ms | 陷阱 2 — 直接確認 |
snapshots/ 可以在目視檢查後刪除;最終使用者面向的渲染是使用 npx hyperframes render 進行的單獨傳遞。