CLI

Yapılandırma

CLI ayarları nereden okur, hangi ortam değişkenlerini tanır ve telemetri nasıl kontrol edilir.

CLI her ayarı bayraklardan, ortam değişkenlerinden, yapılandırma dosyasından ve yerleşik varsayılanlardan okur ve her şeyi ~/.polylane altında saklar. Bu sayfa sırayı, değişkenleri ve telemetrinin nasıl kontrol edildiğini listeler.

Öncelik

CLI her ayarı şu sırayla çözer, en yüksek kazanır:

  1. CLI bayrakları, örneğin --workspace, --api-key, --output ve --timeout.
  2. Ortam değişkenleri: POLYLANE_* kümesi ve standart NO_COLOR ile DO_NOT_TRACK.
  3. Yalnızca kimlik bilgisi için, ~/.polylane/credentials.json içindeki OAuth tokenları.
  4. ~/.polylane/config.json yapılandırma dosyası.
  5. Yerleşik varsayılanlar: alan adı api.polylane.com, zaman aşımı 300 saniye, çıktı terminalde text ve borulandığında json.

Dışa aktarılmış bir POLYLANE_API_KEY her zaman bayat bir ~/.polylane/credentials.json dosyasını yener, bu yüzden değişkeni ayarlanmış bir CI runner'ı artık OAuth tokenlarını almaz. Kimlik doğrulama kimlik bilgileri için aynı sırayı listeler.

Yapılandırma dosyası

~/.polylane/config.json altı anahtar kabul eder: domain, workspace_id, api_key, output, timeout ve telemetry. Onu CLI üzerinden yönet: config show çözümlenmiş yapılandırmayı, kullanılan kimlik doğrulama yöntemini ve dosya yolunu, API anahtarları maskelenmiş olarak yazdırır.

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

Varsayılan çalışma alanını kimlik yerine slug ile ayarlamak için polylane workspace use <slug> çalıştır. OAuth kimlik bilgileri ayrı olarak ~/.polylane/credentials.json içinde yaşar ve erişim tokenının süresi yaklaştığında kendiliğinden yenilenir.

Ortam değişkenleri

DeğişkenAçıklama
POLYLANE_API_KEYDiske anahtar saklamadan kimlik doğrula
POLYLANE_WORKSPACE_IDGeçerli kabuk için çalışma alanını ayarla
POLYLANE_API_DOMAINFarklı bir API ana bilgisayar adına yönlendir; yalnızca ana bilgisayar adı, protokol yok
POLYLANE_OUTPUTtext veya json çıktısını zorla
POLYLANE_TIMEOUTSaniye olarak istek zaman aşımı
POLYLANE_VERBOSEAyrıntılı günlüklemeyi etkinleştir
POLYLANE_TELEMETRY=0Bu ortam için telemetriyi devre dışı bırak
DO_NOT_TRACK=1Evrensel telemetri devre dışı bırakma; yapılandırma dosyası dahil diğer her telemetri ayarını geçersiz kılar
NO_COLORANSI renklerini devre dışı bırak

Telemetri

Anonim kullanım telemetrisi varsayılan olarak açıktır. Komut adını, bayrak adlarını, konumsal argüman sayısını, çıkış kodunu ve hata kategorisini, süreleri, CLI ve Node sürümlerini, işletim sistemi ayrıntılarını, kurulum başına anonim bir tanımlayıcıyı ve çalışma alanı kimliğini kaydeder. Bayrak değerleri, argümanlar, dosya yolları, komut çıktısı ve tam hata mesajları dışında kalır ve polylane telemetry status tam olarak neyin nereye gönderildiğini gösterir.

Kalıcı olarak kapatmak için yapılandırma dosyasına yazan polylane telemetry disable komutunu, ortam başına kapatmak için POLYLANE_TELEMETRY=0 veya DO_NOT_TRACK=1 kullan. Karar DO_NOT_TRACK, sonra POLYLANE_TELEMETRY, sonra yapılandırma dosyası, sonra açık varsayılanını izler; çağrı başına bayrak yoktur.

Diskteki dosyalar

CLI'nin sakladığı her şey ~/.polylane altında yaşar:

DosyaAçıklama
config.jsonKayıtlı ayarlar: alan adı, çalışma alanı, API anahtarı, çıktı, zaman aşımı, telemetri
credentials.jsonOAuth tokenları
telemetry.jsonAnonim kurulum kimliği ve çalıştırma sayaçları
update-state.jsonGüncelleme kontrolü durumu

CLI'yi tamamen sıfırlamak için dizini sil; sonraki çalıştırmada yeni bir kurulum kimliği üretilir.

İlgili

  • Kimlik doğrulama: oturum açma yöntemleri ve kimlik bilgilerinin nasıl seçildiği.
  • Betikleme: çıktı sözleşmesi, betik bayrakları ve çıkış kodları.