Skip to main content
Installez la CLI, puis connectez-vous pour la relier à votre compte AppSignal.

​
Installation

La CLI fonctionne sur macOS et Linux, sur les machines Intel (x86_64) et Apple Silicon / ARM (arm64). Les distributions Linux basées sur musl, comme Alpine, sont également prises en charge.
Installez la formule. Homebrew tape appsignal/appsignal-cli automatiquement :
Pour mettre à jour ultérieurement, exécutez :
Vous préférez ne pas transmettre un script à votre shell ? Téléchargez directement le binaire pour votre plateforme depuis la dernière version.

​
Vérifier l’installation

Vérifiez que la CLI est dans votre PATH :
Shell
Puis exécutez appsignal-cli about pour un aperçu de votre configuration, y compris sa version, son point de terminaison, son organisation par défaut et son statut d’authentification :
Shell
Avant que vous ne vous authentifiiez, il affichera Auth: Not authenticated et vous orientera vers les commandes à exécuter ensuite.

​
Authentification

Avant que la CLI puisse accéder à vos données, vous devez vous connecter. Elle utilise OAuth, une connexion basée sur le navigateur, vous n’avez donc jamais à copier ou stocker un jeton à la main. Vous pouvez vérifier si vous êtes connecté à tout moment avec appsignal-cli auth status. Exécutez :
Shell
Cela ouvre votre navigateur pour autoriser la CLI avec votre compte AppSignal, puis redonne le contrôle via un rappel local sur http://127.0.0.1:9789/callback. Une fois que vous approuvez, la CLI stocke les jetons et les rafraîchit pour vous, vous n’aurez donc plus à vous reconnecter.
Le flux navigateur nécessite un navigateur sur la même machine que la CLI.

​
Définir une organisation par défaut

Si vous appartenez à plus d’une organisation, définissez une valeur par défaut lors de votre connexion afin de ne pas avoir à la passer pour chaque commande :
Shell
Le slug de votre organisation est le nom court dans votre URL AppSignal : appsignal.com/<org-slug>. L’exécution de appsignal-cli apps list après votre connexion sauvegarde également l’organisation de votre compte comme valeur par défaut.

​
Vérifier votre statut

Pour voir si vous êtes connecté et quelle configuration la CLI lit, exécutez :
Shell
appsignal-cli about affiche le même statut d’authentification ainsi que votre version, votre endpoint et votre organisation par défaut.

​
Se déconnecter

Pour supprimer vos identifiants stockés :
Shell

​
Où sont stockés vos identifiants

La CLI stocke vos identifiants dans un fichier de configuration global, dans le répertoire de configuration standard de votre système d’exploitation. L’emplacement exact varie selon le système d’exploitation, alors exécutez appsignal-cli auth status pour voir le chemin utilisé par la CLI.

​
Configuration locale au projet

Vous pouvez également conserver la configuration à côté d’un projet, dans un fichier .appsignal.toml dans le répertoire du projet. Créez-en un avec :
Shell
Une configuration locale au projet est pratique pour épingler un dépôt à une organisation spécifique. Pour définir l’organisation par défaut du projet lors de sa création :
Shell
Lorsqu’un fichier .appsignal.toml local au projet est présent, la CLI utilise le plus proche comme seule configuration pour les commandes exécutées dans ce répertoire ou ses sous-répertoires. Pour la liste complète des clés de configuration et leur résolution, voir Configuration.
project init ne copie pas vos identifiants OAuth globaux dans la configuration du projet. Après l’avoir créé, exécutez à nouveau appsignal-cli auth login à l’intérieur du projet pour configurer des identifiants spécifiques au projet.

​
Prochaines étapes

Vous êtes connecté. Ensuite, listez vos applications pour trouver celles que vous allez interroger.