Youka CLI - Youka Docs

Youka CLI encapsula la API pública para que puedas crear karaoke a partir de una canción, personalizar la letra y el estilo del video, y exportar un MP4 final desde tu terminal o desde un agente.

Instalación

npm install -g @youka/cli

pnpm add -g @youka/cli

yarn global add @youka/cli

Verifica la instalación:

youka --version
youka --help

Configurar autenticación

Obtener una clave de API

Ve a online.youka.io/account, abre API keys, y copia una clave nueva.

Guardar la clave

Guarda la clave en ~/.youka/config.json:

youka login YOUR_API_KEY

O expórtala como una variable de entorno:

export YOUKA_API_KEY=YOUR_API_KEY

Crear karaoke a partir de un archivo

Usa un archivo local de audio o video como fuente:

youka project create ./song.mp3 --download --output ./karaoke.mp4 --wait --json

Esto sube la fuente, crea el proyecto de karaoke, renderiza una exportación y descarga el video MP4 final.

Crear karaoke a partir de una URL

Pasa una URL de origen HTTP o HTTPS en lugar de una ruta de archivo:

youka project create "https://example.com/song.mp4" --download --output ./karaoke.mp4 --wait --json

Para URLs de video alojadas, Youka usa yt-dlp para descargar desde la URL. Puedes instalar las dependencias de descarga por URL antes de la primera importación desde URL:

youka deps ensure --for url

Referencia

Cuenta

Inicia sesión, cierra sesión e inspecciona el estado de autenticación.

Créditos

Inspecciona el saldo actual y los paquetes de créditos próximos a vencer.

Facturación

Muestra precios y crea URLs de checkout o del portal.

Proyectos

Crea, inspecciona, espera y actualiza proyectos.

Exportaciones

Renderiza artefactos de exportación en la nube o en local y descárgalos.

Preajustes

Administra configuraciones de render reutilizables.

Medios

Sube y administra medios reutilizables.

Tareas

Inspecciona el estado de tareas de bajo nivel cuando sea necesario.

Dependencias

Inspecciona e instala dependencias para importación por URL y renderizado local.

Opciones globales

Flags disponibles en cada comando.

Listo para agentes por defecto

Cada comando admite un modo legible por máquinas que devuelve un único sobre JSON con una forma estable. Usa estas flags para controlar el CLI desde agentes o scripts:

Flag	Propósito
`--json`	Imprime exactamente un sobre JSON en stdout. Se suprimen el progreso y los logs.
`--body <file\|->`	Combina un payload JSON desde un archivo o stdin. Las flags del CLI sobrescriben los campos coincidentes.
`--wait`	Hace polling de trabajos asíncronos (project create, exports) hasta que alcanzan un estado terminal.
`--idempotency-key <key>`	Pasa una clave de idempotencia a cualquier operación de escritura.
`--quiet`	Suprime la salida de progreso no JSON cuando se usa con `--wait`.
`--api <url>`	Sobrescribe la URL base de la API pública.

Forma del sobre JSON:

{
  "ok": true,
  "data": {
    /* command result */
  }
}

En caso de error:

{
  "ok": false,
  "error": {
    "code": "INVALID_INPUT",
    "message": "Descripción legible para humanos",
    "details": {
      /* optional */
    }
  }
}

Consulta Opciones globales para la lista completa.

Exportación en la nube vs local

export create se ejecuta en la nube por defecto. Pasa --local para renderizar en tu máquina usando la toolchain de Remotion incluida. Los renderizados locales requieren las dependencias de render:

youka deps ensure --for render

Consulta Exports para el flujo completo.

Qué sigue

Account - guarda tu clave de API
Projects - crea y procesa proyectos
Exports - renderiza un video de karaoke final
AI agents - controla el CLI desde un flujo de trabajo automatizado

​Instalación

​Configurar autenticación

​Crear karaoke a partir de un archivo

​Crear karaoke a partir de una URL

​Referencia