xbox 自体について、すべてのコマンドで共通の
グローバル オプション、出力形式、終了コードを説明します。以下の各コマンドには
それぞれ専用のページがあり、各 playfab サービスには commands/playfab/ の下にページがあります。
ターミナルで同じリファレンスを表示するには、xbox <command> --help を実行します。
ヘルプでは、CLI の契約が変更または削除される可能性のある試験段階 (Experimental) のコマンドにラベルが付けられます。
試験段階のコマンドを参照してください。
コア コマンド
サポート コマンド
グローバル オプション
すべてのコマンドは、これらのオプションを受け付けます。表に示すように、一部のオプションは特定のコマンドにのみ影響します。 それ以外のコマンドでは、受け付けられますが無視されます。
オプションは、設定と環境変数をオーバーライドします。構成を参照してください。
出力形式
データ コマンドは、結果を stdout に、エラーと診断情報を stderr に書き込みます。
PlayFab コマンドは、各結果をレスポンス エンベロープでラップします。これは
--data-only で削除されます。
レスポンス エンベロープを参照してください。--data-only は、
他のコマンドや --output table と併用した場合は効果がありません。
一部のコマンドは JSON ではなく人向けのテキストを書き込み、そのことがページに記載されています。auth status
は、--output json または --output json-compact を渡さない限りテキストを書き込みます。
Auth を参照してください。playfab file upload などのファイル操作は、
stdout に何も書き込まず、実行した内容を stderr に報告します。ファイルを参照してください。
テーブル出力
テーブルは、ターミナルで読むためのものです。列はどのリリースでも変更される可能性があるため、スクリプト やエージェントでは--output json-compact を使用してください。テーブル表示のないコマンドは
table を拒否します。
進行状況
game list のように多数のページを読み取るコマンドや、xbl config publish のようにリクエストの完了を待機するコマンドは、
stderr の 1 行に進行状況を表示します:
Reading games... 1646 found, 25 pages, 84s。この行は stderr がターミナルの場合にのみ表示され、
結果の前に消去されます。
終了コード
これらの終了コードは、すべてのコマンドで共通です。何かを変更するコマンドは、変更の結果が不明な場合の3 など、
独自の終了コードを追加できます。それらはそのコマンドのページに記載されています。
失敗した PlayFab の呼び出しは、エラー JSON を
--output の形式で stderr に書き込みます。
PlayFab のエラー レスポンスを参照してください。不明なコマンドは、エラー
と使用法を stderr に書き込みます。ヘルプを参照してください。
コマンドが変更を送信した後に Ctrl+C を押すと、変更が行われた可能性があるかどうかが stderr に表示されます。
コマンドは、そのページに記載されたコード (PlayFab コマンドの場合は 1) で終了します。再度実行する前に
確認してください。
中断された書き込みは結果が不明であることを報告するを参照してください。
安全性
多くのコマンドは運用環境のタイトル、販売者、ゲームを変更します。読み取り専用なのは、名前がGet、List、
Search で始まる PlayFab 操作だけです。何かを変更するコマンドを実行する前に、
安全性と破壊的な操作をお読みください。