CLI HyperFrames
Tout s'exécute via npx hyperframes. Nécessite Node.js >= 22 et FFmpeg.
Flux de travail
- Scaffolding —
npx hyperframes init my-video - Écriture — composer le HTML (voir la compétence
hyperframes) - Linting —
npx hyperframes lint - Inspection visuelle —
npx hyperframes inspect - Aperçu —
npx hyperframes preview - Rendu —
npx hyperframes render
Effectuez le linting 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éborde des bulles/conteneurs ou du canevas.
Scaffolding
npx hyperframes init my-video # assistant interactif
npx hyperframes init my-video --example warm-grain # choisir un exemple
npx hyperframes init my-video --video clip.mp4 # avec fichier vidéo
npx hyperframes init my-video --audio track.mp3 # avec fichier audio
npx hyperframes init my-video --example blank --tailwind # avec runtime navigateur Tailwind v4
npx hyperframes init my-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 structure de fichiers correcte, copie les médias, transcrit l'audio avec Whisper et installe les compétences de codage IA. Utilisez-le plutôt que de créer des fichiers à la main.
Lorsque vous utilisez --tailwind, invoquez la compétence tailwind avant de modifier les classes ou les tokens de thème. Le scaffolding 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 ./my-project # projet spécifique
npx hyperframes lint --verbose # résultats 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 (devraient être corrigés) et les informations (avec --verbose).
Inspection visuelle
npx hyperframes inspect # inspecte la mise en page rendue sur la timeline
npx hyperframes inspect ./my-project # projet spécifique
npx hyperframes inspect --json # résultats 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 trames clés
Utilisez cette commande après lint et validate, surtout pour les compositions avec des bulles de dialogue, des cartes, des légendes ou une typographie serrée. Elle signale :
- Le texte qui s'étend en dehors du conteneur visuel ou de la bulle le plus proche
- Le texte tronqué par sa propre boîte à largeur/hauteur fixe
- Le texte qui s'étend en dehors du canevas de la composition
- Les enfants qui s'échappent des conteneurs de découpage
Les erreurs doivent être corrigées avant le rendu. Les avertissements sont remontés pour examen par l'agent ; ajoutez --strict pour échouer également sur les avertissements. Les problèmes statiques répétés sont regroupés 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 son 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 # servir le répertoire courant
npx hyperframes preview --port 4567 # port personnalisé (par défaut 3002)
Recharge à chaud lors des modifications de fichiers. Ouvre le studio automatiquement dans le navigateur.
Lorsque vous remettez un projet à l'utilisateur, utilisez l'URL du projet Studio, pas le chemin du fichier index.html source :
http://localhost:<port>/#project/<nom-du-projet>
Utilisez le port réel affiché par l'aperçu et le nom du répertoire du projet. Par exemple, après npx hyperframes preview --port 3017 dans codex-openai-video, signalez http://localhost:3017/#project/codex-openai-video.
Traitez index.html uniquement comme 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 # identique au niveau octet
| Drapeau | Options | Par défaut | Remarques |
|---|---|---|---|
--output | chemin | renders/nom_timestamp.mp4 | Chemin de sortie |
--fps | 24, 30, 60 | 30 | 60 ips double le temps de rendu |
--quality | draft, standard, high | standard | draft pour itérer |
--format | mp4, webm | mp4 | WebM prend en charge la transparence |
--workers | 1-8 ou auto | auto | Chacun lance Chrome |
--docker | drapeau | off | Sortie reproductible |
--gpu | drapeau | off | Encodage accéléré par GPU |
--strict | drapeau | off | Échouer sur les erreurs de lint |
--strict-all | drapeau | off | Échouer sur les erreurs ET les avertissements |
--variables | objet JSON | — | Remplacer 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 | drapeau | off | Échouer le rendu sur les clés non déclarées ou les types incorrects dans --variables |
Recommandations de 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(). La CLI --variables '{"title":"Rapport Q4"}' est un objet JSON indexé par id qui remplace ces valeurs par défaut déclarées pour un rendu ; les clés manquantes sont ignorées, donc la même composition s'exécute 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 motif complet.)
Prétraitement des ressources
npx hyperframes tts, transcribe et remove-background produisent des ressources (audio de narration, transcriptions mot par mot, vidéo transparente) qui sont déposées dans une composition. Chacun télécharge son propre modèle lors de la première exécution. Pour la sélection de voix, les règles du modèle whisper (l'astuce .en qui traduit le non-anglais), le choix du format de sortie (WebM alpha VP9 vs ProRes) et la chaîne TTS → transcription → légendes, invoquez la compétence hyperframes-media.
Dépannage
npx hyperframes doctor # vérifier l'environnement (Chrome, FFmpeg, Node, mémoire)
npx hyperframes browser # gérer le Chrome fourni
npx hyperframes info # détails de version et d'environnement
npx hyperframes upgrade # vérifier les mises à jour
Exécutez doctor en premier si le rendu échoue. Problèmes courants : FFmpeg manquant, Chrome manquant, mémoire insuffisante.
Autres
npx hyperframes compositions # lister les compositions dans le projet
npx hyperframes docs # ouvrir la documentation
npx hyperframes benchmark . # mesurer les performances de rendu