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
会写入文本;请参阅
Auth。文件操作(例如 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 操作才是只读的。在运行会更改内容的命令之前,请阅读
安全性和破坏性操作。