> ## Documentation Index
> Fetch the complete documentation index at: https://docs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# コマンド

> CLI のコマンド リファレンスです。グローバル オプション、出力形式、および各コマンドのページが含まれます。

このページは、XBOX CLI のコマンド リファレンスです。`xbox` 自体について、すべてのコマンドで共通の
グローバル オプション、出力形式、終了コードを説明します。以下の各コマンドには
それぞれ専用のページがあり、各 `playfab` サービスには `commands/playfab/` の下にページがあります。
ターミナルで同じリファレンスを表示するには、`xbox <command> --help` を実行します。

ヘルプでは、CLI の契約が変更または削除される可能性のある試験段階 (Experimental) のコマンドにラベルが付けられます。
[試験段階のコマンド](https://docs.xbox.com/ja-jp/tools/xbox-cli/cli-command-lifecycle.md)を参照してください。

## コア コマンド

| コマンド | 説明 |
| - | - |
| [`auth`](https://docs.xbox.com/ja-jp/tools/xbox-cli/commands/auth) | Microsoft Entra ID で認証します。 |
| [`context`](https://docs.xbox.com/ja-jp/tools/xbox-cli/commands/context) | 販売者や PlayFab タイトルなどの既定値を、以降のコマンド用に保存します。 |
| [`game`](https://docs.xbox.com/ja-jp/tools/xbox-cli/commands/game) | パートナー センターのゲームを一覧表示、取得、作成します。 |
| [`seller`](https://docs.xbox.com/ja-jp/tools/xbox-cli/commands/seller) | サインインしている開発者が使用できるパートナー センターの販売者を一覧表示します。 |
| [`sandbox`](https://docs.xbox.com/ja-jp/tools/xbox-cli/commands/sandbox) | XBOX サンドボックスを一覧表示、取得、作成します。 |
| [`audience`](https://docs.xbox.com/ja-jp/tools/xbox-cli/commands/audience) | 販売者の対象ユーザーを一覧表示、取得、作成、更新します (試験段階)。 |
| [`package`](https://docs.xbox.com/ja-jp/tools/xbox-cli/commands/package) | ゲーム パッケージを一覧表示および取得します (試験段階)。 |
| [`playtest`](https://docs.xbox.com/ja-jp/tools/xbox-cli/commands/playtest) | ゲームのプレイテストを一覧表示、取得、比較、作成、更新、公開、削除します。 |
| [`pc`](https://docs.xbox.com/ja-jp/tools/xbox-cli/commands/pc) | この Windows PC が使用する XBOX サンドボックスを取得または切り替えます (試験段階)。 |
| [`test-account`](https://docs.xbox.com/ja-jp/tools/xbox-cli/commands/test-account) | XBOX テスト アカウントのバッチを作成、更新、削除し、その作成ジョブを追跡し、バッチを読み取り、アカウントのバッチとそのアクセス権の有効期限が切れているかどうかを調べます。 |
| [`playfab`](https://docs.xbox.com/ja-jp/tools/xbox-cli/commands/playfab) | PlayFab サービスを調査および管理します。 |
| [`xbl`](https://docs.xbox.com/ja-jp/tools/xbox-cli/commands/xbl) | XBOX サービス構成を管理します (試験段階)。 |

## サポート コマンド

| コマンド | 説明 |
| - | - |
| [`info`](https://docs.xbox.com/ja-jp/tools/xbox-cli/commands/info) | バージョンと、使用を開始するためのリンクを表示します。 |
| [`upgrade`](https://docs.xbox.com/ja-jp/tools/xbox-cli/commands/upgrade) | 新しい CLI リリースを確認し、手動更新の手順を表示します。 |
| [`feedback`](https://docs.xbox.com/ja-jp/tools/xbox-cli/commands/feedback) | CLI の環境情報を含むバグ レポートの下書きを開きます。 |
| [`help`](https://docs.xbox.com/ja-jp/tools/xbox-cli/commands/help) | 任意のコマンドのヘルプを表示します。 |

## グローバル オプション

すべてのコマンドは、これらのオプションを受け付けます。表に示すように、一部のオプションは特定のコマンドにのみ影響します。
それ以外のコマンドでは、受け付けられますが無視されます。

| オプション | 適用対象 | 説明 |
| - | - | - |
| `--playfab-title-id <id>` | `playfab` コマンド | 対象とする PlayFab タイトル。`XBOX_PLAYFAB_TITLE_ID` と保存されたタイトルより優先され、どちらも変更しません。[コンテキスト](https://docs.xbox.com/ja-jp/tools/xbox-cli/commands/context.md)を参照してください。 |
| `--profile <name>` | 保存された値を使用するコマンド | このプロファイルに保存された値を使用します。既定値は `XBOX_PROFILE`、次に `default` です。[プロファイル](https://docs.xbox.com/ja-jp/tools/xbox-cli/commands/context.md#profiles)を参照してください。 |
| `--client-id <id>` | ユーザー サインイン | `AzureAd:ClientId` をオーバーライドします。サービス プリンシパルとしてサインインする場合は拒否されます。 |
| `--tenant-id <id>` | ユーザー サインイン | `AzureAd:TenantId` をオーバーライドします。サービス プリンシパルとしてサインインする場合は拒否されます。 |
| `--scopes <scopes>` | サインイン | `AzureAd:Scopes` をオーバーライドします。 |
| `--output <format>`, `-o` | データ コマンド | `json` (既定)、`json-compact`、またはサポートするコマンドでは `table`。[出力形式](#output-formats)を参照してください。 |
| `--data-only` | `playfab` コマンド | PlayFab レスポンスの `data` フィールドのみを書き込みます。[レスポンス エンベロープ](https://docs.xbox.com/ja-jp/tools/xbox-cli/commands/playfab.md#response-envelope)を参照してください。 |
| `--confirm`, `--yes`, `-y` | `playfab` コマンド、およびページにこのオプションが記載されているコマンド | 最初に確認を求めるコマンドの確認プロンプトをスキップします。[安全性](https://docs.xbox.com/ja-jp/tools/xbox-cli/safety.md)を参照してください。 |
| `--verbose` | すべてのコマンド | コマンドが使用した各[保存された値](https://docs.xbox.com/ja-jp/tools/xbox-cli/commands/context.md#how-commands-use-saved-values)の取得元など、診断の詳細を stderr に書き込みます。 |
| `--disable-telemetry` | すべてのコマンド | この実行について、匿名の製品使用状況テレメトリを無効にします。[テレメトリ](https://docs.xbox.com/ja-jp/tools/xbox-cli/telemetry.md)を参照してください。 |

オプションは、設定と環境変数をオーバーライドします。[構成](https://docs.xbox.com/ja-jp/tools/xbox-cli/configuration.md)を参照してください。

## 出力形式

データ コマンドは、結果を stdout に、エラーと診断情報を stderr に書き込みます。

| 形式 | 出力 |
| - | - |
| `json` | 整形された JSON。既定値です。 |
| `json-compact` | `jq` やスクリプトにパイプするための 1 行の JSON。 |
| `table` | プレーン テキストのテーブル。ページにこの形式を受け付けると記載されているコマンドで使用できます。 |

PlayFab コマンドは、各結果をレスポンス エンベロープでラップします。これは `--data-only` で削除されます。
[レスポンス エンベロープ](https://docs.xbox.com/ja-jp/tools/xbox-cli/commands/playfab.md#response-envelope)を参照してください。`--data-only` は、
他のコマンドや `--output table` と併用した場合は効果がありません。

一部のコマンドは JSON ではなく人向けのテキストを書き込み、そのことがページに記載されています。`auth status`
は、`--output json` または `--output json-compact` を渡さない限りテキストを書き込みます。
[Auth](https://docs.xbox.com/ja-jp/tools/xbox-cli/commands/auth.md#auth-status) を参照してください。`playfab file upload` などのファイル操作は、
stdout に何も書き込まず、実行した内容を stderr に報告します。[ファイル](https://docs.xbox.com/ja-jp/tools/xbox-cli/commands/playfab/file.md#output)を参照してください。

### テーブル出力

テーブルは、ターミナルで読むためのものです。列はどのリリースでも変更される可能性があるため、スクリプト
やエージェントでは `--output json-compact` を使用してください。テーブル表示のないコマンドは
`table` を拒否します。

```console theme={null}
$ xbox playfab api /Admin/GetTitleData --output table
Output format 'table' is not available for this command, because it does not declare a
table view. Omit --output to get this command's default output.
```

### 進行状況

`game list` のように多数のページを読み取るコマンドや、`xbl config publish` のようにリクエストの完了を待機するコマンドは、
stderr の 1 行に進行状況を表示します:
`Reading games... 1646 found, 25 pages, 84s`。この行は stderr がターミナルの場合にのみ表示され、
結果の前に消去されます。

## 終了コード

これらの終了コードは、すべてのコマンドで共通です。何かを変更するコマンドは、変更の結果が不明な場合の `3` など、
独自の終了コードを追加できます。それらはそのコマンドのページに記載されています。

| 終了コード | 意味 |
| - | - |
| `0` | コマンドが成功しました。 |
| `1` | コマンドが失敗しました。エラーは stderr に出力されます。 |
| `130` | コマンドの読み取り中または待機中に Ctrl+C が押されました。 |

失敗した PlayFab の呼び出しは、エラー JSON を `--output` の形式で stderr に書き込みます。
[PlayFab のエラー レスポンス](https://docs.xbox.com/ja-jp/tools/xbox-cli/playfab-api.md#error-responses)を参照してください。不明なコマンドは、エラー
と使用法を stderr に書き込みます。[ヘルプ](https://docs.xbox.com/ja-jp/tools/xbox-cli/commands/help.md)を参照してください。

コマンドが変更を送信した後に Ctrl+C を押すと、変更が行われた可能性があるかどうかが stderr に表示されます。
コマンドは、そのページに記載されたコード (PlayFab コマンドの場合は `1`) で終了します。再度実行する前に
確認してください。
[中断された書き込みは結果が不明であることを報告する](https://docs.xbox.com/ja-jp/tools/xbox-cli/safety.md#an-interrupted-write-reports-that-its-outcome-is-unknown)を参照してください。

## 安全性

多くのコマンドは運用環境のタイトル、販売者、ゲームを変更します。読み取り専用なのは、名前が `Get`、`List`、
`Search` で始まる PlayFab 操作だけです。何かを変更するコマンドを実行する前に、
[安全性と破壊的な操作](https://docs.xbox.com/ja-jp/tools/xbox-cli/safety.md)をお読みください。


## Related topics

- [コマンド ライン ツールの概要 (tak.exe)](https://docs.xbox.com/ja-jp/build/core-features/common/game-streaming/tak-command-line-tool/game-streaming-tak-command-line.md)
- [サンドボックス](https://docs.xbox.com/ja-jp/tools/xbox-cli/commands/sandbox.md)
- [PC](https://docs.xbox.com/ja-jp/tools/xbox-cli/commands/pc.md)
- [Serve コマンド](https://docs.xbox.com/ja-jp/build/core-features/common/game-streaming/tak-command-line-tool/game-streaming-tak-command-line-serve-command.md)
- [Pack コマンド](https://docs.xbox.com/ja-jp/build/core-features/common/game-streaming/tak-command-line-tool/game-streaming-tak-command-line-pack-command.md)
