プラグインインストール: セットアップやフレッシュネスコマンドの前に、このスキルが HyperFrames プラグイン内にある場合は、プラグイン実行ルール に従ってください。スタンドアロンインストールの場合は、以下の更新手順に従ってください。
HyperFrames レジストリ
レジストリは、hyperframes add <name> でインストール可能な再利用可能なブロックとコンポーネントを提供します。
- ブロック — 独立したサブコンポジション(独自の寸法、持続時間、タイムラインを持ちます)。ホストコンポジションで
data-composition-srcを介してインクルードします。 - コンポーネント — エフェクトスニペット(独自の寸法はありません)。ホストコンポジションの HTML に直接ペーストします。
クイックリファレンス
hyperframes add data-chart # ブロックをインストール
hyperframes add grain-overlay # コンポーネントをインストール
hyperframes add captions # captions タグが付いたすべてのブロックをインストール
hyperframes add shimmer-sweep --dir . # 特定のプロジェクトをターゲットにする
hyperframes add data-chart --json # マシンリーダブルな出力
hyperframes add data-chart --no-clipboard # クリップボードをスキップ (CI/ヘッドレス)
インストール後、CLI は書き込まれたファイルと、ホストコンポジションにペーストするスニペットを表示します。スニペットは開始点です — ブロックを配線するときは、data-composition-id(ブロックの内部コンポジション ID と一致する必要があります)、data-start、data-track-index 属性を追加する必要があります。
位置引数は、最初に正確なアイテム名として解決されます。アイテムが一致せず、値がタグである場合、コマンドはそのタグを持つすべてのブロックをインストールします。レジストリの依存関係は、要求されたアイテムの前にインストールされます。hyperframes add はブロックとコンポーネントに対してのみ機能します。例については、代わりに hyperframes init <dir> --example <name> を使用してください。
インストール場所
デフォルトでは、ブロックは compositions/<name>.html にインストールされます。コンポーネントはデフォルトで compositions/components/<name>.html にインストールされます。
これらのパスは hyperframes.json で設定可能です:
{
"registry": "https://raw.githubusercontent.com/heygen-com/hyperframes/main/registry",
"paths": {
"blocks": "compositions",
"components": "compositions/components",
"assets": "assets"
}
}
詳細については、install-locations.md を参照してください。
ブロックの配線
ブロックは独立したコンポジションです — ホスト index.html で data-composition-src を介してインクルードします:
<div
data-composition-id="data-chart"
data-composition-src="compositions/data-chart.html"
data-start="2"
data-duration="15"
data-track-index="1"
data-width="1920"
data-height="1080"
></div>
主要な属性:
data-composition-src— ブロック HTML ファイルへのパスdata-composition-id— ブロックの内部 ID と一致する必要がありますdata-start— ブロックがホストタイムラインに表示されるタイミング(秒)data-duration— ブロックが再生される時間data-width/data-height— ブロックのキャンバスサイズdata-track-index— レイヤー順序(大きいほど前面)
詳細については、wiring-blocks.md を参照してください。
コンポーネントの配線
コンポーネントはスニペットです — その HTML をコンポジションのマークアップに、CSS をスタイルブロックに、JS をスクリプト(ある場合)にペーストします:
- インストールされたファイルを読む (例:
compositions/components/grain-overlay.html) - HTML 要素をコンポジションの
<div data-composition-id="...">にコピーする <style>ブロックをコンポジションのスタイルにコピーする<script>コンテンツがあれば、コンポジションのスクリプト(タイムラインコードの前)にコピーする- コンポーネントが GSAP タイムライン統合を公開している場合(スニペットのコメントブロックを参照)、それらの呼び出しをタイムラインに追加する
詳細については、wiring-components.md を参照してください。
ディスカバリー
CLI を主要なディスカバリーインターフェースとして使用してください。ブラウジングする前に意図で検索してください: レジストリには目視でスキャンできるよりも多くのアイテムが登録されているため、リストして名前やタグでマッチさせるのは遅い方法であり、著者の表現があなたの表現と異なる場合に失敗します。
# ビートが実行すべき内容に対してカタログ全体をランキング
npx hyperframes catalog --query "reveal a headline one line at a time"
npx hyperframes add caption-clip-wipe
検索はローカルで実行され、何も送信しません。デフォルトでは、アイテムの名前、タイトル、説明と共有される語彙に基づいてランキングするため、あなたの単語を再利用するアイテムのみが見つかります; --on-device は、1回限りのモデルダウンロード後、代わりに意味に基づいてランキングします。--json を使用すると、エンベロープはどの階層が応答したかを示すため、ランキングが行われたと想定するのではなく、それを確認してください。
ビデオの言語に関係なく、常に英語でクエリを実行してください。 カタログは英語で書かれており、両方の階層もそのようにインデックスを作成します(オンデバイスモデルも英語のみです)。別のスクリプトでのクエリは検索可能な用語を生成せず、何も返しません。これは、ブリーフ、キャプション、ナレーションがすべてその言語で書かれている日本語や中国語のプロジェクトでは間違えやすく、クエリが自然にその言語で書かれてしまいます。動作 を英語で説明し、オンスクリーンのコピーはビデオが必要とする任意の言語で書いてください。クエリが No searchable words in query を返した場合、これは欠落コンポーネントではなくこのルールの問題であり、ギャップレポートの価値はありません。
インストール可能性はランキングの後(前ではない)に適用されます:ベクターが運ぶがこのレジストリが提供できない名前は結果から削除され、dropped でカウントされます。したがって、dropped がゼロでない場合、それらは異なる世代であることを意味します。オフライン階層、同意ゲート、古いインデックスを更新する方法については、/hyperframes-cli を参照してください。
検索ではなく、ブラウズまたはフィルタリングする場合:
npx hyperframes catalog
npx hyperframes catalog --type block
npx hyperframes catalog --type component
npx hyperframes catalog --type block --tag social
npx hyperframes catalog --json
npx hyperframes catalog --human-friendly
通常のテーブルモードと --json モードはマッチのみをリストします;選択した名前を hyperframes add <name> でインストールしてください。--human-friendly はインタラクティブピッカーを開き、選択したアイテムをすぐにインストールします。CI やエージェントワークフローでは、--json の後に明示的に add を使用することを推奨します。
カタログにないものを報告する
検索結果に該当するものがなく、手動でエフェクトを作成する場合は、その前に以下のように報告してください:
npx hyperframes feedback --search-miss "<実行したクエリ>" --wanted "<必要な動作>" --tier on-device
catalog --query はこの行を事前入力して出力し、--json はそれを report_gap として保持します — そのため、何も適合しないと判断した時点で既に手元にあります。
結果のどれも要件を満たさない場合は、どちらの階層でも報告してください。 オンデバイス階層が応答したかどうかを待たないでください:同意済みの 33 MB のダウンロードが必要なため、明示的にオプトインしない限り、エージェントの実行は words に基づいています。on-device にゲートをかけると、ほとんどすべてのレポートが沈黙します。--tier 値はそれに伴って移動するため、語彙のミスと意味のミスを区別できます。あなたが想像したアイテム名ではなく、必要なエフェクトを説明してください:返ってくるのは構築する価値のある動作のリストであり、存在しないアイテムに名前を付けても何も学べません。これはクエリをどこかに送信する唯一のパスであり、まさにそれが検索が単独で行うことではなく、別個の意図的なコマンドである理由です。評価は含まれず、評価メトリクスにも到達しません。
これがカタログ全体の需要シグナルです。これをスキップすると、直面したギャップはインストール数のカウントから推測されることになり、誰もインストールできない動作を見ることはできません。
CLI が設定されたレジストリに到達できない場合、フォールバックとして生のマニフェストを検査してください:
curl -s https://raw.githubusercontent.com/heygen-com/hyperframes/main/registry/registry.json
CLI が到達できないレジストリは、ディスカバリーのためにカタログを空にしません:再検証に失敗した場合でも、以前にフェッチされたマニフェストは 24 時間の更新ウィンドウを超えて提供され続けるため、catalog と catalog --query はディスク上の最後のコピーに対してリストおよびランキングを続けます。
昨日インストールしたアイテムであっても、add は依然としてネットワークを必要とします。 マニフェストのみがキャッシュされ、アイテムの実際のファイルはインストールのたびにフェッチされます。したがって、オフラインでは検索でき、アイテムが何であるかを確認できますが、ファイルのフェッチでインストールは失敗します。ユーザーにオフラインインストールを約束しないでください。
各アイテムの registry-item.json には、名前、タイプ、タイトル、説明、タグ、寸法(ブロックのみ)、持続時間(ブロックのみ)、ファイルリストが含まれています。
タイプとタグによるフィルタリングの詳細については、discovery.md を参照してください。
新しいブロックまたはコンポーネントの貢献
新しいレジストリアイテム(キャプションスタイル、VFX ブロック、トランジション、ローワーサード、または再利用可能なコンポーネント)を作成し、アップストリーム PR として出荷する場合 — 既存のものをインストールするのではなく — contributing.md のアイデア → スキャフォールド → ビルド → 検証 → プレビュー → 出荷の完全なワークフローに従ってください。コピーペースト可能なスターターテンプレート(キャプション / VFX / コンポーネント / registry-item.json)は templates.md にあります。