CLI

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

Откуда CLI читает настройки, какие переменные окружения учитывает и как управлять телеметрией.

CLI читает каждую настройку из флагов, переменных окружения, своего файла конфигурации и встроенных значений по умолчанию, а всё хранит в ~/.polylane. Эта страница перечисляет порядок, переменные и способы управления телеметрией.

Приоритет

CLI разрешает каждую настройку в этом порядке, побеждает верхний:

  1. Флаги CLI, например --workspace, --api-key, --output и --timeout.
  2. Переменные окружения: набор POLYLANE_* плюс стандартные NO_COLOR и DO_NOT_TRACK.
  3. Только для учётных данных: токены OAuth в ~/.polylane/credentials.json.
  4. Файл конфигурации ~/.polylane/config.json.
  5. Встроенные значения по умолчанию: домен api.polylane.com, тайм-аут 300 секунд, вывод text в терминале и json при передаче по конвейеру.

Экспортированная POLYLANE_API_KEY всегда побеждает устаревший ~/.polylane/credentials.json, так что CI-раннер с заданной переменной не подхватит оставшиеся токены OAuth. Тот же порядок для учётных данных перечислен в разделе Аутентификация.

Файл конфигурации

~/.polylane/config.json принимает шесть ключей: domain, workspace_id, api_key, output, timeout и telemetry. Управляйте им через CLI: config show печатает разрешённую конфигурацию, используемый метод аутентификации и путь к файлу, маскируя API-ключи.

Terminal
polylane config show
polylane config set --key output --value json

Чтобы задать рабочее пространство по умолчанию по slug вместо идентификатора, выполните polylane workspace use <slug>. Учётные данные OAuth живут отдельно в ~/.polylane/credentials.json и обновляются сами, когда срок токена доступа подходит к концу.

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

ПеременнаяОписание
POLYLANE_API_KEYАутентификация без сохранения ключа на диске
POLYLANE_WORKSPACE_IDРабочее пространство для текущей оболочки
POLYLANE_API_DOMAINДругое имя хоста API; только имя хоста, без протокола
POLYLANE_OUTPUTПринудительный вывод text или json
POLYLANE_TIMEOUTТайм-аут запроса в секундах
POLYLANE_VERBOSEПодробное логирование
POLYLANE_TELEMETRY=0Выключить телеметрию для этого окружения
DO_NOT_TRACK=1Универсальный отказ от телеметрии; переопределяет любую другую настройку телеметрии, включая файл конфигурации
NO_COLORВыключить цвета ANSI

Телеметрия

Анонимная телеметрия использования включена по умолчанию. Она записывает имя команды, имена флагов, число позиционных аргументов, код выхода и категорию ошибки, длительности, версии CLI и Node, сведения об операционной системе, анонимный идентификатор установки и идентификатор рабочего пространства. Значения флагов, аргументы, пути к файлам, вывод команд и полные сообщения об ошибках в неё не попадают, а polylane telemetry status показывает, что именно отправляется и куда.

Выключите её навсегда командой polylane telemetry disable, которая пишет в файл конфигурации, или для отдельного окружения через POLYLANE_TELEMETRY=0 или DO_NOT_TRACK=1. Решение следует DO_NOT_TRACK, затем POLYLANE_TELEMETRY, затем файлу конфигурации, затем значению по умолчанию (включено); флага на один вызов нет.

Файлы на диске

Всё, что хранит CLI, живёт в ~/.polylane:

ФайлОписание
config.jsonСохранённые настройки: домен, рабочее пространство, API-ключ, вывод, тайм-аут, телеметрия
credentials.jsonТокены OAuth
telemetry.jsonАнонимный идентификатор установки и счётчики запусков
update-state.jsonСостояние проверки обновлений

Удалите каталог, чтобы полностью сбросить CLI; новый идентификатор установки создаётся при следующем запуске.

См. также

  • Аутентификация: методы входа и как выбираются учётные данные.
  • Скрипты: контракт вывода, флаги для скриптов и коды выхода.