xbox itself: the
global options, output formats, and exit codes every command shares. Each command below has its
own page, and each playfab service has a page under commands/playfab/. Run
xbox <command> --help to see the same reference in your terminal.
Help labels Experimental commands whose CLI contract might change or be removed.
See Experimental commands.
Core commands
Support commands
Global options
Every command accepts these options. Some only affect certain commands, as the table says; elsewhere they’re accepted and ignored.
Options override settings and environment variables; see Configuration.
Output formats
Data commands write their result to stdout and errors and diagnostics to stderr.
PlayFab commands wrap each result in a response envelope that
--data-only removes; see
Response envelope. --data-only has no effect on
other commands or with --output table.
A few commands write text for people instead of JSON, and their pages say so. auth status
writes text unless you pass --output json or --output json-compact; see
Auth. File operations, such as playfab file upload, write
nothing to stdout and report what they did on stderr; see Files.
Table output
Tables are for reading at a terminal. Their columns might change in any release, so scripts and agents should use--output json-compact. A command without a table view refuses
table:
Progress
Commands that read many pages, such asgame list, or wait on a request, such as
xbl config publish, show their progress on one line of stderr:
Reading games... 1646 found, 25 pages, 84s. The line appears only when stderr is a terminal,
and it’s erased before the result.
Exit codes
These exit codes are shared by every command. Commands that change something can add their own, such as3 when a change’s outcome is unknown, and their pages list them.
A failed PlayFab call writes the error JSON to stderr in the
--output format; see
PlayFab error responses. An unknown command writes an error
and usage to stderr; see Help.
If you press Ctrl+C after a command sent a change, it says on stderr whether the change might
have been made. It exits with the code its page documents, or 1 for a PlayFab command. Check
before you run it again; see
An interrupted write reports that its outcome is unknown.
Safety
Many commands change production titles, sellers, and games, and only PlayFab operations whose names start withGet, List, or Search are read-only. Read
Safety and destructive operations before you run commands that change something.