CLI HyperFrames
Tudo é executado através de npx hyperframes a menos que as instruções do projeto especifiquem um wrapper local. Obedeça exatamente ao wrapper local. Requer Node.js >= 22 e FFmpeg.
Fluxo de Trabalho
- Estruturar —
npx hyperframes init my-video(oucapturea partir de uma URL) - Escrever — criar composição HTML (veja o skill
hyperframes-core) - Lint —
npx hyperframes lint - Validar —
npx hyperframes validate(erros de runtime + contraste) - Inspeção visual —
npx hyperframes inspect - Preview —
npx hyperframes previewabre o Studio, o editor de timeline onde o usuário pode editar manualmente qualquer coisa (não apenas assistir). Revise lá e depois pergunte antes de renderizar. - Renderizar — escolha a variante:
- Iterar:
npx hyperframes render --quality draft - Entregar:
npx hyperframes render --quality high --output out.mp4 - CI / reprodução em outros hosts:
npx hyperframes render --docker --strict --output out.mp4 - Nuvem (longo / grande):
npx hyperframes lambda render ./my-project --width 1920 --height 1080 --wait(veja Lambda abaixo)
- Iterar:
Execute lint, validate e inspect antes do preview. lint detecta data-composition-id ausente, faixas sobrepostas e timelines não registradas. validate carrega a composição em um Chrome headless e relata erros de runtime do console, além de problemas de contraste WCAG. inspect percorre a timeline e relata texto vazando para fora de bolhas/contêineres ou do canvas — e, quando um sidecar *.motion.json está presente, verifica a intenção de movimento (animações de entrada ativadas sob seek, ordem de stagger, dentro do quadro, vivacidade) contra essa mesma timeline percorrida.
Para trabalhos pesados em movimento, prefira iteração orientada por snapshots e um sidecar *.motion.json — veja references/lint-validate-inspect.md para a disciplina e a especificação de verificação de movimento.
Convenções para Agentes
Regras transversais que valem para todos os comandos:
--jsonestá disponível em todos os comandos, excetorender,previeweplay. Use-o para qualquer invocação de agente / CI dos comandos suportados; a saída inclui um envelope_meta(versão da CLI, versão mais recente disponível, conselho de atualização).renderrelata o status apenas via stdout + código de saída — verifique o sucesso com a verificação pós-renderização abaixo;preview/playsão servidores, sem JSON.doctor --jsonsempre sai com código 0, mesmo quando o ambiente está quebrado. Verifique o campookdo payload:npx hyperframes doctor --json | jq -e '.ok' > /dev/null. Isso isola os pipelines da rotatividade de versão da CLI.- Modo não TTY é detectado automaticamente. Quando
stdoutnão é um TTY (CI, agentes, saída por pipe) a CLI muda automaticamente para o modo não interativo;initentão requer--example. Use--non-interactivepara forçar esse modo mesmo em um TTY. - Gating de CI na renderização:
--strictfalha em erros de lint,--strict-allfalha também em warnings,--strict-variablesfalha em chaves--variablesnão declaradas. - Caminhos em
--jsonsão censurados —$HOMEse torna o literal$HOMEpara que a saída seja segura para colar em relatórios de bug e contextos de agente. - Renderização é bloqueada pelo usuário. Nunca renderize automaticamente assim que as verificações passarem. Pare no
preview, informe ao usuário que o vídeo é editável no Studio, e renderize apenas após a aprovação. - Verificação pós-renderização. Após
renderretornar com código 0, confirme que o arquivo de saída existe e tem tamanho plausível antes de relatar sucesso:[ -s "$OUTPUT" ] || echo "render produced no output". A CLI imprime◇ <caminho>em caso de sucesso; para renderizações longas, verifique também a duração comffprobe -i "$OUTPUT" -show_format -v error.
Roteamento
| Se você quer... | Leia |
|---|---|
Estruturar um projeto (init, capture, skills) | references/init-and-scaffold.md |
Verificar correção (lint, validate, inspect, snapshot) | references/lint-validate-inspect.md |
Preview ou renderizar (preview, play, render, publish) | references/preview-render.md |
Diagnosticar o ambiente (doctor, browser) | references/doctor-browser.md |
Renderizar em nuvem no AWS Lambda (lambda deploy / sites / render / progress / destroy / policies) | references/lambda.md |
Todo o resto (info, upgrade, compositions, docs, benchmark, telemetry, pré-processamento de assets) | references/upgrade-info-misc.md |
Transferências entre Skills
- Projetos Tailwind (
init --tailwind) → usehyperframes-core(referência Tailwind) antes de editar classes ou tokens de tema. - Blocos/Componentes do Registry (
hyperframes add,hyperframes catalog) → usehyperframes-registrypara caminhos de instalação, conexão de sub-composições e mesclagem de snippets. - Pré-processamento de assets (
tts,transcribe,remove-background) → usehyperframes-mediapara seleção de voz, regras do modelo Whisper, legendas e encadeamento TTS-para-legendas. - Renderizações parametrizadas (
--variables) → declaradas viadata-composition-variablesem<html>; vejahyperframes-corepara o esquema completo.
Lambda (Renderização em Nuvem)
hyperframes lambda implanta renderização distribuída no AWS Lambda e aciona renderizações a partir do seu laptop ou CI. O processo completo são três comandos:
npx hyperframes lambda deploy # provisiona a stack SAM (Lambda + Step Functions + S3)
npx hyperframes lambda render ./my-project --width 1920 --height 1080 --wait
npx hyperframes lambda destroy # derruba (o bucket S3 é mantido)
Use Lambda quando uma renderização for muito longa / muito grande para um único host (vídeos com vários minutos, 4K, grandes lotes paralelos) e você tiver credenciais AWS configuradas. Para iteração no loop de desenvolvimento, continue com render local.
Veja references/lambda.md para pré-requisitos, todos os 6 subcomandos (deploy, sites create, render, progress, destroy, policies), validação de política IAM, arquivos de estado e regras de custo/limpeza.
Portão Mínimo de Conclusão
Portões estáticos
npx hyperframes lint
npx hyperframes validate
Adicione inspect para trabalhos sensíveis a layout e render --strict em CI para falhar em erros de lint.
Teste de fumaça visual — obrigatório quando o projeto usa sub-composições
lint / validate / inspect avaliam cada composição isoladamente. Eles nunca carregam index.html e montam sub-composições via data-composition-src, portanto não conseguem detectar falhas de montagem entre arquivos (veja hyperframes-core → references/sub-compositions.md, "Armadilhas comuns"). O único portão que as detecta é aquele que realmente carrega index.html e percorre a timeline.
Use hyperframes snapshot — ele carrega o projeto da mesma forma que render (então exercita o mesmo caminho de montagem) mas captura apenas os timestamps que você solicitar, então leva segundos em vez de uma renderização completa:
# Captura um quadro no ponto médio de cada sub-composição.
# Pontos médios = data-start + data-duration/2 para cada slot hospedeiro em index.html.
npx hyperframes snapshot --at <t1>,<t2>,<t3>,...
# Ou, se você não precisa de direcionamento por cena, uma amostra uniformemente espaçada:
npx hyperframes snapshot --frames 9
A saída vai para snapshots/frame-NN-at-Xs.png. Examine cada quadro em relação ao plano da cena.
Bandeiras vermelhas por quadro (cada uma mapeia para um modo de falha específico que os portões estáticos não detectam):
| O que você vê | Causa raiz |
|---|---|
| O texto aparece minúsculo + sem estilo no canto superior esquerdo | Bloco <style> deixado em <head> fora de <template> (Armadilha 1) — nenhum CSS chegou ao DOM ativo |
| Elementos SVG/ícone ampliados para o tamanho do canvas | Mesmo que acima — nenhuma restrição de largura/altura aplicada |
| O elemento principal da cena está completamente ausente; apenas fundo + marca d'água visíveis | Host-id ≠ template id (Armadilha 2) — a timeline nunca foi executada, quadro capturado no estado inicial |
O comando de snapshot registra Sub-composition timelines not registered after 45000ms | Armadilha 2 — confirmação direta |
snapshots/ pode ser excluído após a inspeção visual; a renderização final voltada ao usuário é uma etapa separada com npx hyperframes render.