HyperFrames CLI
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
- Andaime —
npx hyperframes init my-video(oucapturea partir de uma URL).inittambém verifica as skills instaladas em relação às mais recentes no GitHub e atualiza o conjunto global se alguma estiver desatualizada. A flag--skip-skillsestá atualmente neutralizada (temporariamente, enquanto o registro skills.sh se atualiza), então todoinitexecuta essa verificação e baixa nossas skills mais recentes independentemente. - Escreva — crie a composição HTML (veja a skill
hyperframes-core) - Lint —
npx hyperframes lint - Valide —
npx hyperframes validate(erros de tempo de execução + contraste) - Inspeção visual —
npx hyperframes inspect - Visualização —
npx hyperframes previewabre o Studio, o editor de linha do tempo onde o usuário pode editar manualmente qualquer coisa (não apenas assistir). Revise lá, depois pergunte antes de renderizar. - Renderize — escolha a variante:
- Iterar:
npx hyperframes render --quality draft - Entregar:
npx hyperframes render --quality high --output out.mp4 - CI / reprodutibilidade entre 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 captura data-composition-id ausente, faixas sobrepostas e timelines não registradas. validate carrega a composição no Chrome headless e relata erros de console em tempo de execução, além de problemas de contraste WCAG. inspect percorre a linha do tempo e relata texto vazando de bolhas/contêineres ou para fora da tela — e, quando um arquivo lateral *.motion.json está presente, verifica a intenção de movimento (entradas disparadas sob busca, ordem de stagger, dentro do quadro, vivacidade) contra essa mesma linha do tempo percorrida.
Para trabalhos com muito movimento, prefira iteração orientada a snapshots e um arquivo lateral *.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 se aplicam a 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 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. Verifique o campookdo payload:npx hyperframes doctor --json | jq -e '.ok' > /dev/null. Isso isola os pipelines de mudanças na versão da CLI.- Modo não-TTY é detectado automaticamente. Quando
stdoutnão é um TTY (CI, agentes, saída pipeada) a CLI muda automaticamente para não-interativo;initentão requer--example. Passe--non-interactivepara forçar esse modo mesmo em um TTY. - Gate 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 bugs e contextos de agente. - Renderização é autorizada pelo usuário. Nunca renderize automaticamente quando as verificações passarem. Pare no
preview, informe 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 com código 0, confirme que o arquivo de saída existe e tem tamanho plausível antes de relatar sucesso:[ -s "$OUTPUT" ] || echo "a renderização não produziu saída". 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ê deseja… | Leia |
|---|---|
Criar um projeto (init, capture, skills) | references/init-and-scaffold.md |
Verificar correção (lint, validate, inspect, snapshot) | references/lint-validate-inspect.md |
Visualizar 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 ativos) | 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 registro (
hyperframes add,hyperframes catalog) → usehyperframes-registrypara caminhos de instalação, conexão de sub-composições e mesclagem de snippets. - Pré-processamento de ativos (
tts,transcribe,remove-background) → usehyperframes-mediapara seleção de voz, regras do modelo Whisper, legendas e cadeia 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. Do início ao fim são três comandos:
npx hyperframes lambda deploy # provisiona a pilha 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 de vários minutos, 4K, grandes lotes paralelos) e você tiver credenciais AWS configuradas. Para iteração em loop de desenvolvimento, permaneça na renderização local render.
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 de Conclusão Mínimo
Gates estáticos
npx hyperframes lint
npx hyperframes validate
Adicione inspect para trabalhos sensíveis a layout e render --strict no CI para falhar em erros de lint.
Teste visual de fumaça — necessá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 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 linha do tempo.
Use hyperframes snapshot — ele carrega o projeto da mesma forma que render (portanto, percorre o mesmo caminho de montagem), mas captura apenas os timestamps solicitados, 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 precisar de segmentação 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 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 alcançou o DOM ativo |
| Elementos SVG/ícone ampliados para o tamanho da tela | Mesmo que acima — nenhuma restrição de largura/altura aplicada |
| Elemento principal da cena está completamente ausente; apenas fundo + marca d'água visíveis | Host-id ≠ template id (Armadilha 2) — a linha do tempo 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; a renderização final voltada ao usuário é uma passagem separada com npx hyperframes render.