Passer au contenu principal
La CLI lit ses paramètres depuis un fichier de configuration TOML. Il en existe deux types : une configuration globale liée à votre compte, et un fichier .appsignal.toml local au projet qui prend le dessus à l’intérieur d’un projet. Cette page couvre la commande project, l’emplacement de chaque fichier et chaque clé que vous pouvez définir.

​
La commande project

appsignal-cli project init crée ou met à jour un fichier .appsignal.toml local au projet :
Shell
appsignal-cli project init
Si vous l’exécutez à l’intérieur d’un checkout git, la CLI écrit .appsignal.toml à la racine du dépôt. En dehors d’un checkout git, elle utilise le répertoire actuel. Vous pouvez définir l’organisation par défaut du projet lors de la création du fichier :
Shell
appsignal-cli project init --org <YOUR_ORG_SLUG>
project init accepte ces options :
OptionDescription
--org <slug>Définir l’organisation par défaut pour le projet
--endpoint <url>Pointer le projet vers un serveur AppSignal hors production
--rest-endpoint <url>Pointer le projet vers une URL de base de l’API REST ou publique hors production
--oauth-client-id <id>Surcharger l’ID client OAuth pour le projet
project init ne copie pas vos identifiants OAuth globaux dans le fichier du projet. Après l’avoir créé, exécutez appsignal-cli auth login à l’intérieur du projet pour configurer des identifiants spécifiques au projet.
Ne validez pas .appsignal.toml dans le contrôle de version. Une fois que vous vous authentifiez, il contient vos jetons OAuth. Ajoutez-le à votre .gitignore.

​
Où vit la configuration

La configuration globale vit dans le répertoire de configuration standard de votre système d’exploitation ; son chemin exact varie selon le système d’exploitation. Exécutez appsignal-cli auth status pour voir où se trouve le vôtre. Elle contient vos identifiants à l’échelle du compte et votre organisation par défaut. Un fichier .appsignal.toml local au projet peut vivre n’importe où dans un projet. Lorsque la CLI s’exécute à l’intérieur de ce projet ou d’un sous-répertoire, elle utilise le .appsignal.toml le plus proche comme seule configuration pour ce projet. Lorsqu’une configuration locale au projet est active, la CLI lit et écrit uniquement dans ce fichier. Sinon, elle utilise la configuration globale. La valeur org est sauvegardée automatiquement lorsque vous exécutez appsignal-cli apps list ou appsignal-cli apps set-org --org <slug>, dans la configuration active. Exécutez project init d’abord si vous voulez que ces écritures restent locales au projet.

​
Clés de configuration

Les deux fichiers utilisent les mêmes clés :
CléDescription
orgSlug de l’organisation par défaut, utilisé lorsqu’une commande omet --org.
Table [oauth]Identifiants OAuth (access_token, refresh_token, expires_at). Définis automatiquement par appsignal-cli auth login.
Une configuration globale ressemble à ceci :
Global config
org = "<YOUR_ORG_SLUG>"

# Set automatically by `auth login`:
[oauth]
access_token = "..."
refresh_token = "..."
expires_at = 1742324400
Un fichier .appsignal.toml local au projet utilise le même format. Les jetons OAuth sont rafraîchis automatiquement avant les appels API, vous n’avez donc pas à vous reconnecter. OAuth utilise toujours le rappel local intégré sur http://127.0.0.1:9789/callback.

​
Télémétrie

La CLI envoie un événement de télémétrie minimal, fait au mieux, pour chaque exécution de commande, afin d’aider AppSignal à mesurer l’utilisation et la fiabilité de la CLI. Chaque événement inclut uniquement le chemin de la commande, si elle a réussi ou échoué, combien de temps elle a pris, la version de la CLI et le format de sortie. Il ne contient aucune de vos données AppSignal. Pour le désactiver, définissez APPSIGNAL_CLI_TELEMETRY=0 :
Shell
APPSIGNAL_CLI_TELEMETRY=0 appsignal-cli incidents list --app "MyApp" --environment production
Définissez la variable dans votre profil shell pour désactiver la télémétrie pour chaque commande.

​
Endpoints personnalisés

La plupart des utilisateurs n’ont jamais besoin de ces paramètres. Ils font en sorte que la CLI communique avec un serveur AppSignal hors production au lieu du serveur par défaut, ce qui est principalement utile aux ingénieurs d’AppSignal eux-mêmes pour les tests. Vous pouvez les définir comme options sur project init ou auth login, ou comme clés dans votre fichier de configuration. Les clés sont :
Clé de configurationDescription
endpointURL de base du serveur AppSignal, sans /graphql. La CLI ajoute /graphql pour les appels API et utilise l’URL de base pour OAuth.
rest_endpointURL de base de l’API REST ou publique, quand elle diffère de endpoint.
oauth_client_idID client OAuth à utiliser lors de la connexion. Quand non défini, la CLI utilise le client de production, ou en enregistre un automatiquement pour les endpoints qui annoncent un registration_endpoint.
Une valeur comme https://appsignal.example.com/graphql n’est pas prise en charge. Utilisez uniquement l’URL de base.

​
Prochaines étapes

Avec votre configuration en place, listez vos applications et commencez à interroger vos données.