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で 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 バケットは保持されます)
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 エラーで失敗するようにします。
ビジュアルスモークテスト — プロジェクトがサブコンポジションを使用する場合に必須
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 を使用した別のパスです。