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; при наступному запуску буде згенеровано новий ідентифікатор встановлення.

Пов'язане