ReelaDocs

Referencia de comandos

Sintaxis, argumentos y opciones de los comandos de Reela. Ejecuta reela <command> -h para obtener ayuda en la versión instalada.

Sintaxis, argumentos y opciones de los comandos de Reela. Ejecuta reela <command> -h para obtener ayuda en la versión instalada.

login / logout / whoami / status

reela login
reela logout
reela whoami
reela status
  • login inicia sesión mediante autorización en el navegador. Abre la URL mostrada, introduce el código si se te solicita y espera a que termine el comando.
  • logout cierra la sesión del perfil seleccionado.
  • whoami muestra la cuenta con sesión iniciada.
  • status comprueba el estado de la cuenta y de la entrega.
reela --profile work login
reela --profile work whoami

create

Crea un video a partir de una instrucción y archivos multimedia opcionales.

reela create [PROMPT] --visual <TYPE> [OPTIONS]

Proporciona una instrucción posicional o --prompt-file. Se requiere al menos un --visual.

OpciónDescripción
--prompt-file <PATH>Lee la instrucción de un archivo en lugar de usar una instrucción posicional.
--visual <TYPE>Tipo visual. Repite la opción para indicar varios tipos; consulta más abajo.
--duration <SECONDS>Duración del video. Valor predeterminado: 30.
--layout <LAYOUT>landscape (predeterminado), portrait o square.
--tier <TIER>Opción de calidad y costo de reela tiers list.
--avatar <ID>Avatar que se incluirá. Repite la opción para incluir varios avatares.
--file <ROLE:PATH>Adjunta un archivo local con un rol. Repite la opción para adjuntar varios archivos.
--session <TITLE>Agrupa videos relacionados bajo un título descriptivo del proyecto.
--music-videoGenera una canción y un video musical. No la combines con archivos de música de fondo.
--dry-runValida y calcula los créditos estimados sin cargar archivos ni crear una tarea.

Tipos visuales y roles de archivo

  • ai-video: genera tomas; opcionalmente, adjunta reference-image:<path> para el estilo.
  • avatar: incluye un presentador seleccionado con --avatar <id>.
  • original-clip: edita metraje sin su audio; adjunta video-source:<path>.
  • original-sync: conserva el audio del metraje; adjunta video-audio:<path>.
  • image-video: anima una imagen; adjunta original-image:<path>.

Usa background-music:<path> para tu propia música. Repite las opciones en lugar de unir los valores separados por comas.

Ejemplos

reela create "A product demo" --visual ai-video --layout portrait --dry-run
reela create --prompt-file brief.txt --visual image-video --file original-image:photo.png --dry-run

Revisa primero los créditos estimados. Inicia el daemon y configura tu suscripción de entrega antes de quitar --dry-run para enviar la solicitud. El envío puede consumir créditos; Reela genera el video en segundo plano y entrega el resultado terminado a través de tu suscripción. Consulta la sección daemon / subscribe más abajo.

tasks

Enumera las tareas e inspecciona los detalles de cada tarea o las versiones de salida. Para la generación de videos de larga duración, usa las suscripciones de finalización del daemon para recibir automáticamente los resultados terminados.

reela tasks list [--status <STATUS>] [--limit <N>] [--offset <N>] [--sort <ORDER>]
reela tasks get <TASK_ID>
reela tasks versions <TASK_ID> --origin brand [--limit <N>] [--offset <N>]
reela tasks download <TASK_ID> [--video <ID>] [--out-dir <DIR>]
  • list: de forma predeterminada, muestra 20 resultados, con desplazamiento 0, ordenados por created_at:desc. Filtros de estado: cancelled, pending, processing, failed, partial, completed.
  • get: muestra el estado y el progreso de la tarea, así como la instrucción de creación cuando esté disponible.
  • versions: enumera las versiones de salida de Brand, incluidas las salidas sin terminar. Requiere --origin brand. Límite: 1–100 (valor predeterminado: 20); el desplazamiento predeterminado es 0.
  • download: descarga el video terminado en el directorio configurado o en --out-dir (forma abreviada: -o). Usa --video para seleccionar una salida de Brand completada.
reela tasks list --status completed --output json

collection

Enumera los videos de una colección existente, incluidos los títulos y las descripciones.

reela collection list [--session <TITLE>]
reela collection list --session "Product launch" --output json

REELA_COLLECTION_ID tiene prioridad si está definido. De lo contrario, el comando busca la sesión en el perfil seleccionado. La sesión predeterminada es reela-YYYY-MM-DD, basada en la fecha local, no en la última sesión utilizada. Este comando no crea una colección; usa create para iniciar una.

Los videos completados pueden incluir URL de descarga. Trata estos enlaces como información confidencial y no los publiques; no des por sentado que todos los enlaces requieren autenticación o que tienen el mismo plazo de caducidad.

avatar

reela avatar list
reela avatar get <ID>

avatar list enumera los avatares disponibles; avatar get muestra los detalles de un avatar. Usa su ID con create --avatar.

