Configurazione
La CLI legge ogni impostazione da flag, variabili d'ambiente, il suo file di configurazione e i valori predefiniti integrati, e archivia tutto sotto ~/.polylane. Questa pagina elenca l'ordine, le variabili e come controllare la telemetria.
Precedenza
La CLI risolve ogni impostazione in quest'ordine, vince la più alta:
- I flag della CLI, ad esempio
--workspace,--api-key,--outpute--timeout. - Le variabili d'ambiente: l'insieme
POLYLANE_*più le standardNO_COLOReDO_NOT_TRACK. - Solo per la credenziale, i token OAuth in
~/.polylane/credentials.json. - Il file di configurazione in
~/.polylane/config.json. - I valori predefiniti integrati: dominio
api.polylane.com, timeout 300 secondi, outputtextin un terminale ejsonquando è in pipe.
Una POLYLANE_API_KEY esportata vince sempre su un ~/.polylane/credentials.json obsoleto, così un runner CI con la variabile impostata non raccoglie token OAuth rimasti in giro. Autenticazione elenca lo stesso ordine per le credenziali.
File di configurazione
~/.polylane/config.json accetta sei chiavi: domain, workspace_id, api_key, output, timeout e telemetry. Gestiscilo tramite la CLI: config show stampa la configurazione risolta, il metodo di autenticazione in uso e il percorso del file, con le chiavi API mascherate.
polylane config show
polylane config set --key output --value json
Per impostare il workspace predefinito tramite slug invece che id, esegui polylane workspace use <slug>. Le credenziali OAuth vivono separatamente in ~/.polylane/credentials.json e si rinnovano da sole quando l'access token si avvicina alla scadenza.
Variabili d'ambiente
| Variabile | Descrizione |
|---|---|
POLYLANE_API_KEY | Autenticati senza salvare una chiave su disco |
POLYLANE_WORKSPACE_ID | Imposta il workspace per la shell corrente |
POLYLANE_API_DOMAIN | Punta a un hostname dell'API diverso; solo hostname, senza protocollo |
POLYLANE_OUTPUT | Forza l'output text o json |
POLYLANE_TIMEOUT | Timeout delle richieste in secondi |
POLYLANE_VERBOSE | Abilita il logging dettagliato |
POLYLANE_TELEMETRY=0 | Disabilita la telemetria per questo ambiente |
DO_NOT_TRACK=1 | L'opt-out universale dalla telemetria; prevale su ogni altra impostazione di telemetria, incluso il file di configurazione |
NO_COLOR | Disabilita i colori ANSI |
Telemetria
La telemetria anonima sull'utilizzo è attiva per impostazione predefinita. Registra il nome del comando, i nomi dei flag, il numero di argomenti posizionali, il codice di uscita e la categoria di errore, le durate, le versioni della CLI e di Node, i dettagli del sistema operativo, un identificatore anonimo per installazione e l'id del workspace. I valori dei flag, gli argomenti, i percorsi dei file, l'output dei comandi e i messaggi di errore completi ne restano fuori, e polylane telemetry status mostra esattamente cosa viene inviato e dove.
Disattivala per sempre con polylane telemetry disable, che scrive nel file di configurazione, oppure per ambiente con POLYLANE_TELEMETRY=0 o DO_NOT_TRACK=1. La decisione segue DO_NOT_TRACK, poi POLYLANE_TELEMETRY, poi il file di configurazione, poi il valore predefinito attivo; non esiste un flag per singola invocazione.
File su disco
Tutto ciò che la CLI archivia vive sotto ~/.polylane:
| File | Descrizione |
|---|---|
config.json | Impostazioni salvate: dominio, workspace, chiave API, output, timeout, telemetria |
credentials.json | Token OAuth |
telemetry.json | Id anonimo dell'installazione e contatori delle esecuzioni |
update-state.json | Stato del controllo degli aggiornamenti |
Elimina la directory per azzerare completamente la CLI; un nuovo id di installazione viene generato alla prossima esecuzione.
Correlati
- Autenticazione: i metodi di accesso e come vengono scelte le credenziali.
- Scripting: il contratto dell'output, i flag per gli script e i codici di uscita.