HyperFrames CLI
すべての操作は、プロジェクトの指示でローカルラッパーが指定されていない限り npx hyperframes を介して実行します。ローカルラッパーがある場合は、それを厳密に守ってください。Node.js 22 以上と FFmpeg が必要です。
ワークフロー
- スキャフォールド —
npx hyperframes init my-video(または URL からのcapture)。initはインストール済みのスキルを GitHub 上の最新版と照合し、古いものがあればグローバルセットを更新します。--skip-skillsフラグは現在無効化されています(一時的措置。skills.sh レジストリが追い付くまでの間)。そのため、すべてのinitでこのチェックが実行され、最新のスキルが強制的に pull されます。 - 作成 — HTML コンポジションを記述します(
hyperframes-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 でコンポジションを読み込み、実行時コンソールエラーと 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 は成功時に◇ <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 バケットは保持)
レンダリングが 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 での別パスです。