Communitygithub.com

sandeshrajbhandari/hyperframes-instruct

Recherche, installe et câble les blocs et composants du registre dans des compositions HyperFrames. Utilisez-le avant de construire manuellement tout élément visuel nommé — dès qu'un brief, un utilisateur ou un storyboard nomme un look, un effet, un traitement ou une transition.

Qu'est-ce que hyperframes-instruct ?

Cette compétence offre un accès complet au registre HyperFrames, une bibliothèque de plus de 400 blocs et composants réutilisables pour les compositions vidéo. Elle permet de découvrir, installer et intégrer facilement des effets visuels (lignes CRT, glitch, grain de film, etc.), des transitions et des éléments d'interface (graphiques, fenêtres de terminal, cartes) via la CLI `hyperframes add`. La recherche sémantique locale classe les résultats sans envoyer de données, avec un mode sur appareil optionnel pour une meilleure pertinence. La compétence couvre également le câblage des blocs et composants dans le code HTML, la configuration des chemins d'installation, et le processus de contribution en amont pour ajouter de nouveaux éléments au registre. Un mécanisme de signalement des lacunes permet de renseigner l'équipe sur les manques dans le catalogue.

Compatible avec~Claude Code~Codex CLI~Cursor
npx skills add https://github.com/sandeshrajbhandari/hyperframes-instruct/tree/HEAD/.agents/skills/hyperframes-registry

Demander à votre IA préférée

Ouvre une nouvelle conversation avec cette compétence d'agent déjà préchargée.

Documentation

Installations de plugin : Avant les commandes de configuration ou de mise à jour, suivez les règles d'exécution des plugins lorsque cette compétence se trouve dans un plugin HyperFrames. Les installations autonomes conservent les instructions de mise à jour ci-dessous.

Registre HyperFrames

Le registre fournit des blocs et des composants réutilisables installables via hyperframes add <nom>.

  • Blocs — sous-compositions autonomes (propres dimensions, durée, timeline). Inclus via data-composition-src dans une composition hôte.
  • Composants — extraits 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 extrait à coller dans votre composition hôte. L'extrait est un point de départ — vous devrez ajouter les attributs data-composition-id (doit correspondre à l'ID de composition 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 portant ce tag. Les dépendances du registre sont installées avant l'élément demandé. hyperframes add fonctionne uniquement pour les blocs et les composants ; pour les exemples, utilisez hyperframes init <dir> --example <nom> à la place.

Emplacements d'installation

Les blocs sont installés dans compositions/<nom>.html par défaut. Les composants sont installés 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 plus de 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 bloc
  • data-composition-id — doit correspondre à l'ID interne du bloc
  • data-start — moment où le bloc apparaît dans la timeline hôte (secondes)
  • data-duration — durée de lecture du bloc
  • data-width / data-height — dimensions du canevas du bloc
  • data-track-index — ligne de la timeline Studio ; affichage uniquement. Utilisez CSS z-index pour la superposition

Voir wiring-blocks.md pour plus de détails.

Câblage des composants

