Windows: install with WinGet
On Windows, install the CLI with WinGet, the Windows Package Manager:xbox to your PATH, and needs no administrator rights. If the terminal can’t find
xbox after installing, open a new terminal, or restart your IDE if you use its integrated
terminal.
To update the CLI:
%LOCALAPPDATA%\XboxDevCLI. Update a
WinGet installation only with WinGet, not with the ZIP steps on this page. Continue with
Next steps.
Linux and macOS: install with a script
On Linux x64 or macOS, the install script downloads the latest release into~/.local/opt/xboxdevcli, and adds that directory to your PATH in your shell’s startup file.
It needs curl and unzip:
xbox --version. To update the CLI, run the script again. To remove it, delete
~/.local/opt/xboxdevcli and the line the script added to that startup file.
Download a release
Install from a release archive when WinGet and the install script don’t fit, such as on a Windows PC without WinGet. Download the archive for your operating system and CPU from the GitHub Releases page:
The Linux x64 binary requires glibc 2.27 or later. The macOS binaries are signed by Microsoft and
notarized by Apple. You don’t need to install .NET.
Extract the whole archive into a new directory of its own, and add that directory to your
PATH,
as the steps for your platform show. If the directory already holds an installation, follow
Update a ZIP installation instead.
Windows (PowerShell)
-
Extract the archive, and check the extracted executable:
-
Add the directory to your
PATH. From Windows Search, open Edit environment variables for your account. Under User variables, edit Path, select New, and enter the directory, such asC:\Users\<you>\AppData\Local\Programs\XboxDevCLI. -
Open a new terminal, and check the version:
Linux and macOS (Bash or Zsh)
-
Extract the archive, and check the extracted executable. This example uses Linux x64; on
macOS, use
xbox-osx-arm64.zipon Apple silicon orxbox-osx-x64.zipon Intel: -
Add the directory to your
PATH. Add this line to~/.zshrcfor Zsh, the default shell on macOS, or to~/.bashrcfor Bash: -
Open a new terminal, and check the version:
Verify the installation
xbox --version shows the version of the release you downloaded, without the tag’s leading v.
If it shows an older version, another copy of xbox comes first on your PATH. Find it with
Get-Command xbox -All in PowerShell or type -a xbox in Bash or Zsh, and remove it from your
PATH.
Check for updates
xbox upgrade tells you whether there’s a newer release, and how to install it. See
Upgrade.
winget upgrade Microsoft.Gaming.XBOXDeveloperCLI. To
update a script installation, run the install script
again. To update a ZIP installation, follow the next section.
Update a ZIP installation
Your saved settings and sign-in data are stored apart from the installation, so they carry over. See Where values are saved.- Download the new release’s archive from the release page
xbox upgradeshows, or from the GitHub Releases page, and extract it into a new directory. - Close any running
xboxprocesses. - Either replace your old installation directory with the new one, at the same path, or change
your
PATHentry to the new directory as in Windows (PowerShell) or Linux and macOS (Bash or Zsh). - Open a new terminal, and check that
xbox --versionshows the new version.
PATH, until the new version works. If your sign-in has expired,
run xbox auth login again.
Next steps
- Getting started: sign in, choose your Partner Center seller, and list its games.
- Commands: the full command reference.
- Telemetry: what the CLI collects, and how to turn it off.
