CLI de HyperFrames
Todo se ejecuta mediante npx hyperframes a menos que las instrucciones del proyecto especifiquen un envoltorio local. Obedece exactamente el envoltorio local. Requiere Node.js >= 22 y FFmpeg.
Flujo de trabajo
- Scaffold —
npx hyperframes init my-video(ocapturedesde una URL).inittambién verifica las habilidades instaladas contra las últimas versiones en GitHub y actualiza el conjunto global si alguna está desactualizada. El flag--skip-skillsactualmente está neutralizado (temporal, mientras el registro skills.sh se pone al día), por lo que cadainitejecuta esta verificación y descarga nuestras últimas habilidades independientemente. - Escribir — redacta la composición HTML (consulta la habilidad
hyperframes-core) - Lint —
npx hyperframes lint - Validar —
npx hyperframes validate(errores en tiempo de ejecución + contraste) - Inspección visual —
npx hyperframes inspect - Previsualizar —
npx hyperframes previewabre Studio, el editor de línea de tiempo donde el usuario puede editar manualmente cualquier cosa (no solo ver). Revisa allí, luego pregunta antes de renderizar. - Renderizar — elige la variante:
- Iterar:
npx hyperframes render --quality draft - Entregar:
npx hyperframes render --quality high --output out.mp4 - CI / reproducción multiplataforma:
npx hyperframes render --docker --strict --output out.mp4 - Nube (larga / grande):
npx hyperframes lambda render ./my-project --width 1920 --height 1080 --wait(ver Lambda abajo)
- Iterar:
Ejecuta lint, validate e inspect antes de preview. lint detecta data-composition-id faltantes, pistas superpuestas y líneas de tiempo no registradas. validate carga la composición en Chrome sin interfaz gráfica e informa errores de consola en tiempo de ejecución más problemas de contraste WCAG. inspect recorre la línea de tiempo e informa texto que se sale de burbujas/contenedores o del lienzo — y, cuando hay un sidecar *.motion.json, verifica la intención de movimiento (entradas que se activan al buscar, orden de escalonamiento, dentro del cuadro, vivacidad) contra esa misma línea de tiempo recorrida.
Para trabajos con mucho movimiento, prefiere la iteración basada en snapshots y un sidecar *.motion.json — consulta references/lint-validate-inspect.md para la disciplina y las especificaciones de verificación de movimiento.
Convenciones del agente
Reglas transversales que aplican para todos los comandos:
--jsonestá disponible en todos los comandos exceptorender,previewyplay. Úsalo para cualquier invocación de agente/CI de los comandos compatibles; la salida incluye un envoltorio_meta(versión de CLI, última disponible, consejo de actualización).renderinforma el estado a través de stdout + código de salida solamente — verifica el éxito con la verificación posterior al renderizado a continuación;preview/playson servidores, no tienen JSON.doctor --jsonsiempre sale con código 0, incluso cuando el entorno está roto. Evalúa el campookdel payload:npx hyperframes doctor --json | jq -e '.ok' > /dev/null. Esto aísla los pipelines de los cambios en la versión de CLI.- El modo no TTY se detecta automáticamente. Cuando
stdoutno es un TTY (CI, agentes, salida canalizada) la CLI cambia automáticamente a no interactivo;initentonces requiere--example. Pasa--non-interactivepara forzar este modo incluso en un TTY. - Compuerta de CI en render:
--strictfalla en errores de lint,--strict-allfalla también en advertencias,--strict-variablesfalla en claves--variablesno declaradas. - Las rutas en
--jsonestán redactadas —$HOMEse convierte en el literal$HOMEpara que la salida sea segura de pegar en informes de errores y contextos de agente. - El renderizado está controlado por el usuario. Nunca renderices automáticamente una vez que las verificaciones pasen. Detente en
preview, dile al usuario que el video es editable en Studio, y renderiza solo después de que apruebe. - Verificación posterior al renderizado. Después de que
renderdevuelva el código 0, confirma que el archivo de salida existe y tiene un tamaño plausible antes de informar éxito:[ -s "$OUTPUT" ] || echo "render no produjo salida". La CLI imprime◇ <ruta>en caso de éxito; para renderizados largos, también verifica la duración conffprobe -i "$OUTPUT" -show_format -v error.
Enrutamiento
| Si quieres… | Lee |
|---|---|
Hacer scaffold de un proyecto (init, capture, skills) | references/init-and-scaffold.md |
Verificar corrección (lint, validate, inspect, snapshot) | references/lint-validate-inspect.md |
Previsualizar o renderizar (preview, play, render, publish) | references/preview-render.md |
Diagnosticar el entorno (doctor, browser) | references/doctor-browser.md |
Renderizar en la nube con AWS Lambda (lambda deploy / sites / render / progress / destroy / policies) | references/lambda.md |
Todo lo demás (info, upgrade, compositions, docs, benchmark, telemetry, preprocesamiento de assets) | references/upgrade-info-misc.md |
Transferencias entre habilidades
- Proyectos Tailwind (
init --tailwind) → usahyperframes-core(referencia de Tailwind) antes de editar clases o tokens de tema. - Componentes/bloques del registro (
hyperframes add,hyperframes catalog) → usahyperframes-registrypara rutas de instalación, cableado de sub-composiciones y fusión de fragmentos. - Preprocesamiento de assets (
tts,transcribe,remove-background) → usahyperframes-mediapara selección de voz, reglas del modelo Whisper, subtítulos y cadena de TTS a subtítulos. - Renderizados parametrizados (
--variables) → declarados mediantedata-composition-variablesen<html>; consultahyperframes-corepara el esquema completo.
Lambda (Renderizado en la nube)
hyperframes lambda despliega renderizado distribuido en AWS Lambda y ejecuta renderizados desde tu laptop o CI. El proceso completo son tres comandos:
npx hyperframes lambda deploy # aprovisionar stack SAM (Lambda + Step Functions + S3)
npx hyperframes lambda render ./my-project --width 1920 --height 1080 --wait
npx hyperframes lambda destroy # eliminar (el bucket de S3 se conserva)
Usa Lambda cuando un renderizado sea demasiado largo / grande para un solo host (videos de varios minutos, 4K, lotes paralelos grandes) y tengas credenciales de AWS configuradas. Para iteración en el bucle de desarrollo, quédate con render local.
Consulta references/lambda.md para requisitos previos, los 6 subcomandos (deploy, sites create, render, progress, destroy, policies), validación de políticas IAM, archivos de estado y reglas de costo/limpieza.
Compuerta de finalización mínima
Compuertas estáticas
npx hyperframes lint
npx hyperframes validate
Agrega inspect para trabajos sensibles al diseño y render --strict en CI para fallar en errores de lint.
Prueba de humo visual — requerida cuando el proyecto usa sub-composiciones
lint/validate/inspect evalúan cada composición de forma aislada. Nunca cargan index.html y montan sub-composiciones mediante data-composition-src, por lo tanto no pueden detectar fallos de montaje entre archivos (consulta hyperframes-core → references/sub-compositions.md, "Errores comunes"). La única compuerta que los detecta es una que realmente carga index.html y recorre la línea de tiempo.
Usa hyperframes snapshot — carga el proyecto de la misma manera que render (por lo que ejercita la misma ruta de montaje) pero solo captura las marcas de tiempo que solicites, así que toma segundos en lugar de un renderizado completo:
# Captura un fotograma en el punto medio de cada sub-composición.
# Puntos medios = data-start + data-duration/2 para cada ranura anfitriona en index.html.
npx hyperframes snapshot --at <t1>,<t2>,<t3>,...
# O, si no necesitas segmentación por escena, una muestra espaciada uniformemente:
npx hyperframes snapshot --frames 9
La salida se guarda en snapshots/frame-NN-at-Xs.png. Examina cada fotograma visualmente contra el plan de escena.
Señales de alerta por fotograma (cada una se asigna a un modo de fallo específico que las compuertas estáticas no detectan):
| Lo que ves | Causa raíz |
|---|---|
| El texto aparece pequeño + sin estilo en la esquina superior izquierda | Bloque <style> dejado en <head> fuera de <template> (Error común 1) — ningún CSS llegó al DOM vivo |
| Elementos SVG/icono ampliados al tamaño del lienzo | Igual que arriba — no se aplicaron restricciones de ancho/alto |
| El elemento principal de la escena falta por completo; solo se ven el fondo y la marca de agua | El ID del anfitrión ≠ el ID de la plantilla (Error común 2) — la línea de tiempo nunca se ejecutó, fotograma capturado en estado inicial |
El comando snapshot registra Sub-composition timelines not registered after 45000ms | Error común 2 — confirmación directa |
snapshots/ se puede eliminar después de examinarlo; el renderizado final para el usuario es un pase separado con npx hyperframes render.