CLI

Konfiguration

Woher die CLI Einstellungen liest, welche Umgebungsvariablen sie beachtet und wie du Telemetrie steuerst.

Die CLI liest jede Einstellung aus Flags, Umgebungsvariablen, ihrer Konfigurationsdatei und eingebauten Standardwerten und speichert alles unter ~/.polylane. Diese Seite listet die Reihenfolge, die Variablen und wie du Telemetrie steuerst.

Vorrang

Die CLI löst jede Einstellung in dieser Reihenfolge auf, die höchste gewinnt:

  1. CLI-Flags, zum Beispiel --workspace, --api-key, --output und --timeout.
  2. Umgebungsvariablen: der Satz POLYLANE_* plus die Standards NO_COLOR und DO_NOT_TRACK.
  3. Nur für die Zugangsdaten: OAuth-Tokens in ~/.polylane/credentials.json.
  4. Die Konfigurationsdatei unter ~/.polylane/config.json.
  5. Eingebaute Standardwerte: Domain api.polylane.com, Timeout 300 Sekunden, Ausgabe text im Terminal und json beim Pipen.

Ein exportiertes POLYLANE_API_KEY schlägt immer eine veraltete ~/.polylane/credentials.json, sodass ein CI-Runner mit gesetzter Variable keine übrig gebliebenen OAuth-Tokens aufgreift. Authentifizierung listet dieselbe Reihenfolge für Zugangsdaten auf.

Konfigurationsdatei

~/.polylane/config.json akzeptiert sechs Schlüssel: domain, workspace_id, api_key, output, timeout und telemetry. Verwalte sie über die CLI: config show gibt die aufgelöste Konfiguration, die genutzte Auth-Methode und den Dateipfad aus, mit maskierten API-Schlüsseln.

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

Um den Standard-Workspace per Slug statt per ID zu setzen, führe polylane workspace use <slug> aus. OAuth-Zugangsdaten liegen separat in ~/.polylane/credentials.json und erneuern sich von selbst, wenn der Access Token bald abläuft.

Umgebungsvariablen

VariableBeschreibung
POLYLANE_API_KEYAuthentifizieren, ohne einen Schlüssel auf der Festplatte zu speichern
POLYLANE_WORKSPACE_IDDen Workspace für die aktuelle Shell setzen
POLYLANE_API_DOMAINAuf einen anderen API-Hostnamen zeigen; nur Hostname, kein Protokoll
POLYLANE_OUTPUTAusgabe text oder json erzwingen
POLYLANE_TIMEOUTAnfrage-Timeout in Sekunden
POLYLANE_VERBOSEAusführliches Logging aktivieren
POLYLANE_TELEMETRY=0Telemetrie für diese Umgebung deaktivieren
DO_NOT_TRACK=1Das universelle Telemetrie-Opt-out; überschreibt jede andere Telemetrie-Einstellung, einschließlich der Konfigurationsdatei
NO_COLORANSI-Farben deaktivieren

Telemetrie

Anonyme Nutzungstelemetrie ist standardmäßig an. Sie erfasst den Befehlsnamen, Flag-Namen, die Zahl der Positionsargumente, den Exit-Code und die Fehlerkategorie, Dauern, CLI- und Node-Versionen, Details zum Betriebssystem, eine anonyme Kennung pro Installation und die Workspace-ID. Flag-Werte, Argumente, Dateipfade, Befehlsausgabe und vollständige Fehlermeldungen bleiben außen vor, und polylane telemetry status zeigt genau, was wohin gesendet wird.

Schalte sie dauerhaft mit polylane telemetry disable aus, das in die Konfigurationsdatei schreibt, oder pro Umgebung mit POLYLANE_TELEMETRY=0 oder DO_NOT_TRACK=1. Die Entscheidung folgt DO_NOT_TRACK, dann POLYLANE_TELEMETRY, dann der Konfigurationsdatei, dann dem Standard an; ein Flag pro Aufruf gibt es nicht.

Dateien auf der Festplatte

Alles, was die CLI speichert, liegt unter ~/.polylane:

DateiBeschreibung
config.jsonGespeicherte Einstellungen: Domain, Workspace, API-Schlüssel, Ausgabe, Timeout, Telemetrie
credentials.jsonOAuth-Tokens
telemetry.jsonAnonyme Installations-ID und Laufzähler
update-state.jsonZustand der Update-Prüfung

Lösche das Verzeichnis, um die CLI vollständig zurückzusetzen; beim nächsten Lauf wird eine neue Installations-ID erzeugt.

Verwandt

  • Authentifizierung: die Anmeldemethoden und wie Zugangsdaten gewählt werden.
  • Scripting: der Ausgabevertrag, Skript-Flags und Exit-Codes.