HyperFrames CLI
Tout s'exécute via npx hyperframes sauf si les instructions du projet spécifient un wrapper local. Respectez exactement le wrapper local. Nécessite Node.js >= 22 et FFmpeg.
Workflow
- Scaffold —
npx hyperframes init my-video(oucapturedepuis une URL) - Écrire — composer la composition HTML (voir la compétence
hyperframes-core) - Lint —
npx hyperframes lint - Valider —
npx hyperframes validate(erreurs runtime + contraste) - Inspection visuelle —
npx hyperframes inspect - Aperçu —
npx hyperframes previewouvre Studio, l'éditeur de timeline où l'utilisateur peut tout modifier manuellement (pas seulement regarder). Examinez-y le contenu, puis demandez avant de lancer le rendu. - Rendu — Choisissez la variante :
- Itérer :
npx hyperframes render --quality draft - Livrer :
npx hyperframes render --quality high --output out.mp4 - CI / reproduction cross-host :
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 l'aperçu. 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 console runtime ainsi que les problèmes de contraste WCAG. inspect parcourt la timeline et signale les textes qui débordent des bulles/conteneurs ou du canevas — et, lorsqu'un fichier sidecar *.motion.json est présent, vérifie l'intention de mouvement (déclenchements lors du seek, ordre de stagger, dans le cadre, vivacité) par rapport à la même timeline parcourue.
Pour les travaux lourds en animation, privilégiez une itération basée sur les snapshots et un fichier sidecar *.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 applicables à chaque commande :
--jsonest disponible sur toutes les commandes saufrender,previewetplay. Utilisez-le pour toute invocation par agent / CI des commandes prises en charge ; la sortie inclut une enveloppe_meta(version CLI, dernière disponible, conseil de mise à jour).rendersignale le statut 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 défaillant. Basez-vous sur le champokdu payload :npx hyperframes doctor --json | jq -e '.ok' > /dev/null. Cela isole les pipelines des fluctuations de version de la CLI.- Le mode non-TTY est automatiquement détecté. Lorsque
stdoutn'est pas un TTY (CI, agents, sortie redirigée), la CLI passe 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 anonymisés —$HOMEdevient le littéral$HOMEafin que la sortie puisse être collée en toute sécurité dans des rapports de bugs et des contextes d'agents. - Le rendu est soumis à validation utilisateur. Ne lancez jamais automatiquement le rendu une fois les vérifications passées. Faites une pause à l'aperçu, informez l'utilisateur que la vidéo est modifiable dans Studio, et ne faites le rendu qu'après son approbation.
- Vérification post-rendu. Après que
rendera renvoyé un 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.
Aiguillage
| 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 faire le rendu (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 |
Transmissions Inter-compétences
- Projets Tailwind (
init --tailwind) → utilisezhyperframes-core(référence Tailwind) avant de modifier les classes ou les tokens de thème. - Composants/Blocs 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 actifs (
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 portable ou votre CI. De bout en bout, cela nécessite 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 (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 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.
Seuil de Complétion Minimum
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 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 entre 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 (il exerce donc 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 point médian de chaque sous-composition.
# Points médians = 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
Le résultat 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 de défaillance spécifique que les portes 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'atteint le DOM actif |
| Éléments SVG/icônes agrandis à la taille du canevas | Idem ci-dessus — aucune contrainte de largeur/hauteur appliquée |
| L'élément principal de la scène est totalement absent ; seuls le fond et 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 Timelines des sous-compositions non enregistrées après 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.