HyperFrames CLI
Tudo é executado via 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
- Scaffold —
npx hyperframes init my-video(oucapturede uma URL).inittambém verifica se as skills instaladas estão atualizadas em relação às mais recentes no GitHub e atualiza o conjunto global se alguma estiver desatualizada. A flag--skip-skillsestá temporariamente desativada (enquanto o registro skills.sh se atualiza), então todoinitexecuta essa verificação e baixa nossas skills mais recentes independentemente. - Escrever — crie a composição HTML (veja a 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:
- Iteração:
npx hyperframes render --quality draft - Entrega:
npx hyperframes render --quality high --output out.mp4 - CI / reprodutível entre máquinas:
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)
- Iteração:
Execute lint, validate e inspect antes do preview. lint captura data-composition-id ausentes, trilhas sobrepostas e timelines não registradas. validate carrega a composição no Chrome sem cabeçalho e relata erros de console em runtime e problemas de contraste WCAG. inspect percorre a timeline e relata texto extravasando de balões/contêineres ou saindo do canvas — e, quando um arquivo *.motion.json está presente, verifica a intenção de movimento (entradas disparadas durante a busca, ordem de escalonamento, dentro do quadro, vivacidade) contra essa mesma timeline percorrida.
Para trabalhos com muito movimento, prefira iteração baseada em snapshots e um arquivo *.motion.json — veja references/lint-validate-inspect.md para a disciplina e especificação de verificação de movimento.
Convenções do Agente
Regras transversais que valem para todo comando:
--jsonestá disponível em todos os comandos, excetorender,previeweplay. Use-o para qualquer invocação do agente / CI dos comandos suportados; a saída inclui um envelope_meta(versão da CLI, versão mais recente disponível, dica de atualização).renderreporta status via stdout + código de saída apenas — 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. Use o campookdo payload:npx hyperframes doctor --json | jq -e '.ok' > /dev/null. Isso isola os pipelines da variação de versão da CLI.- Modo não TTY é detectado automaticamente. Quando
stdoutnão é um TTY (CI, agentes, saída pipeada) a CLI alterna automaticamente para modo não interativo;initentão requer--example. Use--non-interactivepara forçar este modo mesmo em um TTY. - Gate de CI na renderização:
--strictfalha em erros de lint,--strict-allfalha também em avisos,--strict-variablesfalha em chaves--variablesnão declaradas. - Caminhos em
--jsonsão redigidos —$HOMEse torna o literal$HOMEpara que a saída seja segura para colar em relatórios de bug e contextos de agente. - Renderização é controlada pelo usuário. Nunca renderize automaticamente após as verificações passarem. Pare no
preview, avise ao usuário que o vídeo é editável no Studio e renderize somente após a aprovação. - Verificação pós-renderização. Após
renderretornar 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
| Deseja… | Leia |
|---|---|
Scaffold de 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 |
Renderização 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 Whisper, legendas e cadeia TTS para legendas. - Renderizações parametrizadas (
--variables) → declaradas viadata-composition-variablesem<html>; vejahyperframes-corepara o schema completo.
Lambda (Renderização em Nuvem)
hyperframes lambda faz deploy de renderização distribuída no AWS Lambda e aciona renders a partir do seu laptop ou CI. O fluxo completo são três comandos:
npx hyperframes lambda deploy # provisiona stack SAM (Lambda + Step Functions + S3)
npx hyperframes lambda render ./my-project --width 1920 --height 1080 --wait
npx hyperframes lambda destroy # remove (bucket S3 é mantido)
Use Lambda quando um render for muito longo / grande para uma única máquina (vídeos de vários minutos, 4K, grandes lotes paralelos) e você tiver credenciais AWS configuradas. Para iteração no loop de desenvolvimento, mantenha-se no 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.
Gate Mínimo de Conclusão
Gates 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 visual rápido — obrigatório quando o projeto usa sub-composições
lint / validate / inspect avaliam cada composição de forma isolada. Eles nunca carregam index.html e montam sub-composições via data-composition-src, portanto não conseguem capturar falhas de montagem entre arquivos (veja hyperframes-core → references/sub-compositions.md, "Armadilhas comuns"). O único gate que as captura é aquele que realmente carrega index.html e percorre a timeline.
Use hyperframes snapshot — ele carrega o projeto da mesma forma que render (portanto, exercita o mesmo caminho de montagem), mas captura apenas os timestamps solicitados, levando segundos em vez de um render completo:
# Capture um frame no ponto médio de cada sub-composição.
# Pontos médios = data-start + data-duration/2 para cada slot host em index.html.
npx hyperframes snapshot --at <t1>,<t2>,<t3>,...
# Ou, se não precisar de captura por cena, uma amostra uniformemente espaçada:
npx hyperframes snapshot --frames 9
A saída vai para snapshots/frame-NN-at-Xs.png. Verifique cada frame em relação ao plano da cena.
Bandeiras vermelhas por frame (cada uma mapeia para um modo de falha específico que os gates estáticos não capturam):
| O que você vê | Causa raiz |
|---|---|
| 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 ao tamanho do canvas | Mesmo acima — sem restrições de largura/altura aplicadas |
| Elemento principal da cena completamente ausente; apenas fundo + marca d'água visíveis | Host-id ≠ template id (Armadilha 2) — timeline nunca foi executada, frame capturado no estado inicial |
Comando snapshot registra Sub-composition timelines not registered after 45000ms | Armadilha 2 — confirmação direta |
snapshots/ pode ser excluído após a verificação visual; o render final para o usuário é uma passagem separada com npx hyperframes render.