Youka CLI - Youka Docs

Die Youka CLI kapselt die öffentliche API, sodass du aus einem Song Karaoke erstellen, Lyrics und Videostil anpassen und ein fertiges MP4 aus deinem Terminal oder über einen Agenten exportieren kannst.

Installieren

npm install -g @youka/cli

pnpm add -g @youka/cli

yarn global add @youka/cli

Installation prüfen:

youka --version
youka --help

Auth einrichten

API-Key holen

Gehe zu online.youka.io/account, öffne API keys und kopiere einen neuen Key.

Key speichern

Speichere den Key dauerhaft in ~/.youka/config.json:

youka login YOUR_API_KEY

Oder exportiere ihn als Umgebungsvariable:

export YOUKA_API_KEY=YOUR_API_KEY

Karaoke aus einer Datei erstellen

Nutze eine lokale Audio- oder Videodatei als Quelle:

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

Das lädt die Quelle hoch, erstellt das Karaoke-Projekt, rendert einen Export und lädt das fertige MP4-Video herunter.

Karaoke aus einer URL erstellen

Übergebe statt eines Dateipfads eine HTTP- oder HTTPS-Quell-URL:

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

Für gehostete Video-URLs verwendet Youka yt-dlp, um von der URL herunterzuladen. Du kannst die URL-Download-Abhängigkeiten vor dem ersten URL-Import installieren:

youka deps ensure --for url

Anleitungen

Bulk Creation

Erstelle Karaoke in einem Batch aus einem Dateiordner oder einer Liste von URLs.

Referenz

Account

Anmelden, abmelden und den Auth-Status prüfen.

Credits

Aktuelles Guthaben und auslaufende Credit-Pakete prüfen.

Billing

Preise anzeigen und Checkout- oder Portal-URLs erstellen.

Projects

Projekte erstellen, prüfen, darauf warten und aktualisieren.

Exports

Export-Artefakte in der Cloud oder lokal rendern und herunterladen.

Presets

Wiederverwendbare Render-Konfigurationen verwalten.

Media

Wiederverwendbare Medien hochladen und verwalten.

Tasks

Bei Bedarf Low-Level-Task-Status prüfen.

Dependencies

Abhängigkeiten für URL-Import und lokales Rendering prüfen und installieren.

Global options

Flags, die bei jedem Command verfügbar sind.

Standardmäßig agentenbereit

Jeder Command unterstützt einen maschinenlesbaren Modus, der ein einzelnes JSON-Envelope mit stabiler Struktur zurückgibt. Verwende diese Flags, um die CLI aus Agenten oder Skripten zu steuern:

Flag	Zweck
`--json`	Gibt genau ein JSON-Envelope auf stdout aus. Fortschritt und Logs werden unterdrückt.
`--body <file\|->`	Merged eine JSON-Payload aus einer Datei oder stdin. CLI-Flags überschreiben passende Felder.
`--wait`	Pollt Async-Jobs (project create, exports), bis sie einen Endzustand erreichen.
`--idempotency-key <key>`	Übergibt einen Idempotency-Key an jede Schreiboperation.
`--quiet`	Unterdrückt nicht-JSON-Fortschrittsausgabe bei Verwendung mit `--wait`.
`--api <url>`	Überschreibt die Base-URL der öffentlichen API.

Struktur des JSON-Envelope:

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

Bei einem Fehler:

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

Siehe Global options für die vollständige Liste.

Cloud- vs. lokaler Export

export create läuft standardmäßig in der Cloud. Übergib --local, um auf deiner Maschine mit der gebündelten Remotion-Toolchain zu rendern. Lokale Renders benötigen die Render-Abhängigkeiten:

youka deps ensure --for render

Siehe Exports für den vollständigen Workflow.

Wie geht’s weiter

Account - deinen API-Key speichern
Projects - Projekte erstellen und verarbeiten
Exports - ein fertiges Karaoke-Video rendern
AI agents - die CLI aus einem automatisierten Workflow steuern

​Installieren

​Auth einrichten

​Karaoke aus einer Datei erstellen

​Karaoke aus einer URL erstellen

​Anleitungen