Youka CLI - Youka Docs

La Youka CLI incapsula l’API pubblica, così puoi creare karaoke da una canzone, personalizzare i testi e lo stile del video, ed esportare un MP4 finale dal tuo terminale o da un agente.

Installazione

npm install -g @youka/cli

pnpm add -g @youka/cli

yarn global add @youka/cli

Verifica l’installazione:

youka --version
youka --help

Configura l’autenticazione

Ottieni una chiave API

Vai su online.youka.io/account, apri API keys e copia una nuova chiave.

Salva la chiave

Salva in modo persistente la chiave in ~/.youka/config.json:

youka login YOUR_API_KEY

Oppure esportala come variabile d’ambiente:

export YOUKA_API_KEY=YOUR_API_KEY

Crea un karaoke da un file

Usa un file audio o video locale come sorgente:

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

Questo carica la sorgente, crea il progetto karaoke, esegue il render di un export e scarica il video MP4 finale.

Crea un karaoke da un URL

Passa un URL sorgente HTTP o HTTPS invece di un percorso file:

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

Per URL di video ospitati, Youka usa yt-dlp per scaricare dall’URL. Puoi installare le dipendenze per il download da URL prima della prima importazione da URL:

youka deps ensure --for url

Riferimento

Account

Accedi, esci e ispeziona lo stato di autenticazione.

Credits

Ispeziona il saldo attuale e i pacchetti di crediti in scadenza.

Billing

Mostra i prezzi e crea URL per checkout o portale.

Projects

Crea, ispeziona, attendi e aggiorna i progetti.

Exports

Esegui il render di artefatti di export nel cloud o in locale e scaricali.

Presets

Gestisci configurazioni di render riutilizzabili.

Media

Carica e gestisci media riutilizzabili.

Tasks

Ispeziona, quando necessario, lo stato delle attività di basso livello.

Dependencies

Ispeziona e installa le dipendenze per l’importazione da URL e il render locale.

Global options

Flag disponibili su ogni comando.

Pronta per gli agenti per impostazione predefinita

Ogni comando supporta una modalità leggibile dalle macchine che restituisce un singolo involucro JSON con una struttura stabile. Usa questi flag per pilotare la CLI da agenti o script:

Flag	Scopo
`--json`	Stampa esattamente un involucro JSON su stdout. Avanzamento e log sono soppressi.
`--body <file\|->`	Unisce un payload JSON da un file o da stdin. I flag della CLI sovrascrivono i campi corrispondenti.
`--wait`	Interroga i job asincroni (creazione progetto, export) finché non raggiungono uno stato finale.
`--idempotency-key <key>`	Passa una chiave di idempotenza a qualsiasi operazione di scrittura.
`--quiet`	Sopprime l’output di avanzamento non-JSON quando usato con `--wait`.
`--api <url>`	Sovrascrive l’URL base dell’API pubblica.

Struttura dell’involucro JSON:

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

In caso di errore:

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

Vedi Global options per l’elenco completo.

Export nel cloud vs in locale

export create viene eseguito nel cloud per impostazione predefinita. Passa --local per eseguire il render sulla tua macchina usando la toolchain Remotion inclusa. I render locali richiedono le dipendenze di render:

youka deps ensure --for render

Vedi Exports per il flusso di lavoro completo.

Cosa fare dopo

Account - salva la tua chiave API
Projects - crea ed elabora progetti
Exports - esegui il render di un video karaoke finale
AI agents - pilota la CLI da un flusso di lavoro automatizzato

​Installazione

​Configura l’autenticazione

​Crea un karaoke da un file

​Crea un karaoke da un URL

​Riferimento