xbox lui-même : les
options globales, les formats de sortie et les codes de sortie communs à toutes les commandes. Chaque commande ci-dessous a sa
propre page, et chaque service playfab a une page sous commands/playfab/. Exécutez
xbox <command> --help pour voir la même référence dans votre terminal.
L’aide étiquette les commandes expérimentales, dont le contrat CLI peut changer ou être retiré.
Consultez Commandes expérimentales.
Commandes principales
Commandes de soutien
Options globales
Toutes les commandes acceptent ces options. Certaines n’ont d’effet que sur certaines commandes, comme l’indique le tableau; ailleurs, elles sont acceptées et ignorées.
Les options remplacent les paramètres et les variables d’environnement; consultez Configuration.
Formats de sortie
Les commandes de données écrivent leur résultat sur stdout, et les erreurs et diagnostics sur stderr.
Les commandes PlayFab encapsulent chaque résultat dans une enveloppe de réponse que
--data-only retire; consultez
Enveloppe de réponse. --data-only n’a aucun effet sur
les autres commandes ni avec --output table.
Quelques commandes écrivent du texte destiné aux personnes au lieu de JSON, et leurs pages l’indiquent. auth status
écrit du texte, sauf si vous passez --output json ou --output json-compact; consultez
Auth. Les opérations sur les fichiers, comme playfab file upload, n’écrivent
rien sur stdout et signalent ce qu’elles ont fait sur stderr; consultez Fichiers.
Sortie sous forme de tableau
Les tableaux sont destinés à être lus dans un terminal. Leurs colonnes peuvent changer dans n’importe quelle version; les scripts et les agents doivent donc utiliser--output json-compact. Une commande sans affichage sous forme de tableau refuse
table :
Progression
Les commandes qui lisent de nombreuses pages, commegame list, ou qui attendent une requête, comme
xbl config publish, affichent leur progression sur une ligne de stderr :
Reading games... 1646 found, 25 pages, 84s. La ligne apparaît uniquement lorsque stderr est un terminal,
et elle est effacée avant le résultat.
Codes de sortie
Ces codes de sortie sont communs à toutes les commandes. Les commandes qui modifient quelque chose peuvent ajouter leurs propres codes, comme3 lorsque le résultat d’une modification est inconnu, et leurs pages les répertorient.
Un appel PlayFab qui échoue écrit le JSON d’erreur sur stderr dans le format
--output; consultez
Réponses d’erreur PlayFab. Une commande inconnue écrit une erreur
et sa syntaxe sur stderr; consultez Aide.
Si vous appuyez sur Ctrl+C après qu’une commande a envoyé une modification, elle indique sur stderr si la modification a pu
être effectuée. Elle se termine avec le code documenté sur sa page, ou 1 pour une commande PlayFab. Vérifiez
avant de l’exécuter de nouveau; consultez
Une écriture interrompue signale que son résultat est inconnu.
Sécurité
De nombreuses commandes modifient des titres, des vendeurs et des jeux de production, et seules les opérations PlayFab dont le nom commence parGet, List ou Search sont en lecture seule. Lisez
Sécurité et opérations destructrices avant d’exécuter des commandes qui modifient quelque chose.