HyperFrames CLI
Tout s'exécute via npx hyperframes. Nécessite Node.js >= 22 et FFmpeg.
Workflow
- Scaffold —
npx hyperframes init mon-video - Écrire — composer le HTML (voir la compétence
hyperframes) - Lint —
npx hyperframes lint - Inspection visuelle —
npx hyperframes inspect - Aperçu —
npx hyperframes preview - Rendu —
npx hyperframes render
Effectuez le lint et l'inspection avant l'aperçu. lint détecte les data-composition-id manquants, les pistes qui se chevauchent et les timelines non enregistrées. inspect ouvre la composition rendue dans Chrome sans tête, parcourt la timeline et signale le texte qui dépasse des bulles/containers ou du canevas.
Scaffolding
npx hyperframes init mon-video # assistant interactif
npx hyperframes init mon-video --example warm-grain # choisir un exemple
npx hyperframes init mon-video --video clip.mp4 # avec fichier vidéo
npx hyperframes init mon-video --audio piste.mp3 # avec fichier audio
npx hyperframes init mon-video --example blank --tailwind # avec le runtime navigateur Tailwind v4
npx hyperframes init mon-video --non-interactive # ignorer les invites (CI/agents)
Modèles : blank, warm-grain, play-mode, swiss-grid, vignelli, decision-tree, kinetic-type, product-promo, nyt-graph.
init crée la bonne structure de fichiers, copie les médias, transcrit l'audio avec Whisper et installe les compétences AI. Utilisez-le plutôt que de créer les fichiers à la main.
Lorsque vous utilisez --tailwind, invoquez la compétence tailwind avant de modifier les classes ou les jetons de thème. Le scaffold utilise Tailwind v4.2 via le runtime navigateur, pas la configuration Tailwind v3 de Studio.
Linting
npx hyperframes lint # répertoire courant
npx hyperframes lint ./mon-projet # projet spécifique
npx hyperframes lint --verbose # constatations de niveau info
npx hyperframes lint --json # lisible par machine
Analyse index.html et tous les fichiers dans compositions/. Signale les erreurs (à corriger), les avertissements (devrait corriger) et les infos (avec --verbose).
Inspection Visuelle
npx hyperframes inspect # inspecte la mise en page rendue sur la timeline
npx hyperframes inspect ./mon-projet # projet spécifique
npx hyperframes inspect --json # constatations lisibles par agent
npx hyperframes inspect --samples 15 # balayage plus dense de la timeline
npx hyperframes inspect --at 1.5,4,7.25 # horodatages explicites des images-clés
Utilisez cette commande après lint et validate, en particulier pour les compositions avec des bulles de parole, des cartes, des légendes ou une typographie serrée. Elle signale :
- Texte s'étendant en dehors du conteneur visuel ou de la bulle le plus proche
- Texte rogné par sa propre boîte à largeur/hauteur fixe
- Texte s'étendant en dehors du canevas de la composition
- Enfants s'échappant des conteneurs de rognage
Les erreurs doivent être corrigées avant le rendu. Les avertissements sont remontés pour examen par l'agent ; ajoutez --strict pour échouer aussi sur les avertissements. Les problèmes statiques répétés sont réduits par défaut afin que la sortie JSON reste compacte pour les fenêtres de contexte LLM. Si un débordement est intentionnel pour une animation d'entrée/sortie, marquez l'élément ou l'ancêtre avec data-layout-allow-overflow. Si un élément décoratif ne doit jamais être audité, marquez-le avec data-layout-ignore.
npx hyperframes layout reste disponible comme alias de compatibilité pour la même passe d'inspection visuelle.
Aperçu
npx hyperframes preview # sert le répertoire courant
npx hyperframes preview --port 4567 # port personnalisé (défaut 3002)
Rechargement à chaud sur les modifications de fichiers. Ouvre le studio dans votre navigateur automatiquement.
Lorsque vous rendez un projet à l'utilisateur, utilisez l'URL du projet Studio, pas le chemin source index.html :
http://localhost:<port>/#project/<nom-du-projet>
Utilisez le port réel de la sortie d'aperçu et le nom du répertoire du projet. Par exemple, après npx hyperframes preview --port 3017 dans codex-openai-video, indiquez http://localhost:3017/#project/codex-openai-video.
Considérez index.html uniquement comme un contexte de code source. Il est acceptable de le lier en tant que fichier d'implémentation, mais ne le qualifiez pas de projet ou de surface d'aperçu.
Rendu
npx hyperframes render # MP4 standard
npx hyperframes render --output final.mp4 # sortie nommée
npx hyperframes render --quality draft # itération rapide
npx hyperframes render --fps 60 --quality high # livraison finale
npx hyperframes render --format webm # WebM transparent
npx hyperframes render --docker # sortie reproductible
| Flag | Options | Défaut | Notes |
|---|---|---|---|
--output | chemin | renders/nom_timestamp.mp4 | Chemin de sortie |
--fps | 24, 30, 60 | 30 | 60fps double le temps de rendu |
--quality | draft, standard, high | standard | draft pour l'itération |
--format | mp4, webm | mp4 | WebM prend en charge la transparence |
--workers | 1-8 ou auto | auto | Chacun lance Chrome |
--docker | flag | désactivé | Sortie reproductible |
--gpu | flag | désactivé | Encodage accéléré par GPU |
--strict | flag | désactivé | Échouer sur les erreurs de lint |
--strict-all | flag | désactivé | Échouer sur les erreurs ET les avertissements |
--variables | objet JSON | — | Remplace les valeurs des variables déclarées dans data-composition-variables |
--variables-file | chemin | — | Fichier JSON avec les valeurs des variables (alternative à --variables) |
--strict-variables | flag | désactivé | Échouer le rendu sur les clés non déclarées ou les incompatibilités de type dans --variables |
Conseil qualité : draft pendant l'itération, standard pour la révision, high pour la livraison finale.
Rendus paramétrés : la composition déclare ses variables sur la racine <html> avec data-composition-variables — un tableau JSON de déclarations ({id, type, label, default} par entrée) qui définit le schéma. Les scripts à l'intérieur lisent les valeurs résolues via window.__hyperframes.getVariables(). Le CLI --variables '{"title":"Rapport T4"}' est un objet JSON indexé par id qui remplace les valeurs par défaut déclarées pour un seul rendu ; les clés manquantes sont ignorées, donc la même composition reste inchangée en aperçu de développement et en production. (Les hôtes de sous-composition peuvent également remplacer par instance avec data-variable-values — même forme d'objet, limitée à un montage de la sous-composition. Voir la compétence hyperframes pour le schéma complet.)
Prétraitement des actifs
npx hyperframes tts, transcribe, et remove-background produisent des actifs (audio de narration, transcriptions mot par mot, vidéo transparente) qui sont intégrés dans une composition. Chacun télécharge son propre modèle au premier lancement. Pour la sélection de la voix, les règles du modèle Whisper (le piège .en qui traduit les langues non anglaises), le choix du format de sortie (VP9 alpha WebM vs ProRes), et la chaîne TTS → transcrire → sous-titres, invoquez la compétence hyperframes-media.
Dépannage
npx hyperframes doctor # vérifie l'environnement (Chrome, FFmpeg, Node, mémoire)
npx hyperframes browser # gère Chrome intégré
npx hyperframes info # version et détails de l'environnement
npx hyperframes upgrade # vérifie les mises à jour
Exécutez doctor en premier si le rendu échoue. Problèmes courants : FFmpeg manquant, Chrome manquant, mémoire insuffisante.
Autre
npx hyperframes compositions # liste les compositions dans le projet
npx hyperframes docs # ouvre la documentation
npx hyperframes benchmark . # évalue les performances de rendu