HyperFrames CLI
Tout passe par npx hyperframes sauf si les instructions du projet spécifient un wrapper local. Suis exactement le wrapper local. Nécessite Node.js >= 22 et FFmpeg.
Workflow
- Scaffold —
npx hyperframes init my-video(oucapturedepuis une URL).initvérifie aussi 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, pendant que le registre skills.sh se rattrape), donc chaqueinitexécute cette vérification et récupère nos dernières compétences quoi qu'il arrive. - Écrire — rédige 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 - Prévisualiser —
npx hyperframes previewouvre Studio, l'éditeur de timeline où l'utilisateur peut modifier manuellement n'importe quoi (pas seulement regarder). Vérifie là, puis demande avant de rendre. - Rendre — choisis la variante :
- Itérer :
npx hyperframes render --quality draft - Livrer :
npx hyperframes render --quality high --output out.mp4 - CI / repro 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érer :
Exécute 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 rapporte les erreurs 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 canvas — et, quand un fichier sidecar *.motion.json est présent, vérifie l'intention de mouvement (entrées qui se déclenchent sous seek, ordre d'étagement, dans le cadre, vivacité) par rapport à cette même timeline parcourue.
Pour les travaux axés sur le mouvement, préfère une itération basée sur des snapshots et un sidecar *.motion.json — voir references/lint-validate-inspect.md pour la discipline et les spécifications de vérification de mouvement.
Conventions d'Agent
Règles transversales qui s'appliquent à chaque commande :
--jsonest disponible sur chaque commande saufrender,previewetplay. Utilise-le pour toute invocation agent / CI des commandes supportées ; la sortie inclut une enveloppe_meta(version CLI, dernière disponible, conseil de mise à jour).renderrapporte le statut via stdout + code de sortie uniquement — vérifie le succès avec la vérification post-rendu ci-dessous ;preview/playsont des serveurs, pas de JSON.doctor --jsonretourne toujours 0, même si l'environnement est cassé. Teste le champokdu payload :npx hyperframes doctor --json | jq -e '.ok' > /dev/null. Cela isole les pipelines des changements de release CLI.- Le mode non-TTY est détecté automatiquement. Quand
stdoutn'est pas un TTY (CI, agents, sortie redirigée), la CLI bascule automatiquement en mode non-interactif ;initnécessite alors--example. Passe--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$HOMEpour que la sortie soit sûre à copier dans les rapports de bugs et les contextes d'agent. - Le rendu est soumis à validation de l'utilisateur. Ne rends jamais automatiquement une fois les vérifications passées. Pause à
preview, dis à l'utilisateur que la vidéo est modifiable dans Studio, et rends uniquement après son approbation. - Vérification post-rendu. Après que
renderretourne exit 0, confirme que le fichier de sortie existe et a une taille plausible avant de signaler le succès :[ -s "$OUTPUT" ] || echo "render produced no output". La CLI imprime◇ <path>en cas de succès ; pour les longs rendus, vérifie aussi la durée avecffprobe -i "$OUTPUT" -show_format -v error.
Routage
| Pour… | Lis |
|---|---|
Scaffolder 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 d'actifs) | references/upgrade-info-misc.md |
Passerelles entre Compétences
- Projets Tailwind (
init --tailwind) → utilisehyperframes-core(référence Tailwind) avant de modifier des classes ou des thèmes. - Blocs/composants du registre (
hyperframes add,hyperframes catalog) → utilisehyperframes-registrypour les chemins d'installation, le câblage des sous-compositions et la fusion d'extraits. - Prétraitement d'actifs (
tts,transcribe,remove-background) → utilisehyperframes-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 un rendu distribué sur AWS Lambda et pilote les rendus depuis votre laptop ou CI. De bout en bout, 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étruit (le bucket S3 est conservé)
Utilise Lambda quand un rendu est trop long / trop volumineux pour un seul hôte (vidéos multi-minutes, 4K, lots parallèles importants) et que tu as des credentials AWS configurés. Pour l'itération en boucle de développement, reste 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.
Passerelle de Complétion Minimale
Passerelles statiques
npx hyperframes lint
npx hyperframes validate
Ajoute 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 quand 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 cross-fichier (voir hyperframes-core → references/sub-compositions.md, « Pièges courants »). La seule passerelle qui les détecte est celle qui charge réellement index.html et parcourt la timeline.
Utilise 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 demandés, donc c'est en quelques 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 tu n'as 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. Vérifie chaque image par rapport au plan de scène.
Drapeaux rouges par image (chacun correspond à un mode d'échec spécifique que les passerelles statiques manquent) :
| Ce que tu vois | Cause racine |
|---|---|
| Texte 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 vivant |
| Éléments SVG/icônes agrandis à la taille du canvas | Même chose — aucune contrainte de largeur/hauteur appliquée |
| L'élément hero de la scène est complètement absent ; seul le fond + watermark visibles | Host-id ≠ template id (Piège 2) — la timeline n'a jamais tourné, image capturée à l'état initial |
La commande snapshot log Sub-composition timelines not registered after 45000ms | Piège 2 — confirmation directe |
snapshots/ peut être supprimé après vérification ; le rendu final destiné à l'utilisateur est un passage séparé avec npx hyperframes render.