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。これにより、CI パイプラインが 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 は成功時に◇ <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)→ 音声選択、Whisper モデルルール、キャプション、TTS-to-captions チェーンには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/アイコン要素がキャンバスサイズに引き伸ばされている | 同上 — 幅/高さの制約が適用されていない |
| シーンの主要要素が完全に欠落し、背景と透かしだけが見える | Host-id ≠ テンプレート id(落とし穴 2)— タイムラインが実行されず、初期状態のフレームがキャプチャされた |
スナップショットコマンドが Sub-composition timelines not registered after 45000ms をログ出力 | 落とし穴 2 — 直接的な確認 |
snapshots/ は目視確認後に削除して構いません。ユーザー向けの最終レンダリングは、npx hyperframes render による別のパスで行われます。