HyperFrames CLI
すべての操作は、プロジェクトの指示がローカルラッパーを指定している場合を除き、npx hyperframes を介して実行されます。ローカルラッパーが指定されている場合は、それに厳密に従ってください。Node.js >= 22 と FFmpeg が必要です。
ワークフロー
- スキャフォールド —
npx hyperframes init my-video(または URL からのcapture)。initはインストールされているスキルを GitHub 上の最新版と照合し、古いものがあればグローバルセットを更新します。--skip-skillsフラグは現在無効化されています(一時的。skills.sh レジストリが追いつくまでの間)。そのため、すべてのinitがこのチェックを実行し、最新のスキルを常にプルします。 - 作成 — 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は環境が壊れていても常に exit 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が exit 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 からキャプションへのチェーンには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 バケットは保持)
Lambda は、レンダリングが 1 台のホストでは長すぎる/大きすぎる場合(数分の動画、4K、大規模な並列バッチ)に、AWS 認証情報が設定されている場合に使用します。開発ループの反復はローカルの 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 で別途実行します。