Betikleme
CLI, kabuk betikleri, CI işleri ve kodlama ajanları tarafından yönetilmek için tasarlandı. Veri stdout'a, diğer her şey stderr'e gider; çıkış kodları kararlıdır ve her istem kapatılabilir.
Çıktı
Çıktı stdout bir terminalken metin, borulandığında veya yönlendirildiğinde JSON'dur; bir biçimi --output json veya --output text ile, POLYLANE_OUTPUT değişkeniyle ya da yapılandırma dosyasıyla, bu öncelik sırasıyla zorla. stdout yalnızca veri taşır, JSON, tablo satırları veya akan tokenlar olsun; bu yüzden borulamak güvenlidir. stderr döndürücüleri, ilerlemeyi, ipuçlarını ve hataları taşır; JSON modunda bir hata code, message ve hint alanlı bir nesne olarak gelir ve code çıkış koduyla eşleşir.
Betikler için bayraklar
| Bayrak | Açıklama |
|---|---|
--output json | Terminal durumundan bağımsız olarak JSON'u zorla |
--quiet | Döndürücüleri ve ilerlemeyi bastır; stdout saf veri kalır |
--non-interactive | İstem göstermek yerine eksik girdide hızlı başarısız ol |
--yes | Yıkıcı komutlarda onayı atla |
--dry-run | Değişiklik yapmadan ne olacağını göster |
--full | Liste komutlarında dar alan projeksiyonu yerine tam nesneleri döndür |
--api-key <key> | Saklanan API anahtarını tek çağrı için geçersiz kıl |
--workspace <id> | Varsayılan çalışma alanını tek çağrı için geçersiz kıl |
--non-interactive ile polylane cloud disconnect, --yes de geçmediğin sürece çalışmayı reddeder; polylane memory delete gibi diğer onaylar ise atlanır, bu yüzden niyeti açık kılmak için --yes bayrağını açıkça geç. POLYLANE_API_KEY ve POLYLANE_WORKSPACE_ID kimlik bilgisini ve çalışma alanını ortamdan ayarlar, bu CI'ya uygundur; bkz. Kimlik doğrulama.
Çıkış kodları
| Kod | Açıklama |
|---|---|
| 0 | Başarı |
| 1 | Genel hata |
| 2 | Kullanım hatası: hatalı bayrak, eksik argüman |
| 3 | Kimlik doğrulama hatası |
| 4 | Hız sınırı ya da plan yükseltmesi gerekli |
| 5 | Zaman aşımı |
| 6 | Ağ hatası |
| 130 | Ctrl-C ile kesildi |
Yeniden denemeye, yeniden kimlik doğrulamaya ya da hatayı yukarı taşımaya karar vermek için önce çıkış koduna göre dallan, sonra ayrıntı için stderr'deki hata nesnesini ayrıştır.
Örnek
polylane issue list --active --severity critical --output json --quiet \
| jq -r '.items[] | "\(.id)\t\(.title)"'
polylane issue list, items ve count alanlı bir nesne döndürür ve her öğe id, severity, status, title, resourceKind, resourceId, detectedAt ve investigationThreadId alanlarına projeksiyonlanır; --full tam nesneleri döndürür. Sorunlar her durumun arkasındaki yaşam döngüsünü açıklar.
İlgili
- Kimlik doğrulama: CI için API anahtarları ve ortam değişkenleri.
- Yapılandırma: çıktı ve zaman aşımı ayarları ve yapılandırma dosyası.
- Sorunlar:
issuekomutlarının döndürdüğü durumlar ve önem dereceleri. - Threads:
thread askneyi başlatır ve bir thread nasıl ilerler.