xbox 本身:每個命令共用的全域選項、輸出格式和結束代碼。下列每個命令都有自己的頁面,而每個 playfab 服務在 commands/playfab/ 下都有一個頁面。執行 xbox <command> --help,即可在終端機中查看相同的參考。
說明會標示實驗性命令,其 CLI 合約可能會變更或移除。請參閱實驗性命令。
核心命令
支援命令
全域選項
每個命令都接受這些選項。如表格所示,有些選項只會影響特定命令;在其他命令中,這些選項會被接受但予以忽略。
選項會覆寫設定和環境變數;請參閱組態。
輸出格式
資料命令會將其結果寫入 stdout,並將錯誤和診斷寫入 stderr。
PlayFab 命令會將每個結果包裝在回應信封中,而
--data-only 會將其移除;請參閱回應信封。--data-only 對其他命令或搭配 --output table 使用時沒有作用。
少數命令會寫入供人員閱讀的文字而非 JSON,其頁面會加以說明。除非您傳遞 --output json 或 --output json-compact,否則 auth status 會寫入文字;請參閱驗證。檔案作業 (例如 playfab file upload) 不會寫入任何內容至 stdout,並會在 stderr 上回報其執行的動作;請參閱檔案。
表格輸出
表格適合在終端機中閱讀。其資料行可能在任何版本中變更,因此指令碼和代理程式應使用--output json-compact。沒有表格檢視的命令會拒絕 table:
進度
讀取多個頁面的命令 (例如game list) 或等候要求的命令 (例如 xbl config publish),會在 stderr 的一行上顯示其進度:Reading games... 1646 found, 25 pages, 84s。只有當 stderr 是終端機時才會顯示此行,且會在顯示結果之前清除。
結束代碼
這些結束代碼由每個命令共用。會變更內容的命令可以新增自己的結束代碼 (例如變更結果不明時的3),並會在其頁面中列出。
失敗的 PlayFab 呼叫會以
--output 格式將錯誤 JSON 寫入 stderr;請參閱 PlayFab 錯誤回應。未知的命令會將錯誤和使用方式寫入 stderr;請參閱說明。
如果您在命令傳送變更之後按下 Ctrl+C,它會在 stderr 上說明變更是否可能已經完成。它會以其頁面記載的代碼結束,若為 PlayFab 命令則以 1 結束。請在再次執行之前先檢查;請參閱中斷的寫入會回報其結果不明。
安全性
許多命令會變更生產遊戲、賣方和遊戲,而只有名稱以Get、List 或 Search 開頭的 PlayFab 作業是唯讀的。在執行會變更內容的命令之前,請先閱讀安全性和破壞性作業。