CLI

Konfiguration

Hvor CLI'en læser indstillinger fra, hvilke miljøvariabler den respekterer, og hvordan du styrer telemetri.

CLI'en læser hver indstilling fra flag, miljøvariabler, sin konfigurationsfil og indbyggede standarder og gemmer alt under ~/.polylane. Denne side lister rækkefølgen, variablerne, og hvordan du styrer telemetri.

Rækkefølge

CLI'en vælger hver indstilling i denne rækkefølge, højeste vinder:

  1. CLI-flag, for eksempel --workspace, --api-key, --output og --timeout.
  2. Miljøvariabler: POLYLANE_*-sættet plus de gængse NO_COLOR og DO_NOT_TRACK.
  3. Kun for legitimationen: OAuth-tokens i ~/.polylane/credentials.json.
  4. Konfigurationsfilen på ~/.polylane/config.json.
  5. Indbyggede standarder: domæne api.polylane.com, timeout 300 sekunder, output text i en terminal og json når den pipes.

En eksporteret POLYLANE_API_KEY slår altid en forældet ~/.polylane/credentials.json, så en CI-runner med variablen sat ikke samler efterladte OAuth-tokens op. Autentificering lister den samme rækkefølge for legitimationsoplysninger.

Konfigurationsfil

~/.polylane/config.json accepterer seks nøgler: domain, workspace_id, api_key, output, timeout og telemetry. Administrer den gennem CLI'en: config show udskriver den opløste konfiguration, den autentificeringsmetode der er i brug, og filens sti, med API-nøgler maskeret.

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

For at sætte standardarbejdsområdet ud fra slug i stedet for id kører du polylane workspace use <slug>. OAuth-legitimationsoplysninger ligger separat i ~/.polylane/credentials.json og fornyes af sig selv, når adgangstokenet nærmer sig udløb.

Miljøvariabler

VariabelBeskrivelse
POLYLANE_API_KEYAutentificér uden at gemme en nøgle på disken
POLYLANE_WORKSPACE_IDSæt arbejdsområdet for den aktuelle shell
POLYLANE_API_DOMAINPeg på et andet API-hostnavn; kun hostnavn, ingen protokol
POLYLANE_OUTPUTGennemtving text- eller json-output
POLYLANE_TIMEOUTAnmodningstimeout i sekunder
POLYLANE_VERBOSESlå detaljeret logning til
POLYLANE_TELEMETRY=0Slå telemetri fra for dette miljø
DO_NOT_TRACK=1Det universelle telemetrifravalg; tilsidesætter hver anden telemetriindstilling, inklusive konfigurationsfilen
NO_COLORSlå ANSI-farver fra

Telemetri

Anonym brugstelemetri er slået til som standard. Den registrerer kommandonavnet, flagnavne, antallet af positionelle argumenter, exit coden og fejlkategorien, varigheder, CLI- og Node-versioner, oplysninger om operativsystemet, en anonym identifikator pr. installation og arbejdsområdets id. Flagværdier, argumenter, filstier, kommandooutput og fulde fejlbeskeder holdes ude af den, og polylane telemetry status viser præcis, hvad der sendes og hvorhen.

Slå den fra for altid med polylane telemetry disable, som skriver til konfigurationsfilen, eller pr. miljø med POLYLANE_TELEMETRY=0 eller DO_NOT_TRACK=1. Afgørelsen følger DO_NOT_TRACK, derefter POLYLANE_TELEMETRY, derefter konfigurationsfilen og derefter standarden slået til; der er intet flag pr. kald.

Filer på disken

Alt, hvad CLI'en gemmer, ligger under ~/.polylane:

FilBeskrivelse
config.jsonGemte indstillinger: domæne, arbejdsområde, API-nøgle, output, timeout, telemetri
credentials.jsonOAuth-tokens
telemetry.jsonAnonymt installations-id og kørselstællere
update-state.jsonTilstand for opdateringstjek

Slet mappen for at nulstille CLI'en fuldstændigt; et nyt installations-id genereres ved næste kørsel.

Relateret

  • Autentificering: login-metoderne, og hvordan legitimationsoplysninger vælges.
  • Scripting: outputkontrakten, script-flag og exit codes.