tiers

Enumera las opciones de generación y el nivel predeterminado del perfil seleccionado.

reela tiers list
reela tiers list --output json
reela --profile work tiers list

La salida de texto sin formato muestra la etiqueta entrecomillada de cada nivel, su descripción y el indicador de valor predeterminado. La salida JSON incluye:

  • default_tier: la etiqueta del nivel predeterminado, cuando esté disponible.
  • tiers: la lista de opciones, con label, content (descripción) y is_default para cada elemento.

Usa la etiqueta exacta como create --tier, conservando las mayúsculas y minúsculas y entrecomillando las etiquetas que contengan espacios. Las descripciones de los niveles explican las opciones de generación disponibles. El acceso a la cuenta se comprueba al validar o enviar una solicitud.

reela create "A product demo" --visual ai-video \
  --tier "<tier-label>" --dry-run --output json

Sustituye <tier-label> por una etiqueta devuelta por tiers list. La vista previa devuelve credits_cost y quota_after sin crear una tarea. Quita --dry-run para enviar la solicitud con las mismas opciones.

Si no se especifica --tier, create usa el valor predeterminado disponible para el CLI. Si no hay ningún valor predeterminado disponible, actualiza con tiers list o proporciona --tier. Selecciona el mismo perfil al enumerar los niveles y crear el video.

brand

Enumera y aplica paquetes de marca existentes.

reela brand list [--limit <N>] [--offset <N>]
reela brand apply <BRAND_ID> --task <TASK_ID> [--inputs '<JSON>']

list muestra de forma predeterminada 20 resultados y el desplazamiento 0; el límite debe ser de 1–100. apply aplica un paquete de marca y espera hasta 10 minutos a que se termine el video.

Usa --inputs para proporcionar los valores que requiere tu paquete de marca. Acepta un objeto JSON con valores de tipo cadena, número o booleano; no admite matrices, objetos anidados ni null. Los nombres de los parámetros los define el paquete. Por ejemplo:

reela brand apply <BRAND_ID> --task <TASK_ID> \
  --inputs '{"AUTHOR_PROFILE_IMAGE_URL":"https://example.com/avatar.jpg","AUTHOR_NAME":"Alex"}'

Los valores obligatorios que falten en la plantilla se rechazan antes del renderizado. Proporciona los valores que falten antes de volver a aplicar el paquete. No incluyas credenciales ni secretos en estos parámetros.

Si se interrumpe la espera, la operación puede continuar. Comprueba las versiones de salida antes de volver a aplicar el paquete:

reela tasks versions <task-id> --origin brand
reela tasks download <task-id> --video <video-id>

edit

Exporta JSON de edición para continuar editando en Reela, o exporta un proyecto independiente de Remotion para editarlo localmente sin restricciones.

reela edit versions <TASK_ID>
reela edit export-json <TASK_ID> --file <PATH> [--version <N>]
reela edit export-remotion <TASK_ID> [--video <VIDEO_ID>] [--out-dir <DIR>]
reela edit validate <FILE>
reela edit save <FILE>
reela edit render <FILE>
  • versions: enumera las versiones editables, incluidos los borradores y los renderizados fallidos.
  • export-json: exporta la versión de edición más reciente o la seleccionada como JSON para editarla en Reela. Edita el archivo, valídalo y luego usa save o render.
  • export-remotion: exporta un proyecto independiente de Remotion para editarlo localmente sin restricciones. Si no se especifica --video, exporta la edición actual; usa --video para seleccionar una versión de video. --out-dir (forma abreviada: -o) es el propio directorio del proyecto, no su directorio principal. Si no se especifica, se crea una carpeta del proyecto en el directorio de descarga configurado. Si el destino ya existe, se conserva y se añade un sufijo numérico. La salida JSON contiene el directorio final path.
  • validate: comprueba si hay errores en el JSON de edición sin cargar su contenido. Requiere iniciar sesión y disponer de conexión a Internet.
  • save: guarda el borrador sin renderizarlo. Abre la URL de vista previa devuelta para revisarlo.
  • render: guarda el borrador y espera a que termine el renderizado. Si todo sale bien, devuelve el ID de la tarea y la URL de vista previa solo después de guardar la salida renderizada. El servicio espera hasta diez minutos; el CLI permite diez minutos y treinta segundos para recibir la respuesta. Un error de renderizado confirmado termina con el código 10; un tiempo de espera agotado termina con el código 6. Los envíos no se reintentan automáticamente. Interrumpir la espera o agotar el tiempo de espera no cancela el renderizado; comprueba reela edit versions <task-id> antes de volver a renderizar.
reela edit export-json <task-id> --file edit.json
reela edit validate edit.json
reela edit save edit.json

La exportación de Remotion espera a que termine el empaquetado, descarga y descomprime el proyecto, y no conserva el archivo ZIP. El empaquetado puede tardar hasta diez minutos. Los envíos no se reintentan automáticamente; interrumpir la espera o agotar su tiempo no cancela el empaquetado en segundo plano. El proyecto exportado no se puede volver a importar a Reela y no usa los comandos validate, save ni render.

