Конфигурация¶
ycli читает настройки из окружения или из файла .env в рабочем каталоге. Неверное значение приводит
к ошибке при запуске с именем переменной (код возврата 2).
Учётные данные¶
| Переменная | Значение |
|---|---|
YANDEX_ID_OAUTH_TOKEN |
OAuth-токен Яндекса с доступом к Трекеру, Вики и Формам (запасное имя — YCLI__AUTH__OAUTH_TOKEN) |
YANDEX_ID_ORGANIZATION_ID |
идентификатор организации Яндекс 360, передаётся как X-Org-Id (запасное имя — YCLI__AUTH__ORGANIZATION_ID) |
YANDEX_OAUTH_CLIENT_ID |
идентификатор вашего OAuth-приложения, для ycli auth login |
YANDEX_OAUTH_CLIENT_SECRET |
секрет вашего OAuth-приложения: включает device flow в ycli auth login |
Экспортированная, но пустая переменная считается незаданной. См. Аутентификация.
Настройки¶
Необязательные настройки задаются по схеме YCLI__<GROUP>__<SETTING>. Пустая тоже считается незаданной.
| Переменная | По умолчанию | Значение |
|---|---|---|
YCLI__HTTP__TIMEOUT_SECONDS |
30 |
тайм-аут одного запроса, секунды (> 0) |
YCLI__HTTP__RETRIES |
3 |
число повторов идемпотентного запроса после ответа 429 или 5xx (≥ 0) |
YCLI__HTTP__MAX_ITEMS |
500 |
предел числа элементов в списке без --limit или --all (> 0) |
YCLI__HTTP__MAX_PAGES |
1000 |
предел числа страниц одного списка: бесконечный список останавливается здесь с предупреждением (> 0) |
YCLI__HTTP__MAX_RETRY_AFTER_SECONDS |
60 |
самая долгая пауза, которую ответ 429 может запросить в Retry-After; при более долгой запрос сразу завершается ошибкой (> 0) |
YCLI__LOGGING__LEVEL |
WARNING |
DEBUG, INFO, WARNING, ERROR или CRITICAL; -v означает INFO (каждый HTTP-запрос), -vv — DEBUG |
YCLI__LOGGING__FORMAT |
text |
text или json (один объект в строке); логи всегда идут в stderr |
Настройки HTTP-транспорта (YCLI__MCP__*) описаны в разделе
Свой сервер по HTTP.
Коды возврата¶
Завершившаяся ошибкой команда возвращает код, который говорит, что именно пошло не так, поэтому скрипт может ветвиться, не разбирая текст сообщения.
| Код | Значение | Когда |
|---|---|---|
| 0 | успех | команда выполнена |
| 1 | сбой | любой другой сбой: 4xx, который отклонил API, неопознанная ошибка, отказ от подтверждения |
| 2 | использование | неверная командная строка или недопустимая настройка YCLI__… |
| 3 | не найдено | API ответил 404 или токен не видит этот объект |
| 4 | аутентификация | 401 или 403, либо нет учётных данных |
| 5 | лимит запросов | API ответил 429, и повторы закончились (в подсказке указан Retry-After) |
| 6 | временный сбой | 5xx, тайм-аут или потеря соединения: стоит повторить позже |