> ## 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.

# 內容

> 儲存預設值 (例如賣方和 PlayFab 遊戲) 以供後續命令使用；如果需要多組值，可將它們儲存在具名設定檔中。

`xbox context` 會儲存賣方、PlayFab 遊戲、XBOX 遊戲和沙箱的預設值，因此您不需要將它們傳遞給每個命令。此頁面也說明當您未傳遞這些值時，命令會從何處取得它們。內容只存在於本機：這些命令不會變更 Partner Center 或 PlayFab 中的任何項目。

## 命令

| 命令 | 描述 |
| - | - |
| `context get` | 顯示已儲存的值。 |
| `context set` | 儲存一個值。 |
| `context unset` | 移除已儲存的值。 |
| `context key list` | 列出您可以儲存的索引鍵，以及使用每個索引鍵的命令。不需要登入。 |
| `context profile list` | 列出您的設定檔，從 `default` 開始。 |
| `context profile delete` | 刪除具名設定檔及其中儲存的每個值。 |

## 索引鍵

索引鍵就是它所填入之選項的名稱：

| 索引鍵 | 選項 | 變數 | 使用者 |
| - | - | - | - |
| `playfab-title-id` | `--playfab-title-id` | `XBOX_PLAYFAB_TITLE_ID` | [`playfab`](https://docs.xbox.com/zh-TW/tools/xbox-cli/commands/playfab) 命令 |
| `sandbox-id` | `--sandbox-id` | `XBOX_SANDBOX_ID` | [`xbl`](https://docs.xbox.com/zh-TW/tools/xbox-cli/commands/xbl) `config status` 和 `config publish` |
| `seller-id` | `--seller-id` | `XBOX_SELLER_ID` | [`audience`](https://docs.xbox.com/zh-TW/tools/xbox-cli/commands/audience)、[`game`](https://docs.xbox.com/zh-TW/tools/xbox-cli/commands/game)、[`package`](https://docs.xbox.com/zh-TW/tools/xbox-cli/commands/package)、[`playtest`](https://docs.xbox.com/zh-TW/tools/xbox-cli/commands/playtest)、[`sandbox`](https://docs.xbox.com/zh-TW/tools/xbox-cli/commands/sandbox)、[`test-account`](https://docs.xbox.com/zh-TW/tools/xbox-cli/commands/test-account) 和 [`xbl`](https://docs.xbox.com/zh-TW/tools/xbox-cli/commands/xbl) 命令 |
| `title-id` | `--title-id` | `XBOX_TITLE_ID` | [`xbl`](https://docs.xbox.com/zh-TW/tools/xbox-cli/commands/xbl#title-targeting) `config list`、`config status`、`config publish`，以及沙箱範圍的 `config download` 和 `config save` |

沒有其他選項會採用已儲存的值或變數。

`title-id` 是十六進位的 XBOX 遊戲識別碼 (例如 `1234ABCD`)，而不是 PlayFab 遊戲識別碼。`xbl` 命令會使用它來尋找遊戲的服務設定識別碼 (SCID)，並在您傳遞 `--scid` 時忽略它。請參閱[遊戲目標設定](https://docs.xbox.com/zh-TW/tools/xbox-cli/commands/xbl.md#title-targeting)。

## 命令如何使用已儲存的值

當命令採用其中一個選項時，它會使用找到的第一個值：

1. 命令列上的選項，例如 `--seller-id`。
2. 選項的 `XBOX_` 變數，例如 `XBOX_SELLER_ID`。空白變數視為未設定。
3. 在所選[設定檔](#profiles)中使用 `context set` 儲存的值。

```bash theme={null}
xbox context set playfab-title-id ABC123
xbox playfab title-data get                                # uses ABC123
XBOX_PLAYFAB_TITLE_ID=DEF456 xbox playfab title-data get   # uses DEF456
xbox --playfab-title-id GHI789 playfab title-data get      # uses GHI789
```

來自變數或已儲存內容的值，會像手動輸入的值一樣經過檢查，而錯誤會指出值的來源，例如 `XBOX_SELLER_ID: --seller-id must be a positive numeric value.`。如果沒有任何來源提供命令所需的值，命令會說明如何設定該值。賣方為選用的命令 (`xbl` 和 `test-account`) 會使用您唯一獲得授權的賣方。

會變更內容的命令，即使搭配 `--confirm`，也會將它所填入的每個值及其來源寫入 stderr。使用 `--verbose` 時，每個命令都會這麼做：

```text theme={null}
Using --playfab-title-id ABC123 from saved context.
```

[已知問題](https://docs.xbox.com/zh-TW/tools/xbox-cli/known-issues.md)說明了兩個會導致 `game` 和 `sandbox` 命令使用與此方式所選賣方不同之賣方的問題。

## 設定檔

設定檔是一組具名的已儲存值，例如一組用於測試遊戲，另一組用於生產環境。命令會使用 `--profile` 指定的設定檔，否則使用 `XBOX_PROFILE` 指定的設定檔，再否則使用 `default`。

```bash theme={null}
xbox --profile test context set playfab-title-id TEST1   # creates "test"
xbox --profile test playfab title-data get               # uses TEST1
xbox playfab title-data get                              # uses the default profile
```

若要讓 shell 中的每個命令都使用某個設定檔，請設定 `XBOX_PROFILE`：

```bash theme={null}
export XBOX_PROFILE=test
```

若要列出您的設定檔：

```bash theme={null}
xbox context profile list
```

若要刪除設定檔及其中儲存的每個值：

```bash theme={null}
xbox context profile delete test
```

* 將第一個值儲存至設定檔時，就會建立該設定檔。名稱由字母、數字和連字號組成，最多 64 個字元，且不區分大小寫。

* 不存在的設定檔 (例如拼錯的名稱) 會導致失敗，而不會回復為使用 `default`。

* 設定檔不會從 `default` 借用值。

* `XBOX_` 變數的優先順序仍高於設定檔。當變數的優先順序高於 `--profile` 指定的設定檔時，即使命令沒有變更任何項目，也會指出這一點：

  ```text theme={null}
  Using --playfab-title-id PROD1 from XBOX_PLAYFAB_TITLE_ID, not profile test.
  ```

* CLI 不會在命令之間記住設定檔，因此選擇設定檔絕不會變更其他終端機或代理程式所使用的內容。

## 值的儲存位置

已儲存的值位於 CLI 狀態目錄中的 `context.json`：

| 作業系統 | 目錄 |
| - | - |
| Windows | `%LOCALAPPDATA%\XboxDevCLI` |
| macOS | `~/Library/Application Support/XboxDevCLI` |
| Linux | `$XDG_DATA_HOME/XboxDevCLI`，預設為 `~/.local/share/XboxDevCLI` |

每個值都屬於儲存它的帳戶，因此其他帳戶不會取用它。`auth logout` 會保留已儲存的值，以相同帳戶重新登入時就會還原這些值。

## 引數和選項

| 引數或選項 | 命令 | 描述 |
| - | - | - |
| `<key> <value>` | `set` | 要儲存的索引鍵及其值。值必須對索引鍵的選項有效：`seller-id` 是正數 (請參閱 [`xbox seller list`](https://docs.xbox.com/zh-TW/tools/xbox-cli/commands/seller))，而 `playfab-title-id` 由字母和數字組成。 |
| `<key>...` | `unset` | 要移除的索引鍵。移除未儲存的索引鍵也會成功。 |
| `<name>` | `profile delete` | 要刪除的設定檔。無法刪除 `default`。 |
| `--profile <name>` | 全部 | 使用此設定檔，而不是 `XBOX_PROFILE` 指定的設定檔或 `default`。這是[全域選項](https://docs.xbox.com/zh-TW/tools/xbox-cli/commands.md)。 |
| `--all` | `unset` | 移除所選設定檔中儲存的每個值。無法與索引鍵名稱合併使用。 |
| `--base-url <url>` | `get`、`set`、`unset` | 覆寫 `XboxPartner:BaseUrl` 設定。已儲存的賣方值屬於儲存時所用的端點。 |
| `--output <format>` | 全部 | `json` (預設)、`json-compact` 或 `table`。 |

## 行為

`get` 會傳回已登入的 `account`、`profile`，以及由 `key` 和 `value` 組成的 `values` 陣列，未儲存的索引鍵其值為 `null`。它顯示的是已儲存的內容，而不是命令實際會使用的內容；若要查看後者，請搭配 `--verbose` 執行命令。在登出狀態下，`get` 不會顯示任何值，並會說明如何登入。

`set`、`unset` 和 `profile` 命令需要已登入的帳戶。`set` 不會向服務檢查值，因此您無法使用的賣方會在第一個傳送它的命令上失敗。

服務主體沒有已儲存的內容。在服務主體模式下，需要登入的命令會拒絕 `--profile` 和 `XBOX_PROFILE`，而且除了 `key list` 以外的每個 `context` 命令都會失敗。請改為使用每個值的選項或 `XBOX_` 變數來傳遞值。請參閱[自動化 (服務主體) 驗證](https://docs.xbox.com/zh-TW/tools/xbox-cli/authentication.md#automation-service-principal-authentication)。

## 不是來自命令列的值

已儲存的內容由您的作業系統使用者所執行的每個終端機和代理程式共用，而環境變數不會出現在命令列上。因此，除了指出它所填入的每個值以外：

* 以內容值本身為目標的作業，必須在命令列上指定該值。`/Admin/DeleteTitle` 會刪除遊戲，而 `playfab api-policy set --overwrite` 會取代遊戲的整個 API 存取原則，因此兩者都會拒絕來自已儲存內容或變數的遊戲，並列印應改為執行的命令：

  ```text theme={null}
  $ xbox playfab api /Admin/DeleteTitle --confirm
  Using --playfab-title-id ABC123 from saved context.
  '/Admin/DeleteTitle' acts on playfab-title-id ABC123, which comes from saved context.
  The target of a destructive operation must be named on the command line. To proceed, run:
    xbox --playfab-title-id ABC123 playfab api /Admin/DeleteTitle --confirm
  ```

  列印出的命令會省略內嵌的 `--body` 或 `--statements` 值，因為要求本文可能包含秘密。請將該值放回 `<body>` 或 `<statements>` 的位置。

* 如果在使用已儲存值的命令執行期間 (例如在等待確認時) 有其他帳戶登入，命令會在傳送任何內容之前停止。請再次執行該命令。

如需確認規則，請參閱[安全性和破壞性作業](https://docs.xbox.com/zh-TW/tools/xbox-cli/safety.md)。

## 表格輸出

每個 context 命令都接受 `--output table`：

| 命令 | 欄 |
| - | - |
| `context get`、`set`、`unset` | `KEY`、`VALUE` |
| `context key list` | `KEY`、`USED BY` |
| `context profile list`、`profile delete` | `NAME` |

## 範例

列出您可以儲存的索引鍵：

```bash theme={null}
xbox context key list --output table
```

儲存賣方和 PlayFab 遊戲，並檢查已儲存的內容：

```bash theme={null}
xbox context set seller-id 1234567
xbox context set playfab-title-id ABC123
xbox context get --output table
```

執行使用已儲存值的命令，並查看遊戲的來源：

```bash theme={null}
xbox game list
xbox --verbose playfab title-data get
```

移除一個已儲存的值：

```bash theme={null}
xbox context unset playfab-title-id
```

移除所選設定檔中儲存的每個值：

```bash theme={null}
xbox context unset --all
```

如需設定 (內容不會變更這些設定)，請參閱[設定](https://docs.xbox.com/zh-TW/tools/xbox-cli/configuration.md)。


## Related topics

- [內容](https://docs.xbox.com/zh-TW/reference/system/touchadaptationkit/layout/game-streaming-touch-layout-content.md)
- [Visual Studio (內容)](https://docs.xbox.com/zh-TW/tools/tools-pc/visualstudio/gr-visualstudio-toc.md)
- [XSAPI 參考 (內容)](https://docs.xbox.com/zh-TW/reference/live/xsapi-c/atoc-xsapi-c.md)
- [API 參考 (內容)](https://docs.xbox.com/zh-TW/reference/gc-reference-toc.md)
- [Game Saves (內容)](https://docs.xbox.com/zh-TW/build/core-features/common/game-save/game-saves-toc.md)