show

Descarga y edita un espacio de trabajo Show que contiene show.yaml, subjects.yaml y episodes/*.md.

reela show list [--limit <N>] [--offset <N>]
reela show download <SHOW_ID> [--out-dir <DIR>] [--force]
reela show validate
reela show update [--dry-run] [--yes]

list muestra de forma predeterminada 20 resultados y el desplazamiento 0. Ejecuta validate y update desde el directorio del espacio de trabajo descargado. update --dry-run muestra una vista previa sin escribir datos localmente ni de forma remota; --yes envía la solicitud sin confirmación interactiva.

Opciones destructivas: download --force elimina todos los archivos existentes en el directorio de destino, incluidos los que no estén relacionados. update envía el espacio de trabajo local completo: si se elimina un archivo Episode, también se elimina de forma remota, y el contenido editable local sobrescribe el contenido remoto sin comprobar versiones ni combinar cambios. Los Shows en proceso de generación o en pausa no se pueden actualizar.

reela show download <show-id> --out-dir ./my-show
cd my-show
reela show validate
reela show update --dry-run
reela show update

show subject

reela show subject download (--all | --subject-id <ID>) [--history] [--force]
reela show subject replace-image <SUBJECT_ID> --file <PATH>
reela show subject regenerate <SUBJECT_ID> --prompt-file <PATH> --model <MODEL> [--reference-image-id <ID>] [--yes]
  • download: descarga imágenes de todos los Subjects o de un único Subject en el espacio de trabajo actual. --history incluye imágenes históricas; --force sobrescribe los archivos de imagen existentes.
  • replace-image: carga una imagen estática JPEG, PNG o WebP (máximo de 20 MiB y 40 megapíxeles), conservando el historial de imágenes y los videos existentes.
  • regenerate: genera una imagen y espera hasta 10 minutos. El archivo de instrucciones debe estar en UTF-8. --reference-image-id selecciona una imagen del espacio de trabajo actual; --yes autoriza la generación sin confirmación interactiva.

Las descargas de Show contienen archivos estructurados, no imágenes; descarga las imágenes de Subject por separado. Para seleccionar una imagen histórica, edita current_image_id en subjects.yaml y luego actualiza.

Interrumpir la generación de imágenes solo detiene la espera, no la generación en segundo plano. Si vuelves a ejecutarla, se puede generar otra imagen y cobrarte de nuevo.

config

Administra la configuración y los perfiles de cuenta.

reela config list
reela config get <KEY>
reela config set <KEY> <VALUE>
reela config profiles list
reela config profiles create <NAME>
reela config profiles show [NAME]
reela config profiles use <NAME>
reela config profiles delete <NAME>

La configuración se aplica al perfil seleccionado. Usa config list para consultar las claves y sus valores actuales. profiles use cambia el perfil predeterminado; --profile selecciona un perfil para un único comando.

reela config set delivery.download ~/Videos/reela
reela config profiles create work
reela --profile work login
reela config profiles use work

daemon / subscribe

Administra la entrega automática local en Linux y macOS. Estos comandos no están disponibles en Windows.

reela daemon start [--foreground] [--keep-backlog]
reela daemon stop
reela daemon status
reela daemon install
reela daemon uninstall
reela daemon logs [--tail <N>]
  • start: inicia la entrega automática. --foreground mantiene el daemon en primer plano, conectado al terminal. Si este perfil no tiene progreso de entrega guardado, --keep-backlog también entrega los videos completados anteriormente que aún estén disponibles para la entrega automática. De lo contrario, la entrega continúa desde el progreso guardado.
  • stop detiene la entrega; status muestra su estado actual.
  • install activa el inicio al iniciar sesión; uninstall desactiva el inicio automático.
  • logs muestra los registros recientes; el valor predeterminado de --tail es 20 líneas.

subscribe

reela subscribe list
reela subscribe status
reela subscribe add download [--dir <DIR>]
reela subscribe add email [--address <EMAIL>]
reela subscribe add script --path <PATH> [--timeout-seconds <N>] [--max-retries <N>]
reela subscribe remove <METHOD>

Los métodos son download, email o script. El correo electrónico predeterminado es el de la cuenta. Un script debe ser un ejecutable de confianza que lea un objeto JSON de stdin y termine con el código 0 si se ejecuta correctamente. --max-retries es el número máximo total de intentos de entrega; usa reela subscribe add -h para la carga del script.

Al añadir un método, se intenta iniciar un daemon detenido. Después de cambiar la configuración de entrega, reinicia un daemon que ya esté en ejecución para que la cargue: si el daemon se inició manualmente, usa reela daemon stop seguido de reela daemon start; si el inicio lo gestiona un servicio, reinícialo mediante tu gestor de servicios.

reela subscribe add download --dir ~/Videos/reela
reela subscribe status

update

Actualiza el CLI instalado y consulta su versión.

reela update
reela --version