CLI HyperFrames
Tout passe par npx hyperframes sauf si les instructions du projet spécifient un wrapper local. Suivez le wrapper local à la lettre. Nécessite Node.js >= 22 et FFmpeg.
Flux de travail
- Scaffold —
npx hyperframes init my-video(oucapturedepuis une URL) - É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 modifier manuellement n'importe quoi (pas seulement regarder). Examinez là, puis demandez avant de rendre. - Rendre — choisissez la variante :
- Itération :
npx hyperframes render --quality draft - Livraison :
npx hyperframes render --quality high --output out.mp4 - CI / reproduction multi-hôte :
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ération :
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 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 sidecar *.motion.json est présent, vérifie l'intention de mouvement (entrées qui se déclenchent sous le seek, ordre de stagger, dans le cadre, vivacité) sur cette même timeline seekée.
Pour les travaux axés sur le mouvement, préférez une itération basée sur les snapshots et un sidecar *.motion.json — voir references/lint-validate-inspect.md pour la discipline et les spécifications de vérification des mouvements.
Conventions pour l'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).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 par 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 CLI.- Le mode non-TTY est détecté automatiquement. Lorsque
stdoutn'est pas un TTY (CI, agents, sortie redirigée), la CLI bascule automatiquement en mode non-interactif ;initnécessite alors--example. Passez--non-interactivepour forcer ce mode même sur un TTY. - Filtrage 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$HOMEafin que la sortie puisse être collée en toute sécurité dans les rapports de bugs et les contextes d'agent. - 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
renderrenvoie le code de sortie 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". La 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
| Pour… | Lire |
|---|---|
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 des assets) | references/upgrade-info-misc.md |
Délégations 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 des assets (
tts,transcribe,remove-background) → utilisezhyperframes-mediapour la sélection de la 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, cela se fait en 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é les identifiants AWS. Pour les itérations en boucle de développement, restez sur render en 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.
Goulot d'étranglement de complétion minimale
Goulots 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 — 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 les sous-compositions via data-composition-src, ils ne peuvent donc pas détecter les échecs de montage inter-fichiers (voir hyperframes-core → references/sub-compositions.md, « Pièges courants »). Le seul goulot qui les détecte est celui qui charge réellement index.html et parcourt la timeline.
Utilisez hyperframes snapshot — il charge le projet de la même manière que render (il exerce donc le même chemin de montage) mais ne capture que les horodatages que vous demandez, donc cela 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 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 uniformément 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 goulots 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ô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 complètement manquant ; seul l'arrière-plan + le filigrane sont visibles | 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 Les timelines de sous-composition ne sont pas enregistrées après 45000ms | Piège 2 — confirmation directe |
snapshots/ peut être supprimé après examen ; le rendu final visible par l'utilisateur est une passe séparée avec npx hyperframes render.