Youka CLI - Youka Docs

La Youka CLI encapsule l’API publique afin que vous puissiez créer un karaoké à partir d’une chanson, personnaliser les paroles et le style vidéo, puis exporter un MP4 final depuis votre terminal ou depuis un agent.

Installation

npm install -g @youka/cli

pnpm add -g @youka/cli

yarn global add @youka/cli

Vérifiez l’installation :

youka --version
youka --help

Configurer l’authentification

Obtenir une clé API

Rendez-vous sur online.youka.io/account, ouvrez API keys, puis copiez une nouvelle clé.

Enregistrer la clé

Enregistrez la clé dans ~/.youka/config.json :

youka login YOUR_API_KEY

Ou exportez-la comme variable d’environnement :

export YOUKA_API_KEY=YOUR_API_KEY

Créer un karaoké à partir d’un fichier

Utilisez un fichier audio ou vidéo local comme source :

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

Cela envoie la source, crée le projet de karaoké, génère un export et télécharge la vidéo MP4 finalisée.

Créer un karaoké à partir d’une URL

Passez une URL source HTTP ou HTTPS au lieu d’un chemin de fichier :

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

Pour les URL de vidéos hébergées, Youka utilise yt-dlp pour télécharger depuis l’URL. Vous pouvez installer les dépendances de téléchargement d’URL avant la première importation d’URL :

youka deps ensure --for url

Référence

Account

Connectez-vous, déconnectez-vous et inspectez l’état de l’authentification.

Credits

Consultez le solde actuel et les packs de crédits expirants.

Billing

Affichez les tarifs et créez des URL de paiement ou de portail.

Projects

Créez, inspectez, attendez et mettez à jour des projets.

Exports

Générez des artefacts d’export cloud ou locaux et téléchargez-les.

Presets

Gérez des configurations de rendu réutilisables.

Media

Téléversez et gérez des médias réutilisables.

Tasks

Inspectez l’état des tâches de bas niveau lorsque nécessaire.

Dependencies

Inspectez et installez les dépendances d’import d’URL et de rendu local.

Global options

Options disponibles sur chaque commande.

Prêt pour les agents par défaut

Chaque commande prend en charge un mode lisible par machine qui renvoie une unique enveloppe JSON au format stable. Utilisez ces options pour piloter la CLI depuis des agents ou des scripts :

Option	Objectif
`--json`	Affiche exactement une enveloppe JSON sur stdout. La progression et les logs sont supprimés.
`--body <file\|->`	Fusionne une charge utile JSON depuis un fichier ou stdin. Les options CLI remplacent les champs correspondants.
`--wait`	Interroge les jobs async (création de projet, exports) jusqu’à atteindre un état terminal.
`--idempotency-key <key>`	Transmet une clé d’idempotence à toute opération d’écriture.
`--quiet`	Supprime la sortie de progression non-JSON lorsqu’utilisé avec `--wait`.
`--api <url>`	Remplace l’URL de base de l’API publique.

Format de l’enveloppe JSON :

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

En cas d’échec :

{
  "ok": false,
  "error": {
    "code": "INVALID_INPUT",
    "message": "Human-readable description",
    "details": {
      /* optional */
    }
  }
}

Voir Global options pour la liste complète.

Export cloud vs local

export create s’exécute dans le cloud par défaut. Passez --local pour effectuer le rendu sur votre machine en utilisant la chaîne d’outils Remotion incluse. Les rendus locaux nécessitent les dépendances de rendu :

youka deps ensure --for render

Voir Exports pour le workflow complet.

Et ensuite

Account - enregistrez votre clé API
Projects - créer et traiter des projets
Exports - générer une vidéo de karaoké finalisée
AI agents - piloter la CLI depuis un workflow automatisé

​Installation

​Configurer l’authentification

​Créer un karaoké à partir d’un fichier

​Créer un karaoké à partir d’une URL

​Référence