> ## 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-TW/tools/xbox-cli/cli-command-lifecycle.md)。

## 核心命令

| 命令 | 描述 |
| - | - |
| [`auth`](https://docs.xbox.com/zh-TW/tools/xbox-cli/commands/auth) | 使用 Microsoft Entra ID 進行驗證。 |
| [`context`](https://docs.xbox.com/zh-TW/tools/xbox-cli/commands/context) | 儲存預設值 (例如賣方和 PlayFab 遊戲) 以供後續命令使用。 |
| [`game`](https://docs.xbox.com/zh-TW/tools/xbox-cli/commands/game) | 列出、取得及建立 Partner Center 遊戲。 |
| [`seller`](https://docs.xbox.com/zh-TW/tools/xbox-cli/commands/seller) | 列出登入的開發人員可使用的 Partner Center 賣方。 |
| [`sandbox`](https://docs.xbox.com/zh-TW/tools/xbox-cli/commands/sandbox) | 列出、取得及建立 XBOX 沙箱。 |
| [`audience`](https://docs.xbox.com/zh-TW/tools/xbox-cli/commands/audience) | 列出、取得、建立及更新賣方的對象 (實驗性)。 |
| [`package`](https://docs.xbox.com/zh-TW/tools/xbox-cli/commands/package) | 列出及取得遊戲套件 (實驗性)。 |
| [`playtest`](https://docs.xbox.com/zh-TW/tools/xbox-cli/commands/playtest) | 列出、取得、比較、建立、更新、發佈及刪除遊戲的試玩測試。 |
| [`pc`](https://docs.xbox.com/zh-TW/tools/xbox-cli/commands/pc) | 取得或切換此 Windows PC 使用的 XBOX 沙箱 (實驗性)。 |
| [`test-account`](https://docs.xbox.com/zh-TW/tools/xbox-cli/commands/test-account) | 建立、更新及刪除 XBOX 測試帳戶批次、追蹤其建立作業、讀取批次，以及查閱帳戶的批次及其存取權是否已到期。 |
| [`playfab`](https://docs.xbox.com/zh-TW/tools/xbox-cli/commands/playfab) | 檢查及管理 PlayFab 服務。 |
| [`xbl`](https://docs.xbox.com/zh-TW/tools/xbox-cli/commands/xbl) | 管理 XBOX services 組態 (實驗性)。 |

## 支援命令

| 命令 | 描述 |
| - | - |
| [`info`](https://docs.xbox.com/zh-TW/tools/xbox-cli/commands/info) | 顯示版本和入門連結。 |
| [`upgrade`](https://docs.xbox.com/zh-TW/tools/xbox-cli/commands/upgrade) | 檢查是否有較新的 CLI 版本，並顯示手動更新指示。 |
| [`feedback`](https://docs.xbox.com/zh-TW/tools/xbox-cli/commands/feedback) | 開啟包含 CLI 環境資訊的錯誤報告草稿。 |
| [`help`](https://docs.xbox.com/zh-TW/tools/xbox-cli/commands/help) | 顯示任何命令的說明。 |

## 全域選項

每個命令都接受這些選項。如表格所示，有些選項只會影響特定命令；在其他命令中，這些選項會被接受但予以忽略。

| 選項 | 適用於 | 描述 |
| - | - | - |
| `--playfab-title-id <id>` | `playfab` 命令 | 要作為目標的 PlayFab 遊戲。優先於 `XBOX_PLAYFAB_TITLE_ID` 和已儲存的遊戲，且不會變更兩者。請參閱[內容](https://docs.xbox.com/zh-TW/tools/xbox-cli/commands/context.md)。 |
| `--profile <name>` | 使用已儲存值的命令 | 使用此設定檔中儲存的值。預設為 `XBOX_PROFILE`，其次為 `default`。請參閱[設定檔](https://docs.xbox.com/zh-TW/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-TW/tools/xbox-cli/commands/playfab.md#response-envelope)。 |
| `--confirm`, `--yes`, `-y` | `playfab` 命令，以及頁面中列出此選項的命令 | 略過會先詢問之命令的確認提示。請參閱[安全性](https://docs.xbox.com/zh-TW/tools/xbox-cli/safety.md)。 |
| `--verbose` | 所有命令 | 將診斷詳細資料寫入 stderr，包括命令所使用的每個[已儲存值](https://docs.xbox.com/zh-TW/tools/xbox-cli/commands/context.md#how-commands-use-saved-values)的來源。 |
| `--disable-telemetry` | 所有命令 | 在此次執行中關閉匿名產品使用遙測。請參閱[遙測](https://docs.xbox.com/zh-TW/tools/xbox-cli/telemetry.md)。 |

選項會覆寫設定和環境變數；請參閱[組態](https://docs.xbox.com/zh-TW/tools/xbox-cli/configuration.md)。

## 輸出格式

資料命令會將其結果寫入 stdout，並將錯誤和診斷寫入 stderr。

| 格式 | 輸出 |
| - | - |
| `json` | 美化排版的 JSON。這是預設值。 |
| `json-compact` | 單行 JSON，用於透過管道傳送至 `jq` 或指令碼。 |
| `table` | 純文字表格，適用於頁面中註明接受此格式的命令。 |

PlayFab 命令會將每個結果包裝在回應信封中，而 `--data-only` 會將其移除；請參閱[回應信封](https://docs.xbox.com/zh-TW/tools/xbox-cli/commands/playfab.md#response-envelope)。`--data-only` 對其他命令或搭配 `--output table` 使用時沒有作用。

少數命令會寫入供人員閱讀的文字而非 JSON，其頁面會加以說明。除非您傳遞 `--output json` 或 `--output json-compact`，否則 `auth status` 會寫入文字；請參閱[驗證](https://docs.xbox.com/zh-TW/tools/xbox-cli/commands/auth.md#auth-status)。檔案作業 (例如 `playfab file upload`) 不會寫入任何內容至 stdout，並會在 stderr 上回報其執行的動作；請參閱[檔案](https://docs.xbox.com/zh-TW/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-TW/tools/xbox-cli/playfab-api.md#error-responses)。未知的命令會將錯誤和使用方式寫入 stderr；請參閱[說明](https://docs.xbox.com/zh-TW/tools/xbox-cli/commands/help.md)。

如果您在命令傳送變更之後按下 Ctrl+C，它會在 stderr 上說明變更是否可能已經完成。它會以其頁面記載的代碼結束，若為 PlayFab 命令則以 `1` 結束。請在再次執行之前先檢查；請參閱[中斷的寫入會回報其結果不明](https://docs.xbox.com/zh-TW/tools/xbox-cli/safety.md#an-interrupted-write-reports-that-its-outcome-is-unknown)。

## 安全性

許多命令會變更生產遊戲、賣方和遊戲，而只有名稱以 `Get`、`List` 或 `Search` 開頭的 PlayFab 作業是唯讀的。在執行會變更內容的命令之前，請先閱讀[安全性和破壞性作業](https://docs.xbox.com/zh-TW/tools/xbox-cli/safety.md)。


## Related topics

- [Serve 命令](https://docs.xbox.com/zh-TW/build/core-features/common/game-streaming/tak-command-line-tool/game-streaming-tak-command-line-serve-command.md)
- [Notice 命令](https://docs.xbox.com/zh-TW/build/core-features/common/game-streaming/tak-command-line-tool/game-streaming-tak-command-line-notice-command.md)
- [License 命令](https://docs.xbox.com/zh-TW/build/core-features/common/game-streaming/tak-command-line-tool/game-streaming-tak-command-line-license-command.md)
- [Convert 命令](https://docs.xbox.com/zh-TW/build/core-features/common/game-streaming/tak-command-line-tool/game-streaming-tak-command-line-convert-command.md)
- [Verify 命令](https://docs.xbox.com/zh-TW/build/core-features/common/game-streaming/tak-command-line-tool/game-streaming-tak-command-line-verify-command.md)
