Skip to main content
Jeder youka-Befehl akzeptiert dieselbe Menge globaler Flags. Sie steuern den Ausgabemodus, die Eingabeverarbeitung, das Warteverhalten und die Ziel-API.

​
Flags

FlagBeschreibung
--jsonMaschinenmodus: genau ein JSON-Envelope nach stdout ausgeben. Logs und Fortschritt werden unterdrückt.
--body <file|->Ein JSON-Objekt aus einer Datei oder von stdin zusammenführen. CLI-Flags überschreiben übereinstimmende Felder aus --body.
--waitDie erstellte Ressource abfragen, bis sie einen Endzustand erreicht. Häufig bei project create, project sync, project separate und export create.
--idempotency-key <key>Einen Idempotency-Key bei Schreiboperationen an die API weiterreichen.
--quietNicht-JSON-Fortschrittsausgabe unterdrücken, wenn es mit --wait kombiniert wird.
--no-colorANSI-Farbausgabe deaktivieren.
--api <url>Die API-Basis-URL überschreiben. Das Suffix /de/api/v1 wird bei Bedarf automatisch angehängt.

​
JSON-Envelope

Mit --json schreibt die CLI genau ein Envelope nach stdout und sonst nichts. Erfolg: 
{
  "ok": true,
  "data": {
    /* command result */
  }
}
Fehler: 
{
  "ok": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Missing or invalid API key.",
    "details": null
  }
}
Exit-Codes:
CodeBedeutung
0Erfolg.
1Laufzeitfehler (Netzwerk, API, Rendering).
2Ungültige Eingabe (falsche Flags, unlesbarer Payload).
Leite das Envelope für Skripting durch jq: youka project show $ID --json | jq '.data.state'.

​
JSON-Bodies übergeben

Jeder Create- oder Update-Befehl akzeptiert --body für den vollständigen Request-Body. Verwende das, statt großes JSON in der Kommandozeile escapen zu müssen. 
youka preset create --body ./preset.json --json

​
Auf asynchrone Jobs warten

--wait fragt die erstellte Ressource in deinem Auftrag ab und gibt den finalen Zustand zurück. Ohne --wait geben Befehle zurück, sobald der Job in die Queue gestellt wurde. 
youka project create ./song.mp3 --wait --json
youka export create $ID --wait --download --output ./out.mp4
Kombiniere --wait in Skripten mit --quiet, um die Fortschrittsanzeige zu unterdrücken und trotzdem das JSON-Ergebnis auszugeben.

​
Idempotenz

Übergib --idempotency-key, um Schreibbefehle sicher wiederholbar zu machen. Die Wiederverwendung desselben Keys mit demselben Payload liefert das ursprüngliche Ergebnis zurück, statt ein Duplikat zu erstellen. 
youka project create ./song.mp3 \
  --idempotency-key "import-2026-04-08-song-001" \
  --json
Verwende Idempotency-Keys immer dann, wenn ein Agent nach einem Timeout möglicherweise erneut versucht.

​
Umgebungsvariablen

VariableZweck
YOUKA_API_KEYAPI-Key, wenn nicht über youka login gesetzt.
YOUKA_API_BASE_URLAlternative API-Basis-URL. Wird von --api überschrieben.

​
Wie geht’s weiter

  • Account - API-Key speichern
  • Projects - dein erster geskripteter Workflow
  • AI agents - Betriebsregeln für Agent-Autoren