Konfiguracja
CLI czyta każde ustawienie z flag, zmiennych środowiskowych, swojego pliku konfiguracyjnego i wbudowanych wartości domyślnych, a wszystko przechowuje w ~/.polylane. Ta strona wymienia kolejność, zmienne i sposób kontrolowania telemetrii.
Pierwszeństwo
CLI rozstrzyga każde ustawienie w tej kolejności, najwyższe wygrywa:
- Flagi CLI, na przykład
--workspace,--api-key,--outputi--timeout. - Zmienne środowiskowe: zestaw
POLYLANE_*plus standardoweNO_COLORiDO_NOT_TRACK. - Tylko dla poświadczenia: tokeny OAuth w
~/.polylane/credentials.json. - Plik konfiguracyjny
~/.polylane/config.json. - Wbudowane wartości domyślne: domena
api.polylane.com, limit czasu 300 sekund, wyjścietextw terminalu ijsonw potoku.
Wyeksportowany POLYLANE_API_KEY zawsze wygrywa z nieaktualnym ~/.polylane/credentials.json, więc runner CI z ustawioną zmienną nie podchwytuje pozostawionych tokenów OAuth. Uwierzytelnianie wymienia tę samą kolejność dla poświadczeń.
Plik konfiguracyjny
~/.polylane/config.json przyjmuje sześć kluczy: domain, workspace_id, api_key, output, timeout i telemetry. Zarządzaj nim przez CLI: config show wypisuje rozstrzygniętą konfigurację, używaną metodę uwierzytelniania i ścieżkę pliku, z zamaskowanymi kluczami API.
polylane config show
polylane config set --key output --value json
Żeby ustawić domyślny obszar roboczy po slugu zamiast po identyfikatorze, uruchom polylane workspace use <slug>. Poświadczenia OAuth leżą osobno w ~/.polylane/credentials.json i odświeżają się same, gdy token dostępu zbliża się do wygaśnięcia.
Zmienne środowiskowe
| Zmienna | Opis |
|---|---|
POLYLANE_API_KEY | Uwierzytelnianie bez zapisywania klucza na dysku |
POLYLANE_WORKSPACE_ID | Ustawienie obszaru roboczego dla bieżącej powłoki |
POLYLANE_API_DOMAIN | Wskazanie innej nazwy hosta API; sama nazwa hosta, bez protokołu |
POLYLANE_OUTPUT | Wymuszenie wyjścia text albo json |
POLYLANE_TIMEOUT | Limit czasu żądania w sekundach |
POLYLANE_VERBOSE | Włączenie szczegółowego logowania |
POLYLANE_TELEMETRY=0 | Wyłączenie telemetrii dla tego środowiska |
DO_NOT_TRACK=1 | Uniwersalna rezygnacja z telemetrii; nadpisuje każde inne ustawienie telemetrii, łącznie z plikiem konfiguracyjnym |
NO_COLOR | Wyłączenie kolorów ANSI |
Telemetria
Anonimowa telemetria użycia jest domyślnie włączona. Zapisuje nazwę polecenia, nazwy flag, liczbę argumentów pozycyjnych, kod wyjścia i kategorię błędu, czasy trwania, wersje CLI i Node, szczegóły systemu operacyjnego, anonimowy identyfikator instalacji i identyfikator obszaru roboczego. Wartości flag, argumenty, ścieżki plików, wyjście poleceń i pełne komunikaty błędów pozostają poza nią, a polylane telemetry status pokazuje dokładnie, co jest wysyłane i gdzie.
Wyłącz ją na stałe przez polylane telemetry disable, które pisze do pliku konfiguracyjnego, albo dla jednego środowiska przez POLYLANE_TELEMETRY=0 lub DO_NOT_TRACK=1. Decyzja zapada według DO_NOT_TRACK, potem POLYLANE_TELEMETRY, potem pliku konfiguracyjnego, a na końcu domyślnego włączenia; nie ma flagi na pojedyncze wywołanie.
Pliki na dysku
Wszystko, co CLI przechowuje, leży w ~/.polylane:
| Plik | Opis |
|---|---|
config.json | Zapisane ustawienia: domena, obszar roboczy, klucz API, wyjście, limit czasu, telemetria |
credentials.json | Tokeny OAuth |
telemetry.json | Anonimowy identyfikator instalacji i liczniki uruchomień |
update-state.json | Stan sprawdzania aktualizacji |
Usuń katalog, żeby całkowicie zresetować CLI; przy następnym uruchomieniu zostanie wygenerowany nowy identyfikator instalacji.
Powiązane
- Uwierzytelnianie: metody logowania i sposób wyboru poświadczeń.
- Skrypty: kontrakt wyjścia, flagi dla skryptów i kody wyjścia.