CLI

Scripting

Guida la CLI da script shell, CI e agenti di coding con output JSON, codici di uscita stabili e nessun prompt.

La CLI è fatta per essere guidata da script shell, job CI e agenti di coding. I dati vanno su stdout, tutto il resto va su stderr, i codici di uscita sono stabili e ogni prompt può essere disattivato.

Output

L'output è testo quando stdout è un terminale e JSON quando è in pipe o rediretto; forza un formato con --output json o --output text, la variabile POLYLANE_OUTPUT o il file di configurazione, in quest'ordine di precedenza. stdout porta solo dati, siano JSON, righe di tabella o token in streaming, quindi è sicuro metterlo in pipe. stderr porta spinner, avanzamento, suggerimenti ed errori, e in modalità JSON un errore arriva come oggetto con code, message e hint, dove code corrisponde al codice di uscita.

Flag per gli script

FlagDescrizione
--output jsonForza il JSON indipendentemente dallo stato del terminale
--quietSopprime spinner e avanzamento; stdout resta solo dati
--non-interactiveFallisce subito su input mancante invece di chiedere
--yesSalta la conferma sui comandi distruttivi
--dry-runMostra cosa succederebbe senza fare modifiche
--fullRestituisce oggetti completi sui comandi di elenco invece della proiezione ristretta dei campi
--api-key <key>Sovrascrive la chiave API salvata per una chiamata
--workspace <id>Sovrascrive il workspace predefinito per una chiamata

Con --non-interactive, polylane cloud disconnect rifiuta di eseguirsi a meno che tu non passi anche --yes, mentre le altre conferme, come polylane memory delete, vengono saltate, quindi passa --yes esplicitamente per rendere chiara l'intenzione. POLYLANE_API_KEY e POLYLANE_WORKSPACE_ID impostano la credenziale e il workspace dall'ambiente, il che si adatta alla CI; vedi Autenticazione.

Codici di uscita

CodiceDescrizione
0Successo
1Errore generico
2Errore d'uso: flag errato, argomento mancante
3Errore di autenticazione
4Rate limit o upgrade del piano richiesto
5Timeout
6Errore di rete
130Interrotto con Ctrl-C

Ramifica prima sul codice di uscita per decidere se riprovare, riautenticarti o far emergere il fallimento, poi analizza l'oggetto di errore su stderr per i dettagli.

Esempio

Terminal
polylane issue list --active --severity critical --output json --quiet \
  | jq -r '.items[] | "\(.id)\t\(.title)"'

polylane issue list restituisce un oggetto con items e count, e ogni elemento è proiettato su id, severity, status, title, resourceKind, resourceId, detectedAt e investigationThreadId; --full restituisce gli oggetti completi. Issue spiega il ciclo di vita dietro ogni stato.

Correlati

  • Autenticazione: chiavi API e variabili d'ambiente per la CI.
  • Configurazione: impostazioni di output e timeout e il file di configurazione.
  • Issue: gli stati e le gravità che i comandi issue restituiscono.
  • Threads: cosa avvia thread ask e come procede un thread.