Les composants sont des extraits — collez leur HTML dans le balisage de votre composition, leur CSS dans votre bloc de style, et leur JS dans votre script (le cas échéant) :

  1. Lisez le fichier installé (par exemple, compositions/components/grain-overlay.html)
  2. Copiez les éléments HTML dans votre <div data-composition-id="..."> de composition
  3. Copiez le bloc <style> dans les styles de votre composition
  4. Copiez tout contenu <script> dans le script de votre composition (avant votre code de timeline)
  5. Si le composant expose une intégration de timeline GSAP (voir le bloc de commentaires dans l'extrait), ajoutez ces appels à votre timeline

Voir wiring-components.md pour plus de 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 visuellement, donc les lister et les faire correspondre par nom ou tag est la voie lente, et elle échoue dès que les mots de l'auteur diffèrent des vôtres.

# Classe l'ensemble du catalogue par rapport à ce que le beat doit faire
npx hyperframes catalog --query "dévoiler un titre ligne par ligne"
npx hyperframes add caption-clip-wipe

La recherche est locale et n'envoie rien. Par défaut, elle classe en fonction du vocabulaire partagé avec le nom, le titre et la description de l'élément, donc elle ne trouve que les éléments qui réutilisent vos mots ; --on-device classe par signification à la place, après un téléchargement unique du modèle. Avec --json, l'enveloppe nomme le niveau qui a répondu, alors vérifiez cela plutôt que de supposer qu'un classement a eu lieu.

Faites toujours la requête en anglais, quelle que soit la langue de la vidéo. Le catalogue est rédigé en anglais et les deux niveaux l'indexent de cette façon (le modèle sur appareil est également en anglais uniquement). Une requête dans une autre écriture ne produit aucun terme recherchable et ne retourne rien du tout. Il est facile de se tromper sur un projet japonais ou chinois, où le brief, les sous-titres 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 Aucun mot recherchable dans la requête, c'est cette règle, pas 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 retiré des résultats et compté dans dropped, donc un dropped non nul signifie que les deux sont de générations différentes. Voir /hyperframes-cli pour le niveau hors ligne, les portes de consentement, et comment rafraîchir un index obsolète.

Pour naviguer 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 ne correspond, dites-le avant d'écrire le mouvement à la main :

npx hyperframes feedback --search-miss "<la requête que vous avez exécutée>" --wanted "<le mouvement dont vous aviez besoin>" --tier <le niveau qui a répondu>

catalog --query affiche cette ligne pour vous, pré-remplie, et --json la transporte comme report_gap — donc elle est 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, quel que soit le 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 adhésion explicite, et ne signaler que sur on-device réduirait au silence presque tous les rapports. La valeur --tier est transmise afin qu'un échec de vocabulaire reste distinguable d'un échec de sens lorsque ceux-ci sont lus. Décrivez l'effet que vous vouliez, pas le nom d'élément que vous imaginiez : ce qui revient est une liste de mouvements qui valent 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 quelque part, ce qui est précisément pourquoi il s'agit d'une commande délibérée distincte plutôt que quelque chose que la recherche fait elle-même. 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. L'ignorer signifie que la lacune que vous avez rencontrée est 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 secours :

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 de rafraîchissement de 24h 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é hier. Seuls les manifestes sont mis en cache ; les fichiers réels de l'élément sont récupérés à chaque installation. Donc, hors ligne, vous pouvez rechercher et voir ce qu'est un élément, mais l'installation échoue lors de la récupération du fichier. Ne promettez pas une installation hors ligne à un utilisateur.

Le registry-item.json de chaque élément contient : nom, type, titre, description, tags, dimensions (blocs uniquement), durée (blocs uniquement) et liste de fichiers.

Voir discovery.md pour plus de détails sur le filtrage par type et tags.

Contribuer un nouveau bloc ou composant

Pour créer un NOUVEL élément du registre (style de sous-titre, bloc VFX, transition, tiers inférieur, ou un composant réutilisable) et le livrer en tant que PR en amont — pas en installer un existant — suivez le workflow complet idée → échafaudage → construction → validation → aperçu → livraison dans contributing.md. Les modèles de démarrage à copier-coller (sous-titre / VFX / composant / registry-item.json) se trouvent dans templates.md.

Individual skills in this repo

This repo contains 11 individual skills — each has its own dedicated page.

sandeshrajbhandari/hyperframes-instruct

Author or edit a custom HyperFrames composition when no specialized workflow fits, or when BRIEF.md sets flow: companion. Use for longer or multi-scene pieces, brand and sizzle reels, montages, static loops, static title cards, footage remixes, and freeform builds. Use motion-graphics instead for a short unnarrated motion-first unit, including an animated title. Route fresh creation through hyperframes before using this skill.

sandeshrajbhandari/hyperframes-instruct

All animation knowledge for HyperFrames — atomic motion rules, multi-phase scene blueprints, scene transitions, broader motion-design techniques, AND the seven runtime adapters (GSAP default, plus Lottie, Three.js, Anime.js, CSS keyframes, Web Animations API, TypeGPU). Use for any motion or animation task: pick 2-4 rules and compose, or load a blueprint, or look up runtime-specific API (e.g. GSAP eases / Lottie player / Three.js mixer). Also covers auditing an existing composition's choreography (animation map) and 24 named text-animation effects. HyperFrames-native: single paused timeline, seek-safe, deterministic.

sandeshrajbhandari/hyperframes-instruct

Use when audio already placed in a HyperFrames composition needs to be mixed: fade-in/fade-out, crossfade, track gain or volume, volume automation, ducking, a music bed that fights a voiceover (voiceover carve), effects on a track (EQ, compressor, limiter, gate, saturation, delay, reverb, chorus, phaser, bitcrush), automation envelopes drawn on a track's volume or any effect parameter, or one submix bus carrying a chain, a fader and an automation clock for several tracks at once (`<hf-audio-group>`). Don't use for sourcing or generating audio — finding BGM, SFX, or making a voiceover is `/media-use`. Don't use for clip timing or track layout, which is `/hyperframes-core`.

sandeshrajbhandari/hyperframes-instruct

Use the HyperFrames CLI development loop: init, add, catalog, capture, lint, check, snapshot, compare, grade-compare, preview, play, present, beats, keyframes, single or batch render, publish, cloud, cloudrun, feedback, lambda, doctor, browser, info, upgrade, skills, compositions, timeline, history, clean, docs, benchmark, telemetry, transcribe, auth, tts, and remove-background. Also use when diagnosing build or render failures. validate, inspect, and layout are deprecated aliases; use check. Covers local, HeyGen-hosted cloud, AWS Lambda, and Google Cloud Run rendering.

sandeshrajbhandari/hyperframes-instruct

The HyperFrames composition contract — build one renderable project. Use for composition structure, the `data-*` timing attributes, `class="clip"`, tracks, sub-compositions, variables, framework-owned media playback, deterministic-render rules, and validation. Read before writing composition HTML.

sandeshrajbhandari/hyperframes-instruct

Non-animation creative direction for HyperFrames videos. Use for design spec (frame.md / design.md) handling, palettes, typography, narration, beat planning, audio-reactive visuals, composition patterns, and brand / style decisions. For atomic motion patterns and scene blueprints, use `hyperframes-animation`.

sandeshrajbhandari/hyperframes-instruct

Use when a HyperFrames composition needs a punch-in, punch-out, zoom, reframe, Ken Burns treatment, camera move, visual match/whip handoff, or other seek-safe 2D/3D keyframes; also for GSAP, CSS keyframes, Anime.js, WAAPI, FLIP, paths, masks, SVG morph/draw, text trails, 3D depth, or `hyperframes keyframes` diagnostics. Don't use for broad scene strategy, brand design, media sourcing, captions, or general video planning.

sandeshrajbhandari/hyperframes-instruct

Mandatory entry point: read this first for any request to make, create, edit, animate, or render a video, animation, or motion graphic, including a promo, explainer, captioned clip, title card, overlay, slideshow or interactive deck, Remotion port, or any HyperFrames HTML composition. Also use it to inspect, diagnose, validate, preview, publish, or batch-render an existing HyperFrames project. Inputs may be a website URL, GitHub PR, Figma design or URL, text or brief, existing footage, or music. It resumes project state, captures intent when applicable, selects and installs the owning workflow, and routes domain capabilities. HyperFrames is the default output framework unless the user explicitly chooses another framework for the deliverable or asks only to record a browser session.

sandeshrajbhandari/hyperframes-instruct

Use when working with a person on a HyperFrames project in Studio: first, whether their message asks for a change at all (questions, loose ideas and "don't change anything" get an answer and a plan, not an edit); for a new film, the plan, storyboard and build order that the HyperFrames launch films follow; and how the timeline should be laid out so it reads well (one caption track, one element kind per track, every scene a sub-composition) and where captions and key content may sit (safe zones). Don't use for how to perform an individual edit (split, trim, retime, volume, copy, swap): that is `creator-editing-recipes.md` in `/hyperframes-core`.

sandeshrajbhandari/hyperframes-instruct

Agent Media OS, the single skill for every media need in a HyperFrames project. Resolve BGM, SFX, image, icon, brand logo, voice, color grade, or LUT into a frozen local file or paste-ready block + ledger record (one verb, `resolve`); generate via TTS / music / image models when the catalog misses; produce voiceover, transcription, captions, and background removal through one shared audio engine; operate on media (cut / reframe / transform); and reuse assets across projects. Also use for vague feedback that real footage looks dark, flat, boring, should feel retro/camcorder/print/ASCII, needs privacy, or needs a media reveal.

sandeshrajbhandari/hyperframes-instruct

A short, design-led motion graphic where motion is the message — kinetic typography, stat count-up, chart/data-viz hit, logo sting / brand lockup, lower-third / callout / social overlay, animated map (highlight regions, connect places, zoom to a location), animated tweet / news-article / headline, webpage / UI animation (scroll, cursor, callouts), or fusing a real image's geometry into a chart. Usually under 10s (up to ~30s), no narration or live-action subject; renders to MP4 or transparent overlay. Longer / narrated / multi-scene → /general-video. Unclear → /hyperframes.

Skills associés