Repository navigation
XBOX CLI v0.2.1
macOS
The XBOX CLI now runs on macOS. Download xbox-osx-arm64.zip for Apple silicon or xbox-osx-x64.zip for Intel. Both binaries are signed by Microsoft and notarized by Apple. Follow the Linux and macOS steps in Installation to extract the archive and add xbox to your PATH.
Breaking changes
- The CLI no longer reads
appsettings.jsonorappsettings.{environment}.json. Its settings are built into the executable, and you change them withXBOX_environment variables, such asXBOX_AZUREAD__CLIENTID, or with command options. Each zip now holds only the executable,LICENSE, andNOTICE.md. If you changed a value in one of those files, set itsXBOX_variable instead; see Upgrading from a release that read appsettings.json. --config-envis retired. Passing it is an error that points toXBOX_environment variables.sandbox listwrites a JSON object with asandboxesarray, asgame listdoes, instead of a bare array. Scripts must read.sandboxes. An empty listing is{"sandboxes":[]}.- Telemetry no longer reads
APPLICATIONINSIGHTS_CONNECTION_STRING, and a release build's telemetry destination can't be changed. The opt-outs are unchanged; see Telemetry. - If you set
XBOX_PLAYFAB__REQUESTHEADERS__0__VALUEbecause an earlier error message suggested it, remove it. PlayFab commands fail until you do, with an error that names it. auth statusreports that you're signed out only when no account is cached. If the configuration, the sign-in settings, or the token cache can't be read, it exits 1 and writes the error to stderr.
Setting up and testing your game
- When
game createfails, it says whether a game could have been created. If the request wasn't sent, or the service refused it, no game was created, and it's safe to fix the problem and run it again. After a server error, a timeout, or a dropped connection, the outcome is unknown, and the command prints thegame listcommand to check before trying again. - When you create XBOX test accounts in a terminal without
--security-questionor--security-answer-file,test-account batch createoffers a numbered list of security questions. Enter keeps the default,What is your favorite hobby?. game,sandbox,test-account, andxblcommands never follow an HTTP redirect, so a request that creates something is never sent twice.test-account batch create,update, anddeletereport a redirect as an unknown outcome, with exit code 3.
Configuring and publishing
xblcommands that wait on one request, such asxbl configuration get,xbl publish start, andxbl document commit, show what they're waiting for on one line of stderr, such asPublishing from STAGE.0 to RETAIL... 12s. The line is drawn only when stderr is a terminal, and is erased before the result or error is written.
Running your game live
playfab economy inventory operation statusno longer needs--collection-idfor the default collection. Pass the entity that gave the items as--entity-idand--entity-type.
Sign-in and errors
- Commands that run offline, such as
xbox infoandxbox upgrade, no longer refuse--client-id,--tenant-id, or a service-principal profile. - A warning about a changed service endpoint appears only for the services the command calls.
- An error a command expects is reported as one message on stderr, never a stack trace.