Skip to main content
The XBOX CLI needs no configuration file. Its settings come from defaults built into the executable, which you can override for a shell with environment variables or for a single command with options.

Configuration sources and precedence

Settings come from three sources, and later sources override earlier ones:
  1. Built-in defaults, compiled into the executable. See Settings.
  2. Environment variables. See Environment variables.
  3. Command-line options. See CLI option overrides.
A new release brings its own defaults, so there’s no settings file to carry forward. The seller, PlayFab title, XBOX title, and sandbox aren’t settings; see Context for where a command gets them.

Settings

  • AzureAd:* configure user sign-in; see Authentication.
  • PlayFab:StudioBaseUrl is the PlayFab endpoint for studio APIs (/Studio/*), such as those playfab service-principal calls.
  • XboxPartner:TimeoutSeconds is the request timeout in seconds for commands such as game, and must be a positive number.
  • XblPCSandbox:Path is the XblPCSandbox.exe that the pc sandbox commands run. When it isn’t set, the CLI looks in its own directory and then on PATH.
  • AuditLog:Enabled turns on the audit log.
  • Telemetry:* are described in Telemetry.
When PlayFab:BaseUrlTemplate, PlayFab:StudioBaseUrl, or XboxPartner:BaseUrl isn’t the built-in default, every command that sends a token to that endpoint first writes a warning to stderr.

Environment variables

A setting’s variable is XBOX_ and its key, with __ (two underscores) in place of each :, so Telemetry:Enabled is XBOX_TELEMETRY__ENABLED. Write names in capitals. A variable applies to the shell that sets it and every command that shell starts:
Every setting in Settings has a variable. The CLI also reads these: XBOX_AUTHENTICATION__ settings are read only from environment variables, never from built-in defaults or options. See Automation (service principal) authentication.

CLI option overrides

Options override every other source, for one command. See Commands for the other global options.

Telemetry configuration

Official releases collect limited anonymous telemetry unless you turn it off. To turn it off for one command:
To turn it off for a shell:
See Telemetry for what’s collected.

Upgrading from a release that read appsettings.json

Earlier releases read appsettings.json from beside the executable. If you changed a value in it, set its XBOX_ variable instead: for example, "AzureAd": { "ClientId": "..." } becomes XBOX_AZUREAD__CLIENTID. You might see these messages until you finish:
  • --config-env fails with this error. Remove the option, and set XBOX_ variables instead.
  • While an appsettings*.json file is beside the executable, commands write this note to stderr. Delete the file.
  • PlayFab commands fail with an error that names XBOX_PLAYFAB__REQUESTHEADERS__0__VALUE if an earlier error message led you to set it. Remove the variable.
Last modified on November 18, 2026