Youka CLI - Youka Docs

Youka CLI оборачивает публичный API, чтобы вы могли создавать караоке из песни, настраивать текст и стиль видео и экспортировать готовый MP4 из терминала или из агента.

Установка

npm install -g @youka/cli

pnpm add -g @youka/cli

yarn global add @youka/cli

Проверьте установку:

youka --version
youka --help

Настройка аутентификации

Получите API-ключ

Перейдите на online.youka.io/account, откройте API keys и скопируйте новый ключ.

Сохраните ключ

Сохраните ключ в ~/.youka/config.json:

youka login YOUR_API_KEY

Или экспортируйте его как переменную окружения:

export YOUKA_API_KEY=YOUR_API_KEY

Создание караоке из файла

Используйте локальный аудио- или видеофайл в качестве источника:

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

Эта команда загружает исходник, создаёт проект караоке, рендерит экспорт и скачивает готовое MP4-видео.

Создание караоке по URL

Передайте исходный URL (HTTP или HTTPS) вместо пути к файлу:

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

Для размещённых видео-URL Youka использует yt-dlp, чтобы скачать файл по URL. Перед первым импортом по URL вы можете установить зависимости для скачивания:

youka deps ensure --for url

Справочник

Account

Войдите, выйдите и проверьте состояние аутентификации.

Credits

Проверьте текущий баланс и пакеты кредитов, срок действия которых истекает.

Billing

Просматривайте цены и создавайте URL для оплаты или портала.

Projects

Создавайте проекты, просматривайте их, ожидайте завершения и обновляйте.

Exports

Рендерите артефакты экспорта в облаке или локально и скачивайте их.

Presets

Управляйте переиспользуемыми конфигурациями рендера.

Media

Загружайте и управляйте переиспользуемыми медиафайлами.

Tasks

При необходимости проверяйте низкоуровневое состояние задач.

Dependencies

Проверяйте и устанавливайте зависимости для импорта по URL и локального рендера.

Global options

Флаги, доступные в каждой команде.

По умолчанию готов для агентов

Каждая команда поддерживает машиночитаемый режим, который возвращает один JSON-конверт со стабильной структурой. Используйте эти флаги, чтобы управлять CLI из агентов или скриптов:

Флаг	Назначение
`--json`	Вывести ровно один JSON-конверт в stdout. Прогресс и логи подавляются.
`--body <file\|->`	Объединить JSON-пayload из файла или stdin. Флаги CLI переопределяют совпадающие поля.
`--wait`	Опрос async-задач (создание проекта, экспорты) до достижения терминального состояния.
`--idempotency-key <key>`	Передать ключ идемпотентности в любую операцию записи.
`--quiet`	Подавлять не-JSON вывод прогресса при использовании с `--wait`.
`--api <url>`	Переопределить базовый URL публичного API.

Форма JSON-конверта:

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

При ошибке:

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

Полный список см. в разделе Global options.

Облачный vs локальный экспорт

export create по умолчанию выполняется в облаке. Передайте --local, чтобы рендерить на вашей машине с использованием поставляемого toolchain Remotion. Для локального рендера требуются зависимости рендера:

youka deps ensure --for render

Полный рабочий процесс см. в разделе Exports.

Что дальше

Account — сохраните ваш API-ключ
Projects — создавайте и обрабатывайте проекты
Exports — рендерите готовое караоке-видео
AI agents — управляйте CLI из автоматизированного workflow-а

​Установка

​Настройка аутентификации

​Создание караоке из файла

​Создание караоке по URL

​Справочник