Youka CLI - Youka Docs

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

Installation

npm install -g @youka/cli

Überprüfe die Installation:

youka --version
youka --help

Auth einrichten

API-Schlüssel abrufen

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

Schlüssel speichern

Speichere den Schlüssel 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

Verwende 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

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

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

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

youka deps ensure --for url

Referenz

Konto

Anmelden, abmelden und Auth-Status prüfen.

Guthaben

Aktuelles Guthaben und auslaufende Guthabenpakete prüfen.

Abrechnung

Preise anzeigen und Checkout- oder Portal-URLs erstellen.

Projekte

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

Exporte

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

Voreinstellungen

Wiederverwendbare Render-Konfigurationen verwalten.

Medien

Wiederverwendbare Medien hochladen und verwalten.

Aufgaben

Bei Bedarf den Low-Level-Status von Aufgaben prüfen.

Abhängigkeiten

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

Globale Optionen

Flags, die bei jedem Befehl verfügbar sind.

Standardmäßig agentenfähig

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

Flag	Zweck
`--json`	Gibt genau einen JSON-Umschlag auf stdout aus. Fortschritt und Logs werden unterdrückt.
`--body <file\|->`	Fügt eine JSON-Nutzlast aus einer Datei oder stdin zusammen. CLI-Flags überschreiben passende Felder.
`--wait`	Fragt asynchrone Jobs (project create, exports) ab, bis sie einen Endzustand erreichen.
`--idempotency-key <key>`	Übergibt einen Idempotenzschlüssel an jede Schreiboperation.
`--quiet`	Unterdrückt nicht-JSON-Fortschrittsausgaben bei Verwendung mit `--wait`.
`--api <url>`	Überschreibt die Basis-URL der öffentlichen API.

Struktur des JSON-Umschlags:

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

Bei Fehlern:

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

Siehe Globale Optionen für die vollständige Liste.

Cloud- vs. lokaler Export

export create läuft standardmäßig in der Cloud. Übergib --local, um auf deinem Rechner mit der gebündelten Remotion-Toolchain zu rendern. Lokale Renderings erfordern die Render-Abhängigkeiten:

youka deps ensure --for render

Siehe Exporte für den vollständigen Ablauf.

Wie geht es weiter

Konto – deinen API-Schlüssel speichern
Projekte – Projekte erstellen und verarbeiten
Exporte – ein fertiges Karaoke-Video rendern
AI agents – die CLI aus einem automatisierten Workflow steuern

Documentation Index

​Installation

​Auth einrichten

​Karaoke aus einer Datei erstellen

​Karaoke aus einer URL erstellen

​Referenz