CLI

Configuration

Où la CLI lit ses réglages, quelles variables d'environnement elle respecte et comment contrôler la télémétrie.

La CLI lit chaque réglage depuis les drapeaux, les variables d'environnement, son fichier de configuration et des valeurs par défaut intégrées, et stocke tout sous ~/.polylane. Cette page liste l'ordre, les variables et la façon de contrôler la télémétrie.

Priorité

La CLI résout chaque réglage dans cet ordre, le plus haut l'emporte :

  1. Les drapeaux de la CLI, par exemple --workspace, --api-key, --output et --timeout.
  2. Les variables d'environnement : l'ensemble POLYLANE_* plus les standards NO_COLOR et DO_NOT_TRACK.
  3. Pour l'identifiant seulement, les tokens OAuth dans ~/.polylane/credentials.json.
  4. Le fichier de configuration à ~/.polylane/config.json.
  5. Les valeurs par défaut intégrées : domaine api.polylane.com, délai 300 secondes, sortie text dans un terminal et json en pipe.

Une variable POLYLANE_API_KEY exportée l'emporte toujours sur un ~/.polylane/credentials.json périmé, donc un runner CI avec la variable définie ne récupère pas des tokens OAuth oubliés. Authentification liste le même ordre pour les identifiants.

Fichier de configuration

~/.polylane/config.json accepte six clés : domain, workspace_id, api_key, output, timeout et telemetry. Gère-le via la CLI : config show affiche la configuration résolue, la méthode d'authentification utilisée et le chemin du fichier, avec les clés API masquées.

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

Pour définir l'espace de travail par défaut par slug plutôt que par identifiant, lance polylane workspace use <slug>. Les identifiants OAuth vivent séparément dans ~/.polylane/credentials.json et se rafraîchissent d'eux-mêmes quand le token d'accès approche de l'expiration.

Variables d'environnement

VariableDescription
POLYLANE_API_KEYS'authentifier sans stocker de clé sur disque
POLYLANE_WORKSPACE_IDDéfinir l'espace de travail pour le shell courant
POLYLANE_API_DOMAINPointer vers un autre nom d'hôte d'API ; nom d'hôte seulement, sans protocole
POLYLANE_OUTPUTForcer la sortie text ou json
POLYLANE_TIMEOUTDélai des requêtes en secondes
POLYLANE_VERBOSEActiver la journalisation détaillée
POLYLANE_TELEMETRY=0Désactiver la télémétrie pour cet environnement
DO_NOT_TRACK=1Le refus universel de télémétrie ; l'emporte sur tout autre réglage de télémétrie, fichier de configuration inclus
NO_COLORDésactiver les couleurs ANSI

Télémétrie

La télémétrie d'usage anonyme est activée par défaut. Elle enregistre le nom de la commande, les noms des drapeaux, le nombre d'arguments positionnels, le code de sortie et la catégorie d'erreur, les durées, les versions de la CLI et de Node, les détails du système d'exploitation, un identifiant anonyme par installation et l'identifiant de l'espace de travail. Les valeurs des drapeaux, les arguments, les chemins de fichiers, la sortie des commandes et les messages d'erreur complets en restent exclus, et polylane telemetry status montre exactement ce qui est envoyé et où.

Désactive-la pour de bon avec polylane telemetry disable, qui écrit dans le fichier de configuration, ou par environnement avec POLYLANE_TELEMETRY=0 ou DO_NOT_TRACK=1. La décision suit DO_NOT_TRACK, puis POLYLANE_TELEMETRY, puis le fichier de configuration, puis la valeur par défaut activée ; il n'y a pas de drapeau par invocation.

Fichiers sur disque

Tout ce que la CLI stocke vit sous ~/.polylane :

FichierDescription
config.jsonLes réglages enregistrés : domaine, espace de travail, clé API, sortie, délai, télémétrie
credentials.jsonLes tokens OAuth
telemetry.jsonL'identifiant d'installation anonyme et les compteurs d'exécution
update-state.jsonL'état de la vérification des mises à jour

Supprime le répertoire pour réinitialiser complètement la CLI ; un nouvel identifiant d'installation est généré à la prochaine exécution.

Voir aussi

  • Authentification : les méthodes de connexion et la façon dont les identifiants sont choisis.
  • Scripting : le contrat de sortie, les drapeaux de script et les codes de sortie.