CLI

Konfigurasjon

Hvor CLI-en leser innstillinger fra, hvilke miljøvariabler den respekterer, og hvordan du styrer telemetri.

CLI-en leser hver innstilling fra flagg, miljøvariabler, konfigurasjonsfilen sin og innebygde standardverdier, og lagrer alt under ~/.polylane. Denne siden lister rekkefølgen, variablene og hvordan du styrer telemetri.

Prioritet

CLI-en løser hver innstilling i denne rekkefølgen, høyeste vinner:

  1. CLI-flagg, for eksempel --workspace, --api-key, --output og --timeout.
  2. Miljøvariabler: POLYLANE_*-settet pluss standardvariablene NO_COLOR og DO_NOT_TRACK.
  3. Bare for legitimasjonen: OAuth-tokener i ~/.polylane/credentials.json.
  4. Konfigurasjonsfilen i ~/.polylane/config.json.
  5. Innebygde standardverdier: domene api.polylane.com, tidsavbrudd 300 sekunder, utdata text i en terminal og json når den pipes.

En eksportert POLYLANE_API_KEY slår alltid en utdatert ~/.polylane/credentials.json, så en CI-runner med variabelen satt plukker ikke opp gjenglemte OAuth-tokener. Autentisering lister den samme rekkefølgen for legitimasjon.

Konfigurasjonsfil

~/.polylane/config.json aksepterer seks nøkler: domain, workspace_id, api_key, output, timeout og telemetry. Administrer den gjennom CLI-en: config show skriver ut den løste konfigurasjonen, autentiseringsmetoden i bruk og filstien, med API-nøkler maskert.

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

For å sette standard-workspacet etter slug i stedet for ID kjører du polylane workspace use <slug>. OAuth-legitimasjon ligger separat i ~/.polylane/credentials.json og fornyes av seg selv når tilgangstokenet nærmer seg utløp.

Miljøvariabler

VariabelBeskrivelse
POLYLANE_API_KEYAutentiser uten å lagre en nøkkel på disk
POLYLANE_WORKSPACE_IDSett workspacet for det gjeldende shellet
POLYLANE_API_DOMAINPek på et annet API-vertsnavn; bare vertsnavn, ingen protokoll
POLYLANE_OUTPUTTving frem text- eller json-utdata
POLYLANE_TIMEOUTTidsavbrudd for forespørsler i sekunder
POLYLANE_VERBOSEAktiver detaljert logging
POLYLANE_TELEMETRY=0Deaktiver telemetri for dette miljøet
DO_NOT_TRACK=1Det universelle telemetrifravalget; overstyrer hver annen telemetriinnstilling, inkludert konfigurasjonsfilen
NO_COLORDeaktiver ANSI-farger

Telemetri

Anonym brukstelemetri er på som standard. Den registrerer kommandonavnet, flaggnavn, antall posisjonsargumenter, avslutningskoden og feilkategorien, varigheter, CLI- og Node-versjoner, detaljer om operativsystemet, en anonym identifikator per installasjon og workspace-ID-en. Flaggverdier, argumenter, filstier, kommandoutdata og fullstendige feilmeldinger holdes utenfor, og polylane telemetry status viser nøyaktig hva som sendes, og hvor.

Slå den av for godt med polylane telemetry disable, som skriver til konfigurasjonsfilen, eller per miljø med POLYLANE_TELEMETRY=0 eller DO_NOT_TRACK=1. Beslutningen følger DO_NOT_TRACK, så POLYLANE_TELEMETRY, så konfigurasjonsfilen, så standardvalget på; det finnes ikke noe flagg per kjøring.

Filer på disk

Alt CLI-en lagrer, ligger under ~/.polylane:

FilBeskrivelse
config.jsonLagrede innstillinger: domene, workspace, API-nøkkel, utdata, tidsavbrudd, telemetri
credentials.jsonOAuth-tokener
telemetry.jsonAnonym installasjons-ID og kjøretellere
update-state.jsonTilstand for oppdateringssjekk

Slett katalogen for å tilbakestille CLI-en fullstendig; en ny installasjons-ID genereres ved neste kjøring.

Relatert

  • Autentisering: innloggingsmetodene og hvordan legitimasjon velges.
  • Skripting: utdatakontrakten, skriptflagg og avslutningskoder.