Repository navigation
Testing your game with playtests
- New
xbox playtestcommands list, get, and compare a game's playtests, and create, update, publish, and delete them.create,update,publish, anddeleteare Experimental. See Playtest, and Your first playtest for a walkthrough. playtest createandplaytest updatechoose who can join with--audience-id, and which builds players get with--pc-package-idand--console-package-id.- Before it asks to publish,
playtest publishchecks the game's XBOX services setup, such as whether its embargo date is after the playtest's end date, and lists anything to review. Use XBOX services in a playtest explains how to prepare it. playtest deletewaits until the playtest is deleted, asplaytest publishwaits until it's scheduled or live.--no-waitreturns as soon as the request is queued.playtest create --idempotency-keymakes a retry safe. When the outcome of a create is unknown, the error shows the command that retries it without creating a second playtest.- Playtest commands show a progress line with a timer on stderr while a request runs.
- New Experimental
xbox audiencecommands list, get, create, and update a seller's audiences, the groups of players or devices that Partner Center calls customer groups. See Audience. - New Experimental
xbox package listandxbox package getcommands show a game's packages, and whether a build can be used in a playtest. See Package.
Configuring and publishing XBOX services
- The
xbox xblconfiguration commands have new names; see Breaking changes below. xbl configcommands can name a game by its XBOX title ID with--title-id, or the savedtitle-idcontext, instead of its service configuration identifier (SCID). When other titles share the configuration, saving or publishing by title ID asks first, and--allow-shared-configurationskips the question.- Before it asks you to confirm a publish to RETAIL,
xbl config publishlists the achievements the publish adds, because achievements can't be removed once they're live.--validate-onlyto RETAIL lists them too. xbl config statusincludes the result of the last publish, inlastPublish.
Automating with service principals
- New Experimental
xbox playfab service-principalcommands let a studio administrator grant a Microsoft Entra ID service principal access to PlayFab titles, so a continuous integration (CI) pipeline can runxbox playfabcommands. See Service principal.
Installing and updating
- On Windows, install and update the CLI with WinGet:
winget install xbox. - On Linux and macOS, install the CLI with one command:
curl -fsSL https://raw.githubusercontent.com/xbox/cli/main/install.sh | sh. See Installation.
Safety, errors, and scripting
- Confirmation prompts stand out from the summary before them, with a blank line, and bold color in a terminal that supports it.
- Ctrl+C stops Partner Center and XBOX services commands consistently. A command that's reading or waiting exits
130without an error. A change stopped before its request was sent says that nothing changed. xbox game getwith a Store ID in place of an XBOX title ID suggests the same command with--store-id.- A numeric option that isn't a number is reported as an error, instead of crashing.
Breaking changes
- The
xbox xblconfiguration commands are renamed:configuration listisconfig list,configuration getisconfig status,document downloadisconfig download,document commitisconfig save, andpublish startisconfig publish.publish statusis removed; its result is thelastPublishfield ofconfig status. See XBOX services configuration. xbl config downloadrequires--view, andworkingis renameddraft: pass--view draftor--view published.xbl schema getno longer lists or downloads schemas: usexbl schema listfor types and versions, andxbl schema downloadto save XSD files, or--dest -to print one.schema getnow shows one version's type, version, and namespace.- The
xbl configandxbl schemacommands no longer accept one-letter option names, except-ofor--outputand-yfor--yes. Use the full names, such as--typeand--scid. xbox playfab title-data getno longer accepts--value-only. A single-key get already writes the bare value.- Telemetry sends one event for each command, with schema version 3, in place of the earlier metrics and traces, and the
Telemetry:DependencyTracingEnabledandTelemetry:DependencyTraceSamplingRatiosettings are removed. See Telemetry.
Fixed
xbox upgradeno longer fails withHTTP 301: GitHub release metadata is unavailable.- On Linux, when
~/.local/sharedoesn't exist, the CLI no longer keeps its state, including its token cache, in anXboxDevCLIfolder in the current directory. If an earlier version leftXboxDevCLI/xboxdevcli_tokencache.binin a folder you ran it from, delete it.
See Known issues for the problems this release still has.