Pular para o conteúdo principal
Esta página é a referência de comandos da XBOX CLI. Ela abrange o próprio xbox: as opções globais, os formatos de saída e os códigos de saída que todos os comandos compartilham. Cada comando abaixo tem sua própria página, e cada serviço playfab tem uma página em commands/playfab/. Execute xbox <command> --help para ver a mesma referência no terminal. A Ajuda rotula os comandos experimentais, cujo contrato de CLI pode mudar ou ser removido. Consulte Comandos experimentais.

Comandos principais

Comandos de suporte

Opções globais

Todos os comandos aceitam estas opções. Algumas afetam apenas determinados comandos, conforme indicado na tabela; nos demais, elas são aceitas e ignoradas. As opções substituem as configurações e as variáveis de ambiente; consulte Configuração.

Formatos de saída

Os comandos de dados gravam o resultado em stdout e os erros e diagnósticos em stderr. Os comandos do PlayFab encapsulam cada resultado em um envelope de resposta que --data-only remove; consulte Envelope de resposta. --data-only não tem efeito em outros comandos nem com --output table. Alguns comandos gravam texto para pessoas em vez de JSON, e as páginas deles indicam isso. auth status grava texto, a menos que você passe --output json ou --output json-compact; consulte Auth. As operações de arquivo, como playfab file upload, não gravam nada em stdout e informam o que fizeram em stderr; consulte Arquivos.

Saída em tabela

As tabelas servem para leitura em um terminal. As colunas delas podem mudar em qualquer versão; portanto, scripts e agentes devem usar --output json-compact. Um comando sem visualização em tabela recusa table:

Progresso

Os comandos que leem muitas páginas, como game list, ou que aguardam uma solicitação, como xbl config publish, mostram o progresso em uma linha de stderr: Reading games... 1646 found, 25 pages, 84s. A linha aparece somente quando stderr é um terminal e é apagada antes do resultado.

Códigos de saída

Estes códigos de saída são compartilhados por todos os comandos. Os comandos que alteram algo podem adicionar os próprios, como 3 quando o resultado de uma alteração é desconhecido, e as páginas deles os listam. Uma chamada ao PlayFab com falha grava o JSON do erro em stderr no formato de --output; consulte Respostas de erro do PlayFab. Um comando desconhecido grava um erro e o uso em stderr; consulte Ajuda. Se você pressionar Ctrl+C depois que um comando enviou uma alteração, ele informará em stderr se a alteração pode ter sido feita. Ele sai com o código que a página dele documenta, ou 1 para um comando do PlayFab. Verifique antes de executá-lo novamente; consulte Uma gravação interrompida informa que seu resultado é desconhecido.

Segurança

Muitos comandos alteram títulos, vendedores e jogos de produção, e somente as operações do PlayFab cujos nomes começam com Get, List ou Search são somente leitura. Leia Segurança e operações destrutivas antes de executar comandos que alteram algo.
Última modificação em 19 de novembro de 2026