HyperFrames CLI
Todo se ejecuta a través de npx hyperframes a menos que las instrucciones del proyecto especifiquen un wrapper local. Obedezca exactamente el wrapper local. Requiere Node.js >= 22 y FFmpeg.
Flujo de trabajo
- Andamiar —
npx hyperframes init my-video(ocapturedesde una URL).inittambién verifica las habilidades instaladas contra las más recientes 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 extrae nuestras últimas habilidades independientemente. - Escribir — redacte la composición HTML (consulte la habilidad
hyperframes-core) - Lint —
npx hyperframes lint - Validar —
npx hyperframes validate(errores de tiempo de ejecución + contraste) - Inspección visual —
npx hyperframes inspect - Previsualizar —
npx hyperframes previewabre el Studio, el editor de línea de tiempo donde el usuario puede editar manualmente cualquier cosa (no solo mirar). 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 entre hosts:
npx hyperframes render --docker --strict --output out.mp4 - Nube (largo / grande):
npx hyperframes lambda render ./my-project --width 1920 --height 1080 --wait(consulte Lambda a continuación)
- Iterar:
Ejecute 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 e informa errores de consola de tiempo de ejecución más problemas de contraste WCAG. inspect recorre la línea de tiempo e informa texto que se derrama de burbujas/contenedores o fuera del lienzo — y, cuando hay un archivo sidecar *.motion.json presente, verifica la intención de movimiento (disparos de entradas bajo búsqueda, orden de escalonamiento, dentro del cuadro, viveza) contra esa misma línea de tiempo recorrida.
Para trabajos con mucho movimiento, prefiera la iteración impulsada por instantáneas y un sidecar *.motion.json: consulte references/lint-validate-inspect.md para conocer 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. Úselo para cualquier invocación de agente / CI de los comandos compatibles; la salida incluye un sobre_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, sin JSON.doctor --jsonsiempre termina con 0, incluso cuando el entorno está roto. Fíltrelo con el campookde la carga útil:npx hyperframes doctor --json | jq -e '.ok' > /dev/null. Esto aísla los pipelines de los cambios en el lanzamiento 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. - CI gateando 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 agentes. - Render está protegido por el usuario. Nunca renderice automáticamente una vez que las verificaciones pasen. Pause en
preview, dígale al usuario que el video es editable en Studio, y renderice solo después de que 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 no produjo salida". La CLI imprime◇ <ruta>en caso de éxito; para renders largos, también verifique la duración conffprobe -i "$OUTPUT" -show_format -v error.
Enrutamiento
| Quiere… | Lea |
|---|---|
Andamiar 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 en 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 habilidades
- 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. - Renders parametrizados (
--variables) → declarados mediantedata-composition-variablesen<html>; consultehyperframes-corepara el esquema completo.
Lambda (Renderizado en la nube)
hyperframes lambda despliega renderizado distribuido en AWS Lambda y ejecuta renders desde su laptop o CI. De extremo a extremo 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 # desmontar (el bucket S3 se conserva)
Use Lambda cuando un render 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 de humo visual — 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 (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 ejercita la misma ruta de montaje) pero solo captura las marcas de tiempo que solicita, por lo que son segundos en lugar de un render completo:
# Capture un fotograma en el punto medio de cada subcomposición.
# Puntos medios = data-start + data-duration/2 para cada espacio anfitrión 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 cae en snapshots/frame-NN-at-Xs.png. Examine 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 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 amplían 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 fondo + marca de agua visible | El id del anfitrión ≠ id de la plantilla (Error 2) — la línea de tiempo nunca se ejecutó, fotograma capturado en estado inicial |
El comando de instantánea registra Sub-composition timelines not registered after 45000ms | Error 2 — confirmación directa |
snapshots/ se puede eliminar después de la inspección visual; el render final orientado al usuario es una pasada separada con npx hyperframes render.