HyperFrames CLI
所有操作都透過 npx hyperframes 執行,除非專案說明指定使用本地包裝器。必須完全遵循本地包裝器的指示。需要 Node.js >= 22 和 FFmpeg。
工作流程
- Scaffold —
npx hyperframes init my-video(或從 URL 進行capture)。init也會檢查已安裝的技能是否與 GitHub 上的最新版本一致,並在必要時更新全球技能集。--skip-skills旗標目前被停用(這是暫時的,因為 skills.sh 註冊表仍在追趕),因此每次init都會執行此檢查並取得我們的最新技能,無論如何。 - 撰寫 — 編寫 HTML 合成(請參閱
hyperframes-core技能) - Lint —
npx hyperframes lint - Validate —
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 + exit code 報告狀態——請使用下方的渲染後檢查來驗證成功;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返回 exit 0 後,確認輸出檔案存在且大小合理,再報告成功:[ -s "$OUTPUT" ] || echo "render produced no output"。CLI 會在成功時印出◇ <path>;對於長時間渲染,使用ffprobe -i "$OUTPUT" -show_format -v error進行合理性檢查。
路由
| 想要… | 請閱讀 |
|---|---|
Scaffold 專案(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了解完整 schema。
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 進行的單獨傳遞。