Skip to content

XBOX CLI v0.1.30

Choose a tag to compare

@tbradshaw tbradshaw released this 03 Nov 02:33
· 3 commits to main since this release
6b4a56d

Breaking changes

  • The xbl commands' --sandbox option is now --sandbox-id, and xbl publish start's --source-sandbox is now --source-sandbox-id, matching game create and test-account batch create. The xbl sandbox options no longer have the -s and -d short aliases; -s is still --scid, and -d is still --dest.
  • The saved context key is now sandbox-id, and its environment variable is XBOX_SANDBOX_ID. A sandbox saved with xbox context set sandbox or set in XBOX_SANDBOX is no longer read; save it again with xbox context set sandbox-id <id>, or set XBOX_SANDBOX_ID. Only xbl configuration get, xbl publish start, and xbl publish status read it; other commands that take --sandbox-id need it on the command line.

Setting up and testing your game

  • game list and game get show their progress on one line of stderr while they read a large catalog, such as Reading games... 1646 found, 25 pages, 84s, and xbl achievement-image upload shows its upload the same way. The line is drawn only when stderr is a terminal, and is erased before the result or error is written.
  • test-account batch create shows the password requirements before it asks for one, and rejects an empty password before submitting anything.
  • game commands remove control characters from the job and correlation IDs they print, so a malformed ID can't disrupt your terminal or logs. The JSON on stdout keeps the ID as the service returned it. If an ID can't be printed safely, the recovery message points to game list instead of printing a command that wouldn't work.

Errors and rate limits

  • When an XBOX service request returns HTTP 429 with a Retry-After header, the error says how many seconds to wait, and structured errors include it as retryAfterSeconds. A 429 with the code rate_limited says that you sent too many requests in a short time. See Rate limits.
  • Errors, warnings, and Help refer to the service consistently and describe failures in plain terms.
  • Docs and Help call XBOX's online services XBOX services, and xbl is described as managing XBOX services configuration.

Privacy and notices

  • The repository includes a privacy notice, PRIVACY.md, and NOTICE.md lists the third-party packages the CLI ships, with their licenses.
  • Each release's zip includes LICENSE and NOTICE.md beside the executable, with the notices of the .NET runtime it bundles.