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(oucapturedepuis une URL).initvérifie également les skills installés par rapport aux dernières versions sur GitHub et met à jour l'ensemble global si certains 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 derniers skills quoi qu'il arrive. - Écrire — composer le HTML (voir le skill
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 render. - Rendre — choisissez la variante :
- Itérer :
npx hyperframes render --quality draft - Livrer :
npx hyperframes render --quality high --output out.mp4 - CI / reproductibilité inter-machine :
npx hyperframes render --docker --strict --output out.mp4 - Cloud (long / volumineux) :
npx hyperframes lambda render ./my-project --width 1920 --height 1080 --wait(voir Lambda ci-dessous)
- Itérer :
Exécutez lint, validate et inspect avant la prévisualisation. 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 headless 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 annexe *.motion.json est présent, vérifie l'intention de mouvement (déclenchements des entrées sous le parcours, ordre de stagger, dans le cadre, vivacité) par rapport à cette même timeline parcourue.
Pour les projets riches en mouvement, privilégiez l'itération basée sur les snapshots et un fichier annexe *.motion.json — voir references/lint-validate-inspect.md pour la discipline et les spécifications de vérification des mouvements.
Conventions pour les agents
Règles transversales qui s'appliquent à chaque commande :
--jsonest disponible sur toutes les commandes saufrender,previewetplay. Utilisez-le pour toute invocation agent / CI des commandes prises en charge ; la sortie inclut une enveloppe_meta(version CLI, dernière version disponible, conseil de mise à jour).rendersignale 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 --jsonse termine toujours avec le code 0, même si l'environnement est cassé. Filtrez sur le champokdu payload :npx hyperframes doctor --json | jq -e '.ok' > /dev/null. Cela isole les pipelines des changements de version 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 ;initexige 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 copiée en toute sécurité dans les rapports de bug et les contextes d'agent. - Le rendu est soumis à validation 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 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
| Pour… | Lisez |
|---|---|
Créer un projet (init, capture, skills) | references/init-and-scaffold.md |
Vérifier la correction (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 des ressources) | references/upgrade-info-misc.md |
Passerelles entre skills
- 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 des ressources (
tts,transcribe,remove-background) → utilisezhyperframes-mediapour la sélection des 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 CI. Le cycle complet se fait en trois commandes :
npx hyperframes lambda deploy # provisionne la stack SAM (Lambda + Step Functions + S3)
npx hyperframes lambda render ./my-project --width 1920 --height 1080 --wait
npx hyperframes lambda destroy # démantèle (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 les itérations 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 des politiques IAM, les fichiers d'état et les règles de coût / nettoyage.
Barrière de validation minimale
Vérifications statiques
npx hyperframes lint
npx hyperframes validate
Ajoutez inspect pour les travaux sensibles à la mise en page et render --strict en CI pour échouer en cas d'erreurs de lint.
Test visuel de fumée — obligatoire lorsque le projet utilise des sous-compositions
lint / validate / inspect évaluent chaque composition isolément. Ils ne chargent jamais index.html et ne montent pas les 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 »). La seule barrière qui les détecte est celle qui charge effectivement index.html et parcourt la timeline.
Utilisez hyperframes snapshot — il charge le projet de la même manière que render (donc il exerce le même chemin de montage) mais ne capture que les timestamps que vous demandez, ce qui prend des secondes au lieu d'un rendu complet :
# Capture une image au milieu de chaque sous-composition.
# Milieux = data-start + data-duration/2 pour chaque slot 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 se trouve 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 d'échec spécifique que les vérifications statiques ne détectent pas) :
| Ce que vous voyez | Cause racine |
|---|---|
| Le texte apparaît tout petit + sans style 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 agrandis à la taille du canevas | Idem — aucune contrainte de largeur/hauteur appliquée |
| L'élément principal de la scène est complètement absent ; seul l'arrière-plan + le filigrane sont visibles | host-id ≠ template id (Piège 2) — la timeline ne s'est jamais exécutée, image capturée à l'état initial |
La commande snapshot affiche 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 une passe séparée avec npx hyperframes render.