HyperFrames CLI
すべての操作は、プロジェクトの指示でローカルラッパーが指定されていない限り npx hyperframes で実行します。ローカルラッパーが存在する場合は、その指示に正確に従ってください。Node.js 22 以上と FFmpeg が必要です。
ワークフロー
- スキャフォールド —
npx hyperframes init my-video(または URL からcapture) - 記述 — HTML コンポジションを作成します(
hyperframes-coreスキルを参照) - リント —
npx hyperframes lint - 検証 —
npx hyperframes validate(実行時エラー + コントラスト) - 視覚的検査 —
npx hyperframes inspect - プレビュー —
npx hyperframes preview - レンダリング — 以下のバリアントから選択:
- イテレーション:
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はリントエラーで失敗、--strict-allは警告でも失敗、--strict-variablesは未宣言の--variablesキーで失敗します。 --json内のパスは秘匿化されます —$HOMEはリテラル$HOMEとなり、出力をバグレポートやエージェントコンテキストに安全に貼り付けられます。- レンダリング後検証。
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 バケットは保持)
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 ではリントエラーで失敗させるために 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 で別途実行します。