Skip to main content
Каждая команда youka принимает один и тот же набор глобальных флагов. Они управляют режимом вывода, обработкой ввода, поведением ожидания и целевым API.

​
Flags

FlagDescription
--jsonМашинный режим: вывести ровно один JSON-конверт в stdout. Логи и индикаторы прогресса подавляются.
--body <file|->Объединить JSON-объект из файла или stdin. Флаги CLI переопределяют совпадающие поля из --body.
--waitОпрашивать созданный ресурс, пока он не достигнет терминального состояния. Часто используется в project create, project sync, project separate и export create.
--idempotency-key <key>Передать ключ идемпотентности в API для операций записи.
--quietПодавлять не-JSON вывод прогресса при использовании вместе с --wait.
--no-colorОтключить ANSI-цвета в выводе.
--api <url>Переопределить базовый URL API. Суффикс /ru/api/v1 добавляется автоматически при необходимости.

​
JSON envelope

С --json CLI выводит ровно один конверт в stdout и ничего больше. Успех: 
{
  "ok": true,
  "data": {
    /* command result */
  }
}
Ошибка: 
{
  "ok": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Missing or invalid API key.",
    "details": null
  }
}
Коды завершения:
CodeMeaning
0Успех.
1Ошибка выполнения (сеть, API, рендеринг).
2Неверный ввод (плохие флаги, нечитаемый payload).
Пропустите конверт через jq для скриптинга: youka project show $ID --json | jq '.data.state'.

​
Передача JSON-тел

Любая команда создания или обновления принимает --body для полного тела запроса. Используйте его вместо экранирования большого JSON в командной строке. 
youka preset create --body ./preset.json --json

​
Ожидание асинхронных задач

--wait опрашивает созданный ресурс за вас и возвращает финальное состояние. Без --wait команды возвращаются сразу после постановки задачи в очередь. 
youka project create ./song.mp3 --wait --json
youka export create $ID --wait --download --output ./out.mp4
В скриптах используйте --wait вместе с --quiet, чтобы скрыть прогресс-бар, но при этом всё равно вывести JSON-результат.

​
Идемпотентность

Передавайте --idempotency-key, чтобы команды записи было безопасно повторять. Повторное использование одного и того же ключа с тем же payload возвращает исходный результат вместо создания дубликата. 
youka project create ./song.mp3 \
  --idempotency-key "import-2026-04-08-song-001" \
  --json
Используйте ключи идемпотентности всякий раз, когда агент может повторить запрос после таймаута.

​
Переменные окружения

VariablePurpose
YOUKA_API_KEYAPI-ключ, используемый, если он не задан через youka login.
YOUKA_API_BASE_URLАльтернативный базовый URL API. Переопределяется через --api.

​
Что дальше

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