CLI HyperFrames
Tout passe par npx hyperframes sauf si les instructions du projet spécifient un wrapper local. Obéissez exactement au wrapper local. Nécessite Node.js >= 22 et FFmpeg.
Workflow
- Scaffold —
npx hyperframes init my-video(oucaptureà partir d'une URL).initvérifie également les compétences installées par rapport aux dernières sur GitHub et met à jour l'ensemble global si certaines sont obsolètes. Le flag--skip-skillsest actuellement neutralisé (temporairement, en attendant que le registre skills.sh rattrape son retard), donc chaqueinitexécute cette vérification et récupère nos dernières compétences quoi qu'il arrive. - Écrire — rédiger la composition HTML (voir la compétence
hyperframes-core) - Lint —
npx hyperframes lint - Valider —
npx hyperframes validate(erreurs d'exécution + contraste) - Inspection visuelle —
npx hyperframes inspect - Prévisualiser —
npx hyperframes previewouvre Studio, l'éditeur de timeline où l'utilisateur peut tout éditer manuellement (pas seulement regarder). Examinez-y, puis demandez avant de rendre. - Rendre — choisissez la variante :
- Itérer :
npx hyperframes render --quality draft - Livrer :
npx hyperframes render --quality high --output out.mp4 - CI / reproductibilité multi-hôte :
npx hyperframes render --docker --strict --output out.mp4 - Cloud (long / grand) :
npx hyperframes lambda render ./my-project --width 1920 --height 1080 --wait(voir Lambda ci-dessous)
- Itérer :
Exécutez lint, validate et inspect avant preview. lint détecte les data-composition-id manquants, les pistes qui se chevauchent et les timelines non enregistrées. validate charge la composition dans Chrome sans tête et signale les erreurs console d'exécution ainsi que les problèmes de contraste WCAG. inspect parcourt la timeline et signale le texte qui dépasse des bulles/conteneurs ou du canevas — et, lorsqu'un fichier *.motion.json est présent, vérifie l'intention de mouvement (déclenchements d'entrées sous le parcours, ordre de stagger, dans le cadre, vivacité) par rapport à cette même timeline parcourue.
Pour les travaux riches en mouvement, privilégiez l'itération basée sur les instantanés et un fichier *.motion.json — voir references/lint-validate-inspect.md pour la discipline et les spécifications de vérification de mouvement.
Conventions pour les agents
Règles transversales qui s'appliquent à chaque commande :
--jsonest disponible sur chaque commande saufrender,previewetplay. Utilisez-le pour toute invocation agent / CI des commandes prises en charge ; la sortie inclut une enveloppe_meta(version CLI, dernière disponible, conseil de mise à jour).renderrapporte l'état via stdout + code de sortie uniquement — vérifiez le succès avec la vérification post-rendu ci-dessous ;preview/playsont des serveurs, pas de JSON.doctor --jsontermine toujours avec le code 0, même lorsque l'environnement est cassé. Filtrez sur le champokdu payload :npx hyperframes doctor --json | jq -e '.ok' > /dev/null. Cela isole les pipelines des fluctuations des versions du CLI.- Le mode non-TTY est détecté automatiquement. Lorsque
stdoutn'est pas un TTY (CI, agents, sortie redirigée), le CLI bascule automatiquement en mode non-interactif ;initnécessite alors--example. Passez--non-interactivepour forcer ce mode même sur un TTY. - Gating CI sur le rendu :
--strictéchoue sur les erreurs de lint,--strict-alléchoue aussi sur les avertissements,--strict-variableséchoue sur les clés--variablesnon déclarées. - Les chemins dans
--jsonsont masqués —$HOMEdevient le littéral$HOMEpour que la sortie puisse être collée en toute sécurité dans des rapports de bug et des contextes d'agents. - Le rendu est soumis à l'approbation de l'utilisateur. Ne lancez jamais le rendu automatiquement une fois les vérifications passées. Faites une pause à
preview, dites à l'utilisateur que la vidéo est modifiable dans Studio, et ne rendez qu'après son approbation. - Vérification post-rendu. Après que
renderretourne le code 0, confirmez que le fichier de sortie existe et a une taille plausible avant de signaler le succès :[ -s "$OUTPUT" ] || echo "render n'a produit aucune sortie". Le CLI affiche◇ <chemin>en cas de succès ; pour les longs rendus, vérifiez aussi la durée avecffprobe -i "$OUTPUT" -show_format -v error.
Routage
| Vous voulez... | Lisez |
|---|---|
Scaffolder un projet (init, capture, skills) | references/init-and-scaffold.md |
Vérifier l'exactitude (lint, validate, inspect, snapshot) | references/lint-validate-inspect.md |
Prévisualiser ou rendre (preview, play, render, publish) | references/preview-render.md |
Diagnostiquer l'environnement (doctor, browser) | references/doctor-browser.md |
Rendu cloud sur AWS Lambda (lambda deploy / sites / render / progress / destroy / policies) | references/lambda.md |
Tout le reste (info, upgrade, compositions, docs, benchmark, telemetry, prétraitement d'actifs) | references/upgrade-info-misc.md |
Passerelles entre compétences
- Projets Tailwind (
init --tailwind) → utilisezhyperframes-core(référence Tailwind) avant de modifier les classes ou les tokens de thème. - Blocs/composants du registre (
hyperframes add,hyperframes catalog) → utilisezhyperframes-registrypour les chemins d'installation, le câblage des sous-compositions et la fusion d'extraits. - Prétraitement d'actifs (
tts,transcribe,remove-background) → utilisezhyperframes-mediapour la sélection de voix, les règles du modèle Whisper, les sous-titres et la chaîne TTS-vers-sous-titres. - Rendus paramétrés (
--variables) → déclarés viadata-composition-variablessur<html>; voirhyperframes-corepour le schéma complet.
Lambda (Rendu cloud)
hyperframes lambda déploie le rendu distribué sur AWS Lambda et pilote les rendus depuis votre ordinateur ou votre CI. De bout en bout, trois commandes :
npx hyperframes lambda deploy # provisionner la pile SAM (Lambda + Step Functions + S3)
npx hyperframes lambda render ./my-project --width 1920 --height 1080 --wait
npx hyperframes lambda destroy # démanteler (le bucket S3 est conservé)
Utilisez Lambda lorsqu'un rendu est trop long / trop volumineux pour un seul hôte (vidéos de plusieurs minutes, 4K, grands lots parallèles) et que vous avez configuré des identifiants AWS. Pour l'itération en boucle de développement, restez sur le render local.
Voir references/lambda.md pour les prérequis, les 6 sous-commandes (deploy, sites create, render, progress, destroy, policies), la validation de politique IAM, les fichiers d'état, et les règles de coût / nettoyage.
Seuil de validation minimal
Vérifications statiques
npx hyperframes lint
npx hyperframes validate
Ajoutez inspect pour les travaux sensibles à la mise en page et render --strict dans le CI pour échouer sur les erreurs de lint.
Test visuel rapide — requis lorsque le projet utilise des sous-compositions
lint / validate / inspect évaluent chaque composition de manière isolée. Ils ne chargent jamais index.html et ne montent pas de sous-compositions via data-composition-src, donc ils ne peuvent pas détecter les échecs de montage inter-fichiers (voir hyperframes-core → references/sub-compositions.md, « Pièges courants »). Le seul moyen de les détecter est de charger index.html et de parcourir la timeline.
Utilisez hyperframes snapshot — il charge le projet de la même manière que render (exerçant donc le même chemin de montage) mais ne capture que les instants que vous demandez, donc c'est l'affaire de secondes au lieu d'un rendu complet :
# Capturer une image au milieu de chaque sous-composition.
# Milieux = data-start + data-duration/2 pour chaque emplacement hôte dans index.html.
npx hyperframes snapshot --at <t1>,<t2>,<t3>,...
# Ou, si vous n'avez pas besoin de ciblage par scène, un échantillon régulièrement espacé :
npx hyperframes snapshot --frames 9
La sortie atterrit dans snapshots/frame-NN-at-Xs.png. Examinez chaque image par rapport au plan de scène.
Drapeaux rouges par image (chacun correspond à un mode de défaillance spécifique que les vérifications statiques ne détectent pas) :
| Ce que vous voyez | Cause racine |
|---|---|
| Le texte apparaît tout petit + non stylé dans le coin supérieur gauche | Bloc <style> laissé dans <head> en dehors de <template> (Piège 1) — aucun CSS n'a atteint le DOM en direct |
| Les éléments SVG/icône sont gonflés à la taille du canevas | Idem — aucune contrainte de largeur/hauteur appliquée |
| L'élément principal de la scène est totalement absent ; seul l'arrière-plan + filigrane visible | host-id ≠ template id (Piège 2) — la timeline n'a jamais été exécutée, image capturée à l'état initial |
La commande snapshot enregistre Sub-composition timelines not registered after 45000ms | Piège 2 — confirmation directe |
snapshots/ peut être supprimé après examen ; le rendu final destiné à l'utilisateur est un passage séparé avec npx hyperframes render.