Registre HyperFrames
Le registre fournit des blocs et composants réutilisables installables via hyperframes add <nom>.
- Blocs — sous-compositions autonomes (propres dimensions, durée, timeline). Inclus via
data-composition-srcdans une composition hôte. - Composants — snippets d'effets (sans dimensions propres). Collés directement dans le HTML d'une composition hôte.
Référence rapide
hyperframes add data-chart # installer un bloc
hyperframes add grain-overlay # installer un composant
hyperframes add captions # installer tous les blocs tagués 'captions'
hyperframes add shimmer-sweep --dir . # cibler un projet spécifique
hyperframes add data-chart --json # sortie lisible par machine
hyperframes add data-chart --no-clipboard # ignorer le presse-papier (CI/headless)
Après l'installation, la CLI affiche les fichiers écrits et un snippet à coller dans votre composition hôte. Le snippet est un point de départ — vous devrez ajouter les attributs data-composition-id (doit correspondre à l'ID interne du bloc), data-start, et data-track-index lors du câblage des blocs.
La valeur positionnelle est d'abord résolue comme un nom d'élément exact. Si aucun élément ne correspond et que la valeur est un tag, la commande installe tous les blocs avec ce tag. Les dépendances du registre sont installées avant l'élément demandé. hyperframes add fonctionne uniquement pour les blocs et composants ; pour les exemples, utilisez hyperframes init <dir> --example <nom> à la place.
Emplacements d'installation
Les blocs s'installent dans compositions/<nom>.html par défaut. Les composants s'installent dans compositions/components/<nom>.html par défaut.
Ces chemins sont configurables dans hyperframes.json :
{
"registry": "https://raw.githubusercontent.com/heygen-com/hyperframes/main/registry",
"paths": {
"blocks": "compositions",
"components": "compositions/components",
"assets": "assets"
}
}
Voir install-locations.md pour tous les détails.
Câblage des blocs
Les blocs sont des compositions autonomes — incluez-les via data-composition-src dans votre index.html hôte :
<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>
Attributs clés :
data-composition-src— chemin vers le fichier HTML du blocdata-composition-id— doit correspondre à l'ID interne du blocdata-start— moment où le bloc apparaît dans la timeline hôte (secondes)data-duration— durée de lecture du blocdata-width/data-height— dimensions du canevas du blocdata-track-index— ordre des couches (plus élevé = devant)
Voir wiring-blocks.md pour tous les détails.
Câblage des composants
Les composants sont des snippets — collez leur HTML dans le balisage de votre composition, leur CSS dans votre bloc de styles, et leur JS dans votre script (s'il y en a) :
- Lisez le fichier installé (ex.
compositions/components/grain-overlay.html) - Copiez les éléments HTML dans le
<div data-composition-id="...">de votre composition - Copiez le bloc
<style>dans les styles de votre composition - Copiez tout contenu
<script>dans le script de votre composition (avant votre code de timeline) - Si le composant expose une intégration GSAP de timeline (voir le bloc de commentaires dans le snippet), ajoutez ces appels à votre timeline
Voir wiring-components.md pour tous les détails.
Découverte
Utilisez la CLI comme surface de découverte principale. Recherchez par intention avant de naviguer : le registre contient plus d'éléments que vous ne pouvez en parcourir des yeux, donc les lister et les faire correspondre par nom ou tag est la voie lente, et elle échoue chaque fois que le vocabulaire de l'auteur diffère du vôtre.
# Classe tout le catalogue par rapport à ce que le beat doit faire
npx hyperframes catalog --query "révéler un titre ligne par ligne"
npx hyperframes add caption-clip-wipe
La recherche est locale et n'envoie rien. Par défaut, elle classe les éléments en fonction du vocabulaire partagé avec leur nom, titre et description, donc elle ne trouve que les éléments qui réutilisent vos mots ; --on-device classe par sens à la place, après un téléchargement unique du modèle. Avec --json, les enveloppes nomment le niveau qui a répondu, alors vérifiez cela plutôt que de supposer qu'un classement a eu lieu.
Interrogez toujours en anglais, quelle que soit la langue de la vidéo. Le catalogue est rédigé en anglais et les deux niveaux l'indexent ainsi (le modèle sur appareil est également uniquement en anglais). Une requête dans un autre script ne produit aucun terme recherchable et ne renvoie rien du tout. Il est facile de se tromper sur un projet japonais ou chinois, où le brief, les légendes et la narration sont tous dans cette langue et la requête suit naturellement : décrivez le mouvement en anglais, puis écrivez le texte à l'écran dans la langue dont la vidéo a besoin. Si une requête revient avec No searchable words in query, il s'agit de cette règle, pas d'un composant manquant, et cela ne vaut pas un rapport de lacune.
L'installabilité est appliquée après le classement, pas avant : un nom que les vecteurs transportent mais que ce registre ne peut pas servir est supprimé des résultats et compté dans dropped, donc un dropped non nul signifie qu'il s'agit de deux générations différentes. Voir /hyperframes-cli pour le niveau hors ligne, les portes de consentement et la façon d'actualiser un index obsolète.
Pour parcourir ou filtrer au lieu de rechercher :
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
Le tableau normal et les modes --json listent uniquement les correspondances ; installez un nom sélectionné avec hyperframes add <nom>. --human-friendly ouvre un sélecteur interactif et installe l'élément sélectionné immédiatement. Dans les workflows CI ou agent, préférez --json suivi d'un add explicite.
Signaler ce que le catalogue ne contient pas
Lorsque la recherche revient et que rien dans les résultats ne fait l'affaire, dites-le avant d'écrire manuellement le mouvement :
npx hyperframes feedback --search-miss "<la requête que vous avez exécutée>" --wanted "<le mouvement dont vous aviez besoin>" --tier on-device
catalog --query imprime cette ligne pour vous, pré-remplie, et --json la transporte en tant que report_gap — elle est donc déjà en main au moment où vous décidez que rien ne convient.
Signalez chaque fois que rien dans les résultats ne fait l'affaire, sur l'un ou l'autre niveau. N'attendez pas que le niveau sur appareil ait répondu : il nécessite un téléchargement consenti de 33 Mo, donc une exécution d'agent est sur words sauf si elle s'est explicitement abonnée, et se limiter à on-device réduirait au silence presque tous les rapports. La valeur --tier est transmise afin qu'une absence de vocabulaire reste distinguable d'une absence de sens à la lecture. Décrivez l'effet que vous vouliez, pas le nom d'élément que vous imaginiez : ce qui revient est une liste de mouvements valant la peine d'être construits, et un rapport nommant un élément inexistant n'apprend rien. C'est le seul chemin qui envoie une requête, ce qui est précisément pourquoi il s'agit d'une commande délibérée distincte plutôt que de quelque chose que la recherche fait toute seule. Elle ne porte aucune note et n'atterrit jamais dans la métrique de notation.
C'est l'intégralité du signal de demande pour le catalogue. Le sauter signifie que la lacune que vous avez rencontrée est plutôt devinée à partir des comptes d'installation, ce qui ne peut pas voir un mouvement que personne n'a pu installer.
Si la CLI ne peut pas atteindre le registre configuré, inspectez le manifeste brut comme solution de repli :
curl -s https://raw.githubusercontent.com/heygen-com/hyperframes/main/registry/registry.json
Un registre que la CLI ne peut pas atteindre ne vide pas le catalogue pour la découverte : un manifeste précédemment récupéré continue de servir au-delà de sa fenêtre d'actualisation de 24 h chaque fois que la revalidation échoue, donc catalog et catalog --query listent et classent toujours par rapport à la dernière copie sur le disque.
add a toujours besoin du réseau, même pour un élément installé la veille. Seuls les manifestes sont mis en cache ; les fichiers réels de l'élément sont récupérés à chaque installation. Ainsi, hors ligne, vous pouvez rechercher et voir ce qu'est un élément, mais son installation échoue lors de la récupération du fichier. Ne promettez pas à un utilisateur une installation hors ligne.
Le registry-item.json de chaque élément contient : le nom, le type, le titre, la description, les tags, les dimensions (blocs uniquement), la durée (blocs uniquement) et la liste des fichiers.
Voir discovery.md pour les détails sur le filtrage par type et par tag.
Contribuer un nouveau bloc ou composant
Pour créer un NOUVEL élément du registre (style de sous-titres, bloc VFX, transition, tiers inférieur, ou composant réutilisable) et le livrer en tant que PR amont — pas en installer un existant — suivez le flux complet idée → échafaudage → construction → validation → prévisualisation → livraison dans contributing.md. Les modèles de démarrage à copier-coller (sous-titres / VFX / composant / registry-item.json) se trouvent dans templates.md.