CLI de HyperFrames
Todo se ejecuta a través de npx hyperframes a menos que las instrucciones del proyecto especifiquen un envoltorio local. Obedezca el envoltorio local exactamente. Requiere Node.js >= 22 y FFmpeg.
Flujo de trabajo
- Andamio —
npx hyperframes init my-video(ocapturedesde una URL).inittambién verifica las skills instaladas contra las últimas en GitHub y actualiza el conjunto global si alguna está desactualizada. La bandera--skip-skillsestá actualmente neutralizada (temporal, mientras el registro skills.sh se pone al día), por lo que cadainitejecuta esta verificación y obtiene nuestras últimas skills independientemente. - Escribir — redactar la composición HTML (ver la 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 cualquier cosa manualmente (no solo ver). Revise allí, luego pregunte antes de renderizar. - Renderizar — elija 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 (largo / grande):
npx hyperframes lambda render ./my-project --width 1920 --height 1080 --wait(ver Lambda abajo)
- Iterar:
Ejecute lint, validate e inspect antes de la vista previa. lint detecta data-composition-id faltantes, pistas superpuestas y líneas de tiempo no registradas. validate carga la composición en Chrome sin cabeza 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 archivo adjunto *.motion.json presente, verifica la intención de movimiento (disparos de entradas bajo búsqueda, orden de escalonamiento, dentro del cuadro, vivacidad) contra esa misma línea de tiempo recorrida.
Para trabajos con mucho movimiento, prefiera la iteración basada en instantáneas y un archivo adjunto *.motion.json — consulte references/lint-validate-inspect.md para la disciplina y la especificación de verificación de movimiento.
Convenciones para Agentes
Reglas transversales que se aplican a todos los comandos:
--jsonestá disponible en todos los comandos exceptorender,previewyplay. Úselo 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 solo a través de stdout + código de salida — verifique el éxito con la verificación posterior al renderizado a continuación;preview/playson servidores, no tienen JSON.doctor --jsonsiempre sale con 0, incluso cuando el entorno está roto. Verifique el campookde la carga útil: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 una TTY (CI, agentes, salida canalizada), la CLI cambia automáticamente a modo no interactivo;initentonces requiere--example. Pase--non-interactivepara forzar este modo incluso en una TTY. - Puerta de CI en renderizado:
--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 agentes. - El renderizado está controlado por el usuario. Nunca renderice automáticamente una vez que las comprobaciones pasen. Pause en
preview, dígale al usuario que el video es editable en Studio, y renderice solo después de que lo apruebe. - Verificación posterior al renderizado. Después de que
renderdevuelva el código de salida 0, confirme que el archivo de salida existe y tiene un tamaño plausible antes de informar éxito:[ -s "$OUTPUT" ] || echo "render produced no output". La CLI imprime◇ <ruta>en caso de éxito; para renderizados largos, también verifique la duración conffprobe -i "$OUTPUT" -show_format -v error.
Enrutamiento
| Quiere… | Lea |
|---|---|
Crear 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 activos) | references/upgrade-info-misc.md |
Transferencias entre Skills
- Proyectos Tailwind (
init --tailwind) → usehyperframes-core(referencia de Tailwind) antes de editar clases o tokens de tema. - Bloques/componentes del registro (
hyperframes add,hyperframes catalog) → usehyperframes-registrypara rutas de instalación, cableado de subcomposiciones y fusión de fragmentos. - Preprocesamiento de activos (
tts,transcribe,remove-background) → usehyperframes-mediapara selección de voz, reglas del modelo Whisper, subtítulos y cadena TTS a subtítulos. - Renderizados parametrizados (
--variables) → declarados a través dedata-composition-variablesen<html>; veahyperframes-corepara el esquema completo.
Lambda (Renderizado en la Nube)
hyperframes lambda despliega renderizado distribuido a AWS Lambda y ejecuta renderizados desde su computadora o CI. De punta a punta son tres comandos:
npx hyperframes lambda deploy # aprovisionar pila SAM (Lambda + Step Functions + S3)
npx hyperframes lambda render ./my-project --width 1920 --height 1080 --wait
npx hyperframes lambda destroy # desmantelar (el bucket S3 se conserva)
Use Lambda cuando un renderizado sea demasiado largo / demasiado grande para un solo host (videos de varios minutos, 4K, lotes paralelos grandes) y tenga credenciales de AWS configuradas. Para la iteración del bucle de desarrollo, quédese con el render local.
Consulte 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.
Puerta de Finalización Mínima
Puertas estáticas
npx hyperframes lint
npx hyperframes validate
Agregue 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 a través de data-composition-src, por lo que no pueden detectar fallos de montaje entre archivos (consulte hyperframes-core → references/sub-compositions.md, "Errores comunes"). La única puerta que los detecta es una que realmente carga index.html y recorre la línea de tiempo.
Use hyperframes snapshot — carga el proyecto de la misma manera que lo hace render (por lo que ejecuta la misma ruta de montaje) pero solo captura las marcas de tiempo que solicita, por lo que toma segundos en lugar de un renderizado completo:
# Capturar un fotograma en el punto medio de cada subcomposición.
# Puntos medios = data-start + data-duration/2 para cada ranura de host en index.html.
npx hyperframes snapshot --at <t1>,<t2>,<t3>,...
# O, si no necesita orientación por escena, una muestra espaciada uniformemente:
npx hyperframes snapshot --frames 9
La salida termina en snapshots/frame-NN-at-Xs.png. Examine cada fotograma con el plan de la escena.
Banderas rojas por fotograma (cada una se asigna a un modo de falla específico que las puertas estáticas no detectan):
| Lo que ve | Causa raíz |
|---|---|
| El texto aparece pequeño + sin estilo en la esquina superior izquierda | El bloque <style> quedó en <head> fuera de <template> (Error 1) — ningún CSS llegó al DOM vivo |
| Los elementos SVG/icono se agrandan 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 el fondo + la marca de agua | Host-id ≠ template id (Error 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 2 — confirmación directa |
snapshots/ se puede eliminar después de examinar; el renderizado final visible para el usuario es una pasada separada con npx hyperframes render.