CLI de HyperFrames
Todo se ejecuta a través de npx hyperframes a menos que las instrucciones del proyecto especifiquen una envoltura local. Obedece la envoltura local exactamente. Requiere Node.js >= 22 y FFmpeg.
Flujo de trabajo
- Scaffolding —
npx hyperframes init my-video(ocapturedesde una URL) - Escribir — crea la composición HTML (consulta el skill
hyperframes-core) - Lint —
npx hyperframes lint - Validar —
npx hyperframes validate(errores de ejecución + contraste) - Inspección visual —
npx hyperframes inspect - Vista previa —
npx hyperframes previewabre Studio, el editor de línea de tiempo donde el usuario puede editar manualmente cualquier cosa (no solo ver). Revísalo 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 entre equipos:
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 cabeza y reporta errores de consola en tiempo de ejecución más problemas de contraste WCAG. inspect recorre la línea de tiempo y reporta texto que se sale de burbujas/contenedores o del lienzo — y, cuando hay un archivo adjunto *.motion.json, verifica la intención de movimiento (entradas activadas por el recorrido, orden de escalonamiento, dentro del cuadro, actividad) contra la misma línea de tiempo recorrida.
Para trabajos con mucho movimiento, prefiere la iteración basada en instantáneas y un archivo adjunto *.motion.json — consulta references/lint-validate-inspect.md para la disciplina y la especificación de verificación de movimiento.
Convenciones del agente
Reglas transversales que se aplican a cada comando:
--jsonestá disponible en todos los comandos exceptorender,previewyplay. Úsalo para cualquier invocación de agente / CI de los comandos compatibles; la salida incluye un sobre_meta(versión del CLI, última disponible, consejo de actualización).renderinforma el estado solo a través de stdout + código de salida — verifica el éxito con la comprobación posterior al renderizado a continuación;preview/playson servidores, no tienen JSON.doctor --jsonsiempre sale con 0, incluso cuando el entorno está roto. Verifica el campookdel payload:npx hyperframes doctor --json | jq -e '.ok' > /dev/null. Esto aísla las canalizaciones de la fluctuación de versiones del CLI.- El modo no TTY se detecta automáticamente. Cuando
stdoutno es una TTY (CI, agentes, salida canalizada), el CLI cambia automáticamente a no interactivo;initentonces requiere--example. Pasa--non-interactivepara forzar este modo incluso en una TTY. - Puerta de CI en render:
--strictfalla en errores de lint,--strict-alltambién falla 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 auto-renderices una vez que las comprobaciones pasen. Pausa en
preview, dile al usuario que el vídeo se puede editar en Studio y renderiza solo después de que lo aprueben. - Verificación posterior al renderizado. Después de que
renderdevuelva el código de salida 0, confirma que el archivo de salida existe y tiene un tamaño plausible antes de informar éxito:[ -s "$OUTPUT" ] || echo "el renderizado no produjo salida". El CLI imprime◇ <ruta>en caso de éxito; para renders largos, también verifica la duración conffprobe -i "$OUTPUT" -show_format -v error.
Enrutamiento
| ¿Quieres… | Lee |
|---|---|
Crear un proyecto (init, capture, skills) | references/init-and-scaffold.md |
Verificar corrección (lint, validate, inspect, snapshot) | references/lint-validate-inspect.md |
Vista previa o renderizado (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 activos) | references/upgrade-info-misc.md |
Traspasos entre skills
- Proyectos Tailwind (
init --tailwind) → usahyperframes-core(referencia de Tailwind) antes de editar clases o tokens del tema. - Bloques/componentes del registro (
hyperframes add,hyperframes catalog) → usahyperframes-registrypara rutas de instalación, cableado de subcomposiciones y fusión de fragmentos. - Preprocesamiento de activos (
tts,transcribe,remove-background) → usahyperframes-mediapara selección de voz, reglas del modelo Whisper, subtítulos y cadena TTS a subtítulos. - Renders 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 renders desde tu portátil o CI. De principio a fin son tres comandos:
npx hyperframes lambda deploy # aprovisiona la pila SAM (Lambda + Step Functions + S3)
npx hyperframes lambda render ./my-project --width 1920 --height 1080 --wait
npx hyperframes lambda destroy # desmonta (el bucket S3 se conserva)
Usa Lambda cuando un render es demasiado largo / grande para un solo equipo (vídeos de varios minutos, 4K, lotes paralelos grandes) y tengas credenciales de AWS configuradas. Para iteración en el bucle de desarrollo, quédate con el 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 coste/limpieza.
Punto de control mínimo
Puertas estáticas
npx hyperframes lint
npx hyperframes validate
Añade inspect para trabajos sensibles al diseño y render --strict en CI para fallar en errores de lint.
Prueba visual de humo — requerida cuando el proyecto usa subcomposiciones
lint / validate / inspect evalúan cada composición de forma aislada. Nunca cargan index.html y montan subcomposiciones mediante data-composition-src, por lo que no pueden detectar fallos de montaje entre archivos (ver hyperframes-core → references/sub-compositions.md, "Errores comunes"). La única puerta que los detecta es una que realmente cargue index.html y recorra 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, por lo que toma segundos en lugar de un render completo:
# Captura un fotograma en el punto medio de cada subcomposició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. Revisa visualmente cada fotograma contra el plan de la escena.
Indicadores de problemas por fotograma (cada uno corresponde a un modo de fallo específico que las puertas 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 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 ve fondo + marca de agua | host-id ≠ template id (Error 2) — la línea de tiempo nunca se ejecutó, fotograma capturado en el estado inicial |
El comando snapshot registra Sub-composition timelines not registered after 45000ms | Error 2 — confirmación directa |
snapshots/ se puede eliminar después de la revisión visual; el render final para el usuario es una pasada separada con npx hyperframes render.