HyperFrames CLI
すべての処理は npx hyperframes を通じて実行されます。プロジェクトの指示でローカルラッパーが指定されている場合は、そのラッパーに厳密に従ってください。Node.js >= 22 および FFmpeg が必要です。
ワークフロー
- スキャフォールド —
npx hyperframes init my-video(または URL からのcapture) - 記述 — HTML コンポジションを作成(
../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、validate、inspect を実行してください。lint は data-composition-id の欠落、トラックの重複、未登録のタイムラインを検出します。validate はヘッドレス Chrome でコンポジションを読み込み、ランタイム console エラーと 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はリントエラーで失敗します。--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)→ クラスやテーマトークンを編集する前に../core/references/tailwind.mdを参照。 - レジストリブロック/コンポーネント(
hyperframes add、hyperframes catalog)→ インストールパス、サブコンポジションの配線、スニペットマージについては../registryを参照。 - パラメータ化されたレンダリング(
--variables)→<html>でdata-composition-variablesとして宣言。完全なスキーマは../core/references/variables-and-media.mdを参照。
Lambda(クラウドレンダリング)
hyperframes lambda は分散レンダリングを AWS Lambda にデプロイし、ノートPC または 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 ではリントエラーで失敗させるために render --strict を使用してください。
ビジュアルスモークテスト — プロジェクトがサブコンポジションを使用する場合に必須
lint / validate / inspect は各コンポジションを 単独で 評価します。index.html を読み込んで data-composition-src 経由でサブコンポジションをマウントすることはないため、ファイル間のマウント障害を捕捉できません(../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 で別途実行します。