Passer au contenu principal
La XBOX CLI ne nécessite aucun fichier de configuration. Ses paramètres proviennent de valeurs par défaut intégrées à l’exécutable, que vous pouvez remplacer pour un shell avec des variables d’environnement ou pour une seule commande avec des options.

Sources de configuration et priorité

Les paramètres proviennent de trois sources, et les sources suivantes remplacent les précédentes :
  1. Les valeurs par défaut intégrées, compilées dans l’exécutable. Consultez Paramètres.
  2. Les variables d’environnement. Consultez Variables d’environnement.
  3. Les options de ligne de commande. Consultez Remplacements par les options de la CLI.
Une nouvelle version apporte ses propres valeurs par défaut : il n’y a donc aucun fichier de paramètres à reporter. Le vendeur, le titre PlayFab, le titre XBOX et le sandbox ne sont pas des paramètres ; consultez Contexte pour savoir où une commande les obtient.

Paramètres

  • Les paramètres AzureAd:* configurent la connexion utilisateur ; consultez Authentification.
  • PlayFab:StudioBaseUrl est le point de terminaison PlayFab des API de studio (/Studio/*), comme celles qu’appelle playfab service-principal.
  • XboxPartner:TimeoutSeconds est le délai d’expiration des requêtes, en secondes, pour des commandes telles que game, et doit être un nombre positif.
  • XblPCSandbox:Path est le fichier XblPCSandbox.exe qu’exécutent les commandes pc sandbox. Lorsqu’il n’est pas défini, la CLI le recherche dans son propre répertoire, puis dans PATH.
  • AuditLog:Enabled active le journal d’audit.
  • Les paramètres Telemetry:* sont décrits dans Télémétrie.
Lorsque PlayFab:BaseUrlTemplate, PlayFab:StudioBaseUrl ou XboxPartner:BaseUrl n’a pas sa valeur par défaut intégrée, chaque commande qui envoie un jeton à ce point de terminaison écrit d’abord un avertissement sur stderr.

Variables d’environnement

La variable d’un paramètre est formée de XBOX_ suivi de sa clé, avec __ (deux traits de soulignement) à la place de chaque : : ainsi, Telemetry:Enabled devient XBOX_TELEMETRY__ENABLED. Écrivez les noms en majuscules. Une variable s’applique au shell qui la définit et à toutes les commandes que ce shell lance :
Chaque paramètre de la section Paramètres a une variable. La CLI lit également celles-ci : Les paramètres XBOX_AUTHENTICATION__ sont lus uniquement à partir des variables d’environnement, jamais à partir des valeurs par défaut intégrées ni des options. Consultez Authentification pour l’automatisation (principal de service).

Remplacements par les options de la CLI

Les options remplacent toutes les autres sources, pour une seule commande. Consultez Commandes pour les autres options globales.

Configuration de la télémétrie

Les versions officielles collectent une télémétrie anonyme limitée, sauf si vous la désactivez. Pour la désactiver pour une seule commande :
Pour la désactiver pour un shell :
Consultez Télémétrie pour savoir ce qui est collecté.

Mise à niveau depuis une version qui lisait appsettings.json

Les versions antérieures lisaient appsettings.json à côté de l’exécutable. Si vous y aviez modifié une valeur, définissez plutôt sa variable XBOX_ : par exemple, "AzureAd": { "ClientId": "..." } devient XBOX_AZUREAD__CLIENTID. Vous pouvez voir ces messages tant que vous n’avez pas terminé :
  • --config-env échoue avec cette erreur. Supprimez l’option et définissez plutôt des variables XBOX_.
  • Tant qu’un fichier appsettings*.json se trouve à côté de l’exécutable, les commandes écrivent cette remarque sur stderr. Supprimez le fichier.
  • Les commandes PlayFab échouent avec une erreur qui nomme XBOX_PLAYFAB__REQUESTHEADERS__0__VALUE si un message d’erreur antérieur vous a amené à la définir. Supprimez la variable.
Dernière modification le 19 novembre 2026