pc commands get or switch the XBOX sandbox that this Windows PC uses. They’re
Experimental, and they run on Windows only. See
Experimental commands.
A PC uses one sandbox at a time, for every user and every game on it, and games sign in to that
sandbox. The default is RETAIL. To test a game in a development sandbox such as ABCDEF.1,
switch the PC to it first. To see which sandboxes your Partner Center account has, use
xbox sandbox list.
Commands
Each command runsXblPCSandbox.exe, the XBOX services PC Sandbox Switcher, and works the way
its documentation
describes.
For the tool’s
/feedback command, run XblPCSandbox /feedback directly.
Switching sandboxes
pc sandbox set changes the sandbox for every user on the PC. It asks before it switches, then
shows a User Account Control (UAC) prompt for administrator rights. It restarts the XBOX services
on the PC, and reopens the Microsoft Store and XBOX app if they were open. Then it checks that the
PC uses the new sandbox.
set switches even when the PC already uses the sandbox. Running it again restarts the services,
which fixes sign-in that still uses the old sandbox. If that doesn’t help, restart the PC and see
Troubleshooting sandboxes.
Switch to RETAIL before you update the XBOX app or Gaming Services from the Microsoft Store.
Installing the tool
XblPCSandbox.exe ships with the XBOX Game Development Kit (GDK), and in XboxLiveTools.zip on
the XBOX services development tools releases
page. Gaming Services, the Windows service that runs XBOX features on the PC, must be installed.
The CLI looks for the tool in this order:
- The
XblPCSandbox:Pathsetting, such as theXBOX_XBLPCSANDBOX__PATHenvironment variable. - The folder that contains the CLI.
- Each folder on
PATH.
Options
Output
get and launch-apps return {"sandbox": "ABCDEF.1"}, and set returns
{"sandbox": "ABCDEF.1", "previousSandbox": "RETAIL"}. With --output table, the columns are
SANDBOX, and PREVIOUS SANDBOX for set. The tool’s own output goes to stderr.
Errors
The tool’s errors link to Troubleshooting sandboxes and
suggest
XblPCSandbox /feedback to report a problem.
Examples
Get the sandbox this PC uses:RETAIL:
