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 を参照してください。
エージェント規約
すべてのコマンドに適用される横断的ルール:
--jsonはrender、preview、playを除くすべてのコマンドで使用可能です。 サポート対象のコマンドに対するエージェント / 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が必要になります。TTY 上でも強制的にこのモードにするには--non-interactiveを渡してください。 - レンダリングの CI ゲート:
--strictは lint エラーで失敗し、--strict-allは警告でも失敗し、--strict-variablesは未宣言の--variablesキーで失敗します。 --json内のパスは秘匿化されます —$HOMEはリテラル文字列$HOMEになるため、出力をバグ報告やエージェントコンテキストに安全に貼り付けることができます。- レンダリングはユーザー承認が必要です。 チェックが通ったら自動レンダリングは絶対に行わないでください。
previewで一時停止し、ユーザーに Studio でビデオが編集可能であることを伝え、ユーザーの承認後にのみレンダリングしてください。 - レンダリング後の検証。
renderが終了コード 0 で戻った後、成功を報告する前に出力ファイルが存在し、妥当なサイズであることを確認してください:[ -s "$OUTPUT" ] || echo "render produced no output"。CLI は成功時に◇ <パス>を出力します。長時間のレンダリングの場合は、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)→ 音声選択、Whisper モデルルール、キャプション、TTS→キャプションチェーンについてはhyperframes-mediaを使用します。 - パラメータ化レンダリング(
--variables)→<html>のdata-composition-variablesで宣言します。完全なスキーマはhyperframes-coreを参照してください。
Lambda(クラウドレンダリング)
hyperframes lambda は分散レンダリングを AWS Lambda にデプロイし、ラップトップまたは CI からレンダリングを実行します。エンドツーエンドは 3 つのコマンドです:
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 バケットは保持)
レンダリングが 1 台のホストでは長すぎる/大きすぎる場合(数分以上の動画、4K、大規模並列バッチ)で、AWS 認証情報が設定されている場合に Lambda を使用します。開発ループの反復にはローカルの render を使用してください。
前提条件、6 つのサブコマンドすべて(deploy、sites create、render、progress、destroy、policies)、IAM ポリシーの検証、状態ファイル、コスト/クリーンアップルールについては references/lambda.md を参照してください。
最小完了ゲート
静的ゲート
npx hyperframes lint
npx hyperframes validate
レイアウトに依存する作業には inspect を追加し、CI では lint エラーで失敗させるために render --strict を追加してください。
視覚的スモークテスト — サブコンポジションを使用するプロジェクトでは必須
lint / validate / inspect は各コンポジションを単独で評価します。index.html をロードして data-composition-src を介してサブコンポジションをマウントすることは決してないため、クロスファイルのマウント障害をキャッチできません(hyperframes-core → references/sub-compositions.md、「よくある落とし穴」を参照)。これらをキャッチできる唯一のゲートは、実際に index.html をロードしてタイムラインをシークするものです。
hyperframes snapshot を使用してください。これは render と同じ方法でプロジェクトをロードするため(同じマウントパスを実行します)、要求されたタイムスタンプのみをキャプチャするため、フルレンダリングではなく数秒で完了します:
# 各サブコンポジションの中間点で 1 フレームをキャプチャ。
# 中間点 = 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 を使用した別のパスになります。