@youka/cli

Official command-line client for the Youka REST API.

Use this package to create karaoke videos from your terminal: upload audio or video, sync or transcribe lyrics, create a karaoke project, render the final video, and download the MP4.

Install

npm install -g @youka/cli

API key

Create an API key at online.youka.io/account under API keys.

Log in once:

youka login "yk_..."

Or keep the key in your environment:

export YOUKA_API_KEY="yk_..."

Inspect which account, key source, and API URL are active:

youka whoami --json

Create a karaoke video

Create a project from a local song, sync your lyrics, export the karaoke video, and download the MP4:

youka project create ./song.mp3 \
  --title "Artist - Song" \
  --mode align \
  --lyrics "$(cat lyrics.txt)" \
  --sync-model audioshake-alignment \
  --split-model mdx23c \
  --wait \
  --json

Then export the finished project:

youka export create proj_123 \
  --resolution 1080p \
  --quality high \
  --wait \
  --download \
  --output ./karaoke.mp4 \
  --json

Or do the whole flow in one command:

youka project create ./song.mp3 \
  --mode align \
  --lyrics "$(cat lyrics.txt)" \
  --download \
  --output ./karaoke.mp4 \
  --json

Transcribe lyrics automatically

Use transcription when you do not already have lyrics text:

youka project create ./song.mp3 \
  --mode transcribe \
  --download \
  --output ./karaoke.mp4 \
  --json

Use a hosted media URL

youka project create https://example.com/song.mp4 \
  --mode align \
  --lyrics "$(cat lyrics.txt)" \
  --download \
  --output ./karaoke.mp4 \
  --json

Install local helper binaries when needed for URL downloads and local rendering:

youka deps status --json
youka deps ensure --for all --json
youka deps ensure --for render --update --json
youka deps path ffmpeg

Docs

• CLI guide: https://docs.youka.io/en/cli
• JavaScript SDK: https://docs.youka.io/en/sdk