CLI HyperFrames
Tout passe par npx hyperframes sauf si les instructions du projet spécifient un wrapper local. Respectez ce wrapper local à la lettre. Nécessite Node.js >= 22 et FFmpeg.
Workflow
- Scaffold —
npx hyperframes init my-video(oucapturedepuis une URL) - Écrire — composer le 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 preview - Rendre — choisissez la variante :
- Itérer :
npx hyperframes render --quality draft - Livrer :
npx hyperframes render --quality high --output out.mp4 - CI / reproductibilité multi-hôtes :
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 rapporte les erreurs de console runtime 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 (entrées déclenchées sous seek, ordre de stagger, dans le cadre, vivacité) par rapport à cette même timeline parcourue.
Pour les travaux axés sur le mouvement, privilégiez l'itération basée sur les snapshots et un fichier *.motion.json — voir references/lint-validate-inspect.md pour la discipline et les spécifications de vérification du mouvement.
Conventions Agent
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 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 --jsonse termine toujours par 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 ;initnécessite alors--example. Passez--non-interactivepour forcer ce mode même sur un TTY. - Porte de contrôle CI sur le rendu :
--strictéchoue sur les erreurs 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$HOMEafin que la sortie puisse être collée en toute sécurité dans les rapports de bug et les contextes agents. - Vérification post-rendu. Après que
renderrenvoie le code 0, confirmez que le fichier de sortie existe et a une taille plausible avant de signaler le succès :[ -s "$OUTPUT" ] || echo "le rendu n'a produit aucune sortie". Le CLI imprime◇ <chemin>en cas de succès ; pour les rendus longs, vérifiez aussi la durée avecffprobe -i "$OUTPUT" -show_format -v error.
Routage
| Vous voulez… | Lisez |
|---|---|
Créer 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 assets) | 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 des snippets. - Prétraitement des assets (
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 machine ou votre CI. De bout en bout, trois commandes :
npx hyperframes lambda deploy # provisionne la pile SAM (Lambda + Step Functions + S3)
npx hyperframes lambda render ./my-project --width 1920 --height 1080 --wait
npx hyperframes lambda destroy # démantèle la pile (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, gros lots parallèles) et que vous avez configuré des identifiants AWS. Pour l'itération en boucle de développement, restez sur le rendu local (render).
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.
Porte de Complétion Minimale
Portes statiques
npx hyperframes lint
npx hyperframes validate
Ajoutez inspect pour les travaux sensibles à la mise en page et render --strict en CI pour échouer sur les erreurs lint.
Test visuel de fumée — requis lorsque le projet utilise des sous-compositions
lint / validate / inspect évaluent chaque composition en isolation. 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 porte 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 exécute le même chemin de montage) mais ne capture que les timestamps que vous demandez, donc c'est une question de secondes au lieu d'un rendu complet :
# Capture 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 la scène.
Drapeaux rouges par image (chacun correspond à un mode d'échec spécifique que les portes statiques ne détectent pas) :
| Ce que vous voyez | Cause racine |
|---|---|
| Le texte apparaît minuscule + 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 |
| Les éléments SVG/icônes sont agrandis à la taille du canevas | Identique ci-dessus — aucune contrainte de largeur/hauteur appliquée |
| L'élément principal de la scène est totalement absent ; seul fond + filigrane visible | L'identifiant hôte ≠ identifiant template (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 l'examen ; le rendu final utilisable est une passe séparée avec npx hyperframes render.