Skip to content

XBOX CLI v0.4.2

Latest

Choose a tag to compare

@tbradshaw tbradshaw released this 15 Nov 16:13
· 1 commit to main since this release
3ed7566

Testing your game with playtests

  • New xbox playtest commands list, get, and compare a game's playtests, and create, update, publish, and delete them. create, update, publish, and delete are Experimental. See Playtest, and Your first playtest for a walkthrough.
  • playtest create and playtest update choose who can join with --audience-id, and which builds players get with --pc-package-id and --console-package-id.
  • Before it asks to publish, playtest publish checks 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 delete waits until the playtest is deleted, as playtest publish waits until it's scheduled or live. --no-wait returns as soon as the request is queued.
  • playtest create --idempotency-key makes 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 audience commands 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 list and xbox package get commands show a game's packages, and whether a build can be used in a playtest. See Package.

Configuring and publishing XBOX services

  • The xbox xbl configuration commands have new names; see Breaking changes below.
  • xbl config commands can name a game by its XBOX title ID with --title-id, or the saved title-id context, instead of its service configuration identifier (SCID). When other titles share the configuration, saving or publishing by title ID asks first, and --allow-shared-configuration skips the question.
  • Before it asks you to confirm a publish to RETAIL, xbl config publish lists the achievements the publish adds, because achievements can't be removed once they're live. --validate-only to RETAIL lists them too.
  • xbl config status includes the result of the last publish, in lastPublish.

Automating with service principals

  • New Experimental xbox playfab service-principal commands let a studio administrator grant a Microsoft Entra ID service principal access to PlayFab titles, so a continuous integration (CI) pipeline can run xbox playfab commands. 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 130 without an error. A change stopped before its request was sent says that nothing changed.
  • xbox game get with 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 xbl configuration commands are renamed: configuration list is config list, configuration get is config status, document download is config download, document commit is config save, and publish start is config publish. publish status is removed; its result is the lastPublish field of config status. See XBOX services configuration.
  • xbl config download requires --view, and working is renamed draft: pass --view draft or --view published.
  • xbl schema get no longer lists or downloads schemas: use xbl schema list for types and versions, and xbl schema download to save XSD files, or --dest - to print one. schema get now shows one version's type, version, and namespace.
  • The xbl config and xbl schema commands no longer accept one-letter option names, except -o for --output and -y for --yes. Use the full names, such as --type and --scid.
  • xbox playfab title-data get no 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:DependencyTracingEnabled and Telemetry:DependencyTraceSamplingRatio settings are removed. See Telemetry.

Fixed

  • xbox upgrade no longer fails with HTTP 301: GitHub release metadata is unavailable.
  • On Linux, when ~/.local/share doesn't exist, the CLI no longer keeps its state, including its token cache, in an XboxDevCLI folder in the current directory. If an earlier version left XboxDevCLI/xboxdevcli_tokencache.bin in a folder you ran it from, delete it.

See Known issues for the problems this release still has.