HyperFrames CLI
Tudo é executado através de npx hyperframes. Requer Node.js >= 22 e FFmpeg.
Fluxo de Trabalho
- Scaffold —
npx hyperframes init my-video - Escrever — autor da composição HTML (veja a skill
hyperframes) - Lint —
npx hyperframes lint - Inspeção visual —
npx hyperframes inspect - Preview —
npx hyperframes preview - Render —
npx hyperframes render
Execute lint e inspect antes do preview. lint detecta data-composition-id ausente, trilhas sobrepostas e timelines não registradas. inspect abre a composição renderizada no Chrome headless, percorre a timeline e relata texto vazando para fora de balões/contêineres ou fora da tela.
Scaffolding
npx hyperframes init my-video # assistente interativo
npx hyperframes init my-video --example warm-grain # escolher um exemplo
npx hyperframes init my-video --video clip.mp4 # com arquivo de vídeo
npx hyperframes init my-video --audio track.mp3 # com arquivo de áudio
npx hyperframes init my-video --example blank --tailwind # com runtime browser Tailwind v4
npx hyperframes init my-video --non-interactive # pular prompts (CI/agentes)
Modelos: blank, warm-grain, play-mode, swiss-grid, vignelli, decision-tree, kinetic-type, product-promo, nyt-graph.
init cria a estrutura de arquivos correta, copia mídia, transcreve áudio com Whisper e instala skills de codificação de IA. Use-o em vez de criar arquivos manualmente.
Ao usar --tailwind, invoque a skill tailwind antes de editar classes ou tokens de tema. O scaffold usa Tailwind v4.2 via runtime browser, não a configuração Tailwind v3 do Studio.
Linting
npx hyperframes lint # diretório atual
npx hyperframes lint ./my-project # projeto específico
npx hyperframes lint --verbose # descobertas no nível info
npx hyperframes lint --json # legível por máquina
Aplica lint em index.html e todos os arquivos em compositions/. Relata erros (devem ser corrigidos), avisos (devem ser corrigidos) e informações (com --verbose).
Inspeção Visual
npx hyperframes inspect # inspeciona o layout renderizado ao longo da timeline
npx hyperframes inspect ./my-project # projeto específico
npx hyperframes inspect --json # descobertas legíveis por agente
npx hyperframes inspect --samples 15 # varredura de timeline mais densa
npx hyperframes inspect --at 1.5,4,7.25 # timestamps explícitos de hero-frame
Use após lint e validate, especialmente para composições com balões de fala, cartões, legendas ou tipografia compacta. Ele relata:
- Texto se estendendo para fora do contêiner visual ou balão mais próximo
- Texto cortado por sua própria caixa de largura/altura fixa
- Texto se estendendo para fora da tela da composição
- Filhos escapando de contêineres de corte
Erros devem ser corrigidos antes da renderização. Avisos são apresentados para revisão do agente; adicione --strict para falhar também em avisos. Problemas estáticos repetidos são recolhidos por padrão para que a saída JSON permaneça compacta para janelas de contexto LLM. Se o overflow for intencional para uma animação de entrada/saída, marque o elemento ou ancestral com data-layout-allow-overflow. Se um elemento decorativo nunca deve ser auditado, marque-o com data-layout-ignore.
npx hyperframes layout permanece disponível como um alias de compatibilidade para a mesma passagem de inspeção visual.
Preview
npx hyperframes preview # serve o diretório atual
npx hyperframes preview --port 4567 # porta personalizada (padrão 3002)
Recarrega automaticamente nas alterações de arquivo. Abre o estúdio no seu navegador automaticamente.
Ao devolver um projeto ao usuário, use a URL do projeto do Studio, não o caminho do arquivo index.html fonte:
http://localhost:<port>/#project/<project-name>
Use a porta real da saída do preview e o nome do diretório do projeto. Por exemplo, após npx hyperframes preview --port 3017 em codex-openai-video, relate http://localhost:3017/#project/codex-openai-video.
Trate index.html apenas como contexto de código-fonte. Não há problema em vinculá-lo como um arquivo de implementação, mas não o rotule como projeto ou superfície de preview.
Renderização
npx hyperframes render # MP4 padrão
npx hyperframes render --output final.mp4 # saída nomeada
npx hyperframes render --quality draft # iteração rápida
npx hyperframes render --fps 60 --quality high # entrega final
npx hyperframes render --format webm # WebM transparente
npx hyperframes render --docker # saída byte-idêntica
| Flag | Opções | Padrão | Observações |
|---|---|---|---|
--output | caminho | renders/name_timestamp.mp4 | Caminho de saída |
--fps | 24, 30, 60 | 30 | 60fps dobra o tempo de render |
--quality | draft, standard, high | standard | draft para iterar |
--format | mp4, webm | mp4 | WebM suporta transparência |
--workers | 1-8 ou auto | auto | Cada um spawna Chrome |
--docker | flag | desligado | Saída reprodutível |
--gpu | flag | desligado | Codificação acelerada por GPU |
--strict | flag | desligado | Falha em erros de lint |
--strict-all | flag | desligado | Falha em erros E avisos |
--variables | objeto JSON | — | Sobrescreve valores de variáveis declaradas em data-composition-variables |
--variables-file | caminho | — | Arquivo JSON com valores de variáveis (alternativa a --variables) |
--strict-variables | flag | desligado | Falha na renderização em chaves não declaradas ou incompatibilidades de tipo em --variables |
Orientação de qualidade: draft durante a iteração, standard para revisão, high para entrega final.
Renders parametrizados: a composição declara suas variáveis na raiz <html> com data-composition-variables — um array JSON de declarações ({id, type, label, default} por entrada) que define o schema. Scripts internos leem os valores resolvidos via window.__hyperframes.getVariables(). O CLI --variables '{"title":"Q4 Report"}' é um objeto JSON indexado por id que sobrescreve esses padrões declarados para uma renderização; chaves ausentes são ignoradas, de modo que a mesma composição é executada inalterada no preview de desenvolvimento e na produção. (Os hosts de sub-composição também podem sobrescrever por instância com data-variable-values — mesma forma de objeto, com escopo para uma montagem da sub-composição. Veja a skill hyperframes para o padrão completo.)
Pré-processamento de Assets
npx hyperframes tts, transcribe e remove-background produzem assets (áudio de narração, transcrições no nível da palavra, vídeo transparente) que são inseridos em uma composição. Cada um baixa seu próprio modelo na primeira execução. Para seleção de voz, regras do modelo whisper (a pegadinha .en-traduz-não-inglês), escolha de formato de saída (VP9 alpha WebM vs ProRes) e a cadeia TTS → transcrever → legendas, invoque a skill hyperframes-media.
Solução de Problemas
npx hyperframes doctor # verifica ambiente (Chrome, FFmpeg, Node, memória)
npx hyperframes browser # gerencia Chrome empacotado
npx hyperframes info # detalhes de versão e ambiente
npx hyperframes upgrade # verifica atualizações
Execute doctor primeiro se a renderização falhar. Problemas comuns: FFmpeg ausente, Chrome ausente, pouca memória.
Outros
npx hyperframes compositions # lista composições no projeto
npx hyperframes docs # abre documentação
npx hyperframes benchmark . # benchmark de desempenho de renderização