winget install --id=Microsoft.Gaming.XBOXDeveloperCLI -e The XBOX Developer CLI brings building, releasing, and operating XBOX games together in one command-line tool, with one sign-in, one set of commands, and consistent output. Use it in your terminal, in scripts and CI pipelines, or with AI agents.
The XBOX Developer CLI brings building, releasing, and operating XBOX games together in one command-line tool, with one sign-in, one set of commands, and consistent output.
Use it directly in your terminal, automate workflows with scripts and CI pipelines, or work with AI agents.
Download the latest release for Windows x64, Linux x64, or macOS (Apple silicon or Intel) from the Releases page.
Follow Installation for complete setup instructions: extract the whole archive, keep its files together, set PATH persistently, reopen terminals and IDEs, and check for older executables or aliases. No separate .NET runtime installation is required.
After setup, verify the installed version:
xbox --version
For source builds, see Building from source.
xbox upgrade --check checks release metadata; it never installs an update.
See Check for updates, including
what to do when anonymous discovery cannot access a release.
Follow Update a ZIP installation to preserve configuration changes and saved settings, switch installations safely, and verify the selected executable. Use the original installation mechanism for source or package-managed installations.
Start at the documentation index. The docs are plain Markdown that ships with the source and can be read on GitHub or locally. For a guided first use, follow Getting started. For commands and options, see the command reference.
Sign in with a developer account that has access to the intended Partner Center seller:
xbox auth login
xbox seller list --output table
Choose the seller from the results. Replace 1234567 below with that seller's ID.
Saving this default affects other CLI sessions using the same signed-in account and profile. Save it, then list the seller's games:
xbox context set seller-id 1234567
xbox context get --output table
xbox game list --output table
The final command lists the selected seller's games. An explicit --seller-id
or XBOX_SELLER_ID overrides the saved value. See
Getting started for the full walkthrough and
Authentication for sign-in help.
For PlayFab, follow the PlayFab quick start. It covers choosing a title and making a read-only request, and links to an example response. The signed-in developer needs Admin permission on that title.
Discover commands with xbox --help or xbox --help.
xbox help is equivalent to the latter; see Help.
| Work with | Documentation |
|---|---|
| Games and sellers | Games, Seller |
| Sandboxes and test accounts | Sandbox, Test account |
| Service configuration and publishing | Service configuration |
| Cross-platform services for your live game | PlayFab command reference, API integration |
| Multiplayer servers | MPS reference and MpsPowershell migration |
| Saved defaults and profiles | Context |
The complete command reference includes authentication, version information, upgrades, and every service command.
See Global options and PlayFab options for output, diagnostics, title selection, profiles, and confirmation flags.
See Configuration for files, environment variables, precedence, and saved settings locations, and Context for account-scoped saved targets.
See Output model for JSON, opt-in tables,
stdout/stderr behavior, errors, and exit codes, including signed-out
auth status. Command pages document additional command-specific exit codes.
Commands can change production state with your account's permissions. Review
the target and effect before running a command that writes. Some commands, such
as PlayFab Delete* and Shutdown* operations, require confirmation; not every
mutation is gated.
--confirm is not a substitute for an agent obtaining user approval.
Read Safety and destructive operations for confirmation rules and exceptions, and Keeping secrets out of logs for request-file, configuration, and sensitive-response handling.
Using the XBOX CLI from agents covers running the CLI from AI agents and automation, including the safety rules an agent must follow before it changes anything.
Agents that work on this source, such as GitHub Copilot, Claude Code, and Codex, read
AGENTS.md automatically. It has the conventions for building, testing, and
documenting changes.
Official release artifacts send limited anonymous usage and reliability telemetry to Microsoft.
Command arguments, PlayFab payloads, title IDs, identities, tokens, and local paths are never
collected. Opt out with XBOX_TELEMETRY_OPTOUT=1 or --disable-telemetry; see
docs/telemetry.md for the full policy.
Microsoft handles this data as described in the Microsoft privacy statement; see PRIVACY.md for the privacy notice.
See CONTRIBUTING.md for development, architecture, generators, and documentation guidance. Contributions currently go through GitHub Issues; the public repository does not accept pull requests yet. This project has adopted the Microsoft Open Source Code of Conduct; see CODE_OF_CONDUCT.md.
The XBOX Developer CLI is a technical preview, supported through GitHub Issues, not Microsoft Customer Service & Support. See SUPPORT.md for the full policy and other developer support channels. Report security vulnerabilities as described in SECURITY.md — not through public issues.
Licensed under the MIT License — see LICENSE.
This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft's Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos is subject to those third parties' policies.