HyperFrames CLI
すべての操作は npx hyperframes を介して実行します。Node.js >= 22 と FFmpeg が必要です。
ワークフロー
- スキャフォールディング —
npx hyperframes init my-video - 作成 — HTML コンポジションを記述(
hyperframesスキルを参照) - Lint —
npx hyperframes lint - 視覚的検査 —
npx hyperframes inspect - プレビュー —
npx hyperframes preview - レンダリング —
npx hyperframes render
プレビュー前に lint と inspect を実行してください。lint は、欠落している data-composition-id、重複するトラック、未登録のタイムラインを検出します。inspect は、レンダリングされたコンポジションをヘッドレス Chrome で開き、タイムラインをシークして、吹き出しやコンテナの外にあふれたテキスト、またはキャンバスからはみ出たテキストを報告します。
スキャフォールディング
npx hyperframes init my-video # インタラクティブウィザード
npx hyperframes init my-video --example warm-grain # サンプルを選択
npx hyperframes init my-video --video clip.mp4 # ビデオファイルを指定
npx hyperframes init my-video --audio track.mp3 # オーディオファイルを指定
npx hyperframes init my-video --example blank --tailwind # Tailwind v4 ブラウザランタイムを使用
npx hyperframes init my-video --non-interactive # プロンプトをスキップ(CI/エージェント向け)
テンプレート: blank, warm-grain, play-mode, swiss-grid, vignelli, decision-tree, kinetic-type, product-promo, nyt-graph。
init は適切なファイル構造を作成し、メディアをコピーし、Whisper でオーディオを文字起こしし、AI コーディングスキルをインストールします。手動でファイルを作成する代わりにこれを使用してください。
--tailwind を使用する場合は、クラスやテーマトークンを編集する前に tailwind スキルを呼び出してください。スキャフォールディングは Studio の Tailwind v3 設定ではなく、ブラウザランタイムを介した Tailwind v4.2 を使用します。
Lint
npx hyperframes lint # カレントディレクトリ
npx hyperframes lint ./my-project # 特定のプロジェクト
npx hyperframes lint --verbose # info レベルの検出結果
npx hyperframes lint --json # 機械可読
index.html と compositions/ 内のすべてのファイルを lint します。エラー(修正必須)、警告(修正推奨)、および情報(--verbose 時)を報告します。
視覚的検査
npx hyperframes inspect # タイムライン上のレンダリングレイアウトを検査
npx hyperframes inspect ./my-project # 特定のプロジェクト
npx hyperframes inspect --json # エージェント可読な検出結果
npx hyperframes inspect --samples 15 # より密なタイムラインスイープ
npx hyperframes inspect --at 1.5,4,7.25 # 明示的なヒーローフレームタイムスタンプ
これは lint と validate の後、特に吹き出し、カード、キャプション、またはタイトなタイポグラフィを含むコンポジションに使用します。以下を報告します:
- 最も近い視覚的コンテナまたは吹き出しの外に広がるテキスト
- 自身の固定幅/固定高さのボックスでクリップされたテキスト
- コンポジションキャンバスの外に広がるテキスト
- クリッピングコンテナからはみ出した子要素
エラーはレンダリング前に修正する必要があります。警告はエージェントのレビュー用に表示されます。--strict を追加すると、警告でも失敗します。繰り返し発生する静的な問題はデフォルトで折りたたまれるため、LLM コンテキストウィンドウに対して JSON 出力がコンパクトに保たれます。エントランス/エグジットアニメーションのために意図的にオーバーフローさせる場合は、要素またはその祖先に data-layout-allow-overflow をマークしてください。検査対象にすべきでない装飾要素は data-layout-ignore でマークします。
npx hyperframes layout は同じ視覚的検査パスへの互換性エイリアスとして引き続き使用できます。
プレビュー
npx hyperframes preview # カレントディレクトリを配信
npx hyperframes preview --port 4567 # カスタムポート(デフォルト 3002)
ファイル変更時にホットリロードします。自動的にブラウザでスタジオを開きます。
プロジェクトをユーザーに引き渡すときは、ソース index.html パスではなく、Studio のプロジェクト URL を使用してください:
http://localhost:<port>/#project/<project-name>
プレビュー出力の実際のポートとプロジェクトディレクトリ名を使用してください。たとえば、codex-openai-video ディレクトリで npx hyperframes preview --port 3017 を実行した後は、http://localhost:3017/#project/codex-openai-video を報告してください。
index.html はソースコードのコンテキストとしてのみ扱ってください。実装ファイルとしてリンクすることは問題ありませんが、プロジェクトやプレビュー画面としてラベル付けしないでください。
レンダリング
npx hyperframes render # 標準 MP4
npx hyperframes render --output final.mp4 # 名前付き出力
npx hyperframes render --quality draft # 高速イテレーション
npx hyperframes render --fps 60 --quality high # 最終納品
npx hyperframes render --format webm # 透明 WebM
npx hyperframes render --docker # バイト同一出力
| フラグ | オプション | デフォルト | 備考 |
|---|---|---|---|
--output | パス | renders/name_timestamp.mp4 | 出力パス |
--fps | 24, 30, 60 | 30 | 60fps ではレンダリング時間が倍になります |
--quality | draft, standard, high | standard | draft はイテレーション用 |
--format | mp4, webm | mp4 | WebM は透明度をサポート |
--workers | 1-8 または auto | auto | 各ワーカーが Chrome を起動 |
--docker | フラグ | オフ | 再現可能な出力 |
--gpu | フラグ | オフ | GPU アクセラレーションエンコーディング |
--strict | フラグ | オフ | lint エラーで失敗 |
--strict-all | フラグ | オフ | エラーと警告の両方で失敗 |
--variables | JSON オブジェクト | — | data-composition-variables で宣言された変数値を上書き |
--variables-file | パス | — | 変数値を含む JSON ファイル(--variables の代替) |
--strict-variables | フラグ | オフ | --variables で未宣言のキーや型の不一致でレンダリングを失敗させる |
品質ガイダンス: イテレーション中は draft、レビューには standard、最終納品には high を使用してください。
パラメータ化レンダリング: コンポジションは <html> ルートに data-composition-variables で変数を宣言します。これはスキーマを定義する JSON 宣言の配列(各エントリ: {id, type, label, default})です。スクリプトは window.__hyperframes.getVariables() を介して解決された値を読み取ります。CLI の --variables '{"title":"Q4 Report"}' は、id をキーとする JSON オブジェクト で、宣言されたデフォルト値を 1 回のレンダリングで上書きします。不足しているキーはデフォルト値が使用されるため、同じコンポジションを開発プレビューと本番の両方で変更せずに実行できます。(サブコンポジションホストは、data-variable-values を使用してインスタンスごとに上書きすることもできます。同じオブジェクト形状で、サブコンポジションの 1 つのマウントにスコープされます。完全なパターンについては hyperframes スキルを参照してください。)
アセット前処理
npx hyperframes tts、transcribe、remove-background はアセット(ナレーション音声、単語レベルの文字起こし、透明ビデオ)を生成し、コンポジションに配置します。各コマンドは初回実行時に独自のモデルをダウンロードします。音声選択、Whisper モデルルール(.en が非英語を翻訳する注意点)、出力形式の選択(VP9 アルファ WebM vs ProRes)、TTS → 文字起こし → キャプションのチェーンについては、hyperframes-media スキルを呼び出してください。
トラブルシューティング
npx hyperframes doctor # 環境を確認(Chrome, FFmpeg, Node, メモリ)
npx hyperframes browser # バンドルされた Chrome を管理
npx hyperframes info # バージョンと環境の詳細
npx hyperframes upgrade # アップデートを確認
レンダリングに失敗した場合は、最初に doctor を実行してください。一般的な問題: FFmpeg の欠落、Chrome の欠落、メモリ不足。
その他
npx hyperframes compositions # プロジェクト内のコンポジションを一覧表示
npx hyperframes docs # ドキュメントを開く
npx hyperframes benchmark . # レンダリングパフォーマンスをベンチマーク