> ## 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 约定可能更改或被删除的“实验性”命令。
请参阅[实验性命令](https://docs.xbox.com/zh-CN/tools/xbox-cli/cli-command-lifecycle.md)。

## 核心命令

| 命令 | 说明 |
| - | - |
| [`auth`](https://docs.xbox.com/zh-CN/tools/xbox-cli/commands/auth) | 使用 Microsoft Entra ID 进行身份验证。 |
| [`context`](https://docs.xbox.com/zh-CN/tools/xbox-cli/commands/context) | 保存默认值(例如卖家和 PlayFab 游戏),供后续命令使用。 |
| [`game`](https://docs.xbox.com/zh-CN/tools/xbox-cli/commands/game) | 列出、获取和创建 Partner Center 游戏。 |
| [`seller`](https://docs.xbox.com/zh-CN/tools/xbox-cli/commands/seller) | 列出已登录的开发人员可用的 Partner Center 卖家。 |
| [`sandbox`](https://docs.xbox.com/zh-CN/tools/xbox-cli/commands/sandbox) | 列出、获取和创建 XBOX 沙盒。 |
| [`audience`](https://docs.xbox.com/zh-CN/tools/xbox-cli/commands/audience) | 列出、获取、创建和更新卖家的受众(实验性)。 |
| [`package`](https://docs.xbox.com/zh-CN/tools/xbox-cli/commands/package) | 列出和获取游戏程序包(实验性)。 |
| [`playtest`](https://docs.xbox.com/zh-CN/tools/xbox-cli/commands/playtest) | 列出、获取、比较、创建、更新、发布和删除游戏的游戏测试。 |
| [`pc`](https://docs.xbox.com/zh-CN/tools/xbox-cli/commands/pc) | 获取或切换此 Windows 电脑使用的 XBOX 沙盒(实验性)。 |
| [`test-account`](https://docs.xbox.com/zh-CN/tools/xbox-cli/commands/test-account) | 创建、更新和删除 XBOX 测试帐户批次,跟踪其创建作业,读取批次,以及查找帐户所属的批次及其访问权限是否已过期。 |
| [`playfab`](https://docs.xbox.com/zh-CN/tools/xbox-cli/commands/playfab) | 检查和管理 PlayFab 服务。 |
| [`xbl`](https://docs.xbox.com/zh-CN/tools/xbox-cli/commands/xbl) | 管理 XBOX 服务配置(实验性)。 |

## 支持命令

| 命令 | 说明 |
| - | - |
| [`info`](https://docs.xbox.com/zh-CN/tools/xbox-cli/commands/info) | 显示版本和入门链接。 |
| [`upgrade`](https://docs.xbox.com/zh-CN/tools/xbox-cli/commands/upgrade) | 检查是否有更新的 CLI 版本,并显示手动更新说明。 |
| [`feedback`](https://docs.xbox.com/zh-CN/tools/xbox-cli/commands/feedback) | 打开包含 CLI 环境信息的 bug 报告草稿。 |
| [`help`](https://docs.xbox.com/zh-CN/tools/xbox-cli/commands/help) | 显示任何命令的帮助。 |

## 全局选项

每个命令都接受这些选项。如表中所述,某些选项仅影响特定命令;在其他命令中,它们会被接受但会被忽略。

| 选项 | 适用于 | 说明 |
| - | - | - |
| `--playfab-title-id <id>` | `playfab` 命令 | 要作为目标的 PlayFab 游戏。优先于 `XBOX_PLAYFAB_TITLE_ID` 和已保存的游戏,并且不会更改这两者。请参阅[上下文](https://docs.xbox.com/zh-CN/tools/xbox-cli/commands/context.md)。 |
| `--profile <name>` | 使用已保存值的命令 | 使用此配置文件中保存的值。默认为 `XBOX_PROFILE`,然后为 `default`。请参阅[配置文件](https://docs.xbox.com/zh-CN/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/zh-CN/tools/xbox-cli/commands/playfab.md#response-envelope)。 |
| `--confirm`, `--yes`, `-y` | `playfab` 命令,以及其页面列出了该选项的命令 | 跳过会先询问的命令的确认提示。请参阅[安全性](https://docs.xbox.com/zh-CN/tools/xbox-cli/safety.md)。 |
| `--verbose` | 所有命令 | 将诊断详细信息写入 stderr,包括命令所使用的每个[已保存值](https://docs.xbox.com/zh-CN/tools/xbox-cli/commands/context.md#how-commands-use-saved-values)的来源。 |
| `--disable-telemetry` | 所有命令 | 为本次运行关闭匿名产品使用情况遥测。请参阅[遥测](https://docs.xbox.com/zh-CN/tools/xbox-cli/telemetry.md)。 |

选项会覆盖设置和环境变量;请参阅[配置](https://docs.xbox.com/zh-CN/tools/xbox-cli/configuration.md)。

## 输出格式

数据命令将其结果写入 stdout,将错误和诊断信息写入 stderr。

| 格式 | 输出 |
| - | - |
| `json` | 美观打印的 JSON。默认格式。 |
| `json-compact` | 单行 JSON,用于通过管道传输到 `jq` 或脚本。 |
| `table` | 纯文本表格,适用于其页面说明接受该格式的命令。 |

PlayFab 命令会将每个结果包装在响应信封中,`--data-only` 会删除该信封;请参阅
[响应信封](https://docs.xbox.com/zh-CN/tools/xbox-cli/commands/playfab.md#response-envelope)。`--data-only` 对其他命令或与 `--output table` 一起使用时无效。

少数命令会写入面向人员的文本而不是 JSON,其页面会对此进行说明。除非你传递 `--output json` 或 `--output json-compact`,否则 `auth status`
会写入文本;请参阅
[Auth](https://docs.xbox.com/zh-CN/tools/xbox-cli/commands/auth.md#auth-status)。文件操作(例如 `playfab file upload`)不会向 stdout 写入任何内容,而是在 stderr 上报告其执行的操作;请参阅[文件](https://docs.xbox.com/zh-CN/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 的一行中显示其进度:
`Reading games... 1646 found, 25 pages, 84s`。仅当 stderr 是终端时才会显示该行,并且会在显示结果之前将其清除。

## 退出代码

每个命令都共享这些退出代码。更改内容的命令可以添加自己的退出代码(例如在更改结果未知时返回 `3`),其页面会列出这些代码。

| 退出代码 | 含义 |
| - | - |
| `0` | 命令已成功。 |
| `1` | 命令失败。错误会输出到 stderr。 |
| `130` | 在命令读取或等待时你按下了 Ctrl+C。 |

失败的 PlayFab 调用会以 `--output` 格式将错误 JSON 写入 stderr;请参阅
[PlayFab 错误响应](https://docs.xbox.com/zh-CN/tools/xbox-cli/playfab-api.md#error-responses)。未知命令会将错误和用法写入 stderr;请参阅[帮助](https://docs.xbox.com/zh-CN/tools/xbox-cli/commands/help.md)。

如果在命令发送更改后按下 Ctrl+C,它会在 stderr 上说明该更改是否可能已经完成。它会以其页面记录的代码退出,对于 PlayFab 命令则以 `1` 退出。请在再次运行之前进行检查;请参阅
[中断的写入会报告其结果未知](https://docs.xbox.com/zh-CN/tools/xbox-cli/safety.md#an-interrupted-write-reports-that-its-outcome-is-unknown)。

## 安全性

许多命令会更改生产环境中的游戏和卖家,并且只有名称以 `Get`、`List` 或 `Search` 开头的 PlayFab 操作才是只读的。在运行会更改内容的命令之前,请阅读
[安全性和破坏性操作](https://docs.xbox.com/zh-CN/tools/xbox-cli/safety.md)。


## Related topics

- [Serve 命令](https://docs.xbox.com/zh-CN/build/core-features/common/game-streaming/tak-command-line-tool/game-streaming-tak-command-line-serve-command.md)
- [Unpack 命令](https://docs.xbox.com/zh-CN/build/core-features/common/game-streaming/tak-command-line-tool/game-streaming-tak-command-line-unpack-command.md)
- [Pack 命令](https://docs.xbox.com/zh-CN/build/core-features/common/game-streaming/tak-command-line-tool/game-streaming-tak-command-line-pack-command.md)
- [Notice 命令](https://docs.xbox.com/zh-CN/build/core-features/common/game-streaming/tak-command-line-tool/game-streaming-tak-command-line-notice-command.md)
- [License 命令](https://docs.xbox.com/zh-CN/build/core-features/common/game-streaming/tak-command-line-tool/game-streaming-tak-command-line-license-command.md)
