Перейти к содержанию

Конфигурация

ycli читает настройки из окружения или из файла .env в рабочем каталоге. Неверное значение приводит к ошибке при запуске с именем переменной (код возврата 2).

Учётные данные

Переменная Значение
YANDEX_ID_OAUTH_TOKEN OAuth-токен Яндекса с доступом к Трекеру, Вики и Формам (запасное имя — YCLI__AUTH__OAUTH_TOKEN)
YANDEX_CLOUD_IAM_TOKEN готовый IAM-токен вместо OAuth-токена; живёт до 12 часов. Способ входа задаётся ровно один: второй — ошибка (код возврата 2)
YANDEX_CLOUD_SERVICE_ACCOUNT_KEY_FILE путь к авторизованному ключу сервисного аккаунта (yc iam key create --output key.json) вместо токена; ycli обменивает его на IAM-токены и обновляет их. Нужен extra service-account
YANDEX_CLOUD_SERVICE_ACCOUNT_KEY тот же ключ текстом JSON — для хранилища секретов, которое выдаёт значения, а не файлы
YANDEX_ID_ORGANIZATION_ID идентификатор организации Яндекс 360, передаётся как X-Org-Id (запасное имя — YCLI__AUTH__ORGANIZATION_ID)
YANDEX_CLOUD_ORGANIZATION_ID идентификатор организации Yandex Cloud, передаётся как X-Cloud-Org-Id. Нужна одна организация любого вида; если заданы обе, Трекер, Вики и Формы получают организацию Яндекс 360
YCLI_PROFILE имя сохранённого профиля, из которого берутся токен и организация вместо переменных выше; опция --profile важнее (см. Аутентификация)
YANDEX_OAUTH_CLIENT_ID идентификатор вашего OAuth-приложения, для ycli auth login
YANDEX_OAUTH_CLIENT_SECRET секрет вашего OAuth-приложения: включает device flow в ycli auth login

Экспортированная, но пустая переменная считается незаданной. См. Аутентификация.

DataLens принимает IAM-токен или ключ сервисного аккаунта, но не OAuth-токен, и организацию Yandex Cloud (передаётся как x-dl-org-id). Без них ycli auth status показывает datalens как ненастроенный сервис и говорит, что задать, а код выхода остаётся 0; ycli doctor его пропускает; команда ycli datalens завершается с кодом 2 и тем же текстом.

Настройки

Необязательные настройки задаются по схеме 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_TOOL_ITEMS 50 предел числа элементов в списке инструмента MCP-сервера без limit или all: его ответ целиком попадает в контекст модели (> 0)
YCLI__HTTP__MAX_PAGES 1000 предел числа страниц одного списка: бесконечный список останавливается здесь с предупреждением (> 0)
YCLI__HTTP__MAX_TOKEN_LENGTH 16384 наибольшая длина токена next: более длинный отвергается до разбора (> 0)
YCLI__HTTP__MAX_RETRY_AFTER_SECONDS 60 самая долгая пауза, которую ответ 429 может запросить в Retry-After; при более долгой запрос сразу завершается ошибкой (> 0)
YCLI__HTTP__MAX_WAIT_SECONDS 1380 сколько --wait ждёт долгую операцию (экспорт, копирование, массовое изменение), прежде чем сдаться; сама операция продолжает выполняться (> 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, тайм-аут или потеря соединения: стоит повторить позже
7 есть изменения ошибки нет: с --exit-code команда ycli sync нашла, что отправлять
8 разошлись файл и объект разошлись: объект изменился на сервере после чтения файла или его больше нет
9 устарел список нельзя продолжить с этого токена: начните его заново без токена