> ## Documentation Index
> Fetch the complete documentation index at: https://docs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Comandos

> A referência de comandos da CLI, com suas opções globais, formatos de saída e uma página para cada comando.

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](https://docs.xbox.com/pt-BR/tools/xbox-cli/cli-command-lifecycle.md).

## Comandos principais

| Comando | Descrição |
| - | - |
| [`auth`](https://docs.xbox.com/pt-BR/tools/xbox-cli/commands/auth) | Autenticar com o Microsoft Entra ID. |
| [`context`](https://docs.xbox.com/pt-BR/tools/xbox-cli/commands/context) | Salvar valores padrão, como o vendedor e o título do PlayFab, para comandos posteriores. |
| [`game`](https://docs.xbox.com/pt-BR/tools/xbox-cli/commands/game) | Listar, obter e criar jogos do Partner Center. |
| [`seller`](https://docs.xbox.com/pt-BR/tools/xbox-cli/commands/seller) | Listar os vendedores do Partner Center disponíveis para o desenvolvedor conectado. |
| [`sandbox`](https://docs.xbox.com/pt-BR/tools/xbox-cli/commands/sandbox) | Listar, obter e criar sandboxes do XBOX. |
| [`audience`](https://docs.xbox.com/pt-BR/tools/xbox-cli/commands/audience) | Listar, obter, criar e atualizar os públicos de um vendedor (Experimental). |
| [`package`](https://docs.xbox.com/pt-BR/tools/xbox-cli/commands/package) | Listar e obter pacotes de jogos (Experimental). |
| [`playtest`](https://docs.xbox.com/pt-BR/tools/xbox-cli/commands/playtest) | Listar, obter, comparar, criar, atualizar, publicar e excluir os playtests de um jogo. |
| [`pc`](https://docs.xbox.com/pt-BR/tools/xbox-cli/commands/pc) | Obter ou trocar a sandbox do XBOX que este PC com Windows usa (Experimental). |
| [`test-account`](https://docs.xbox.com/pt-BR/tools/xbox-cli/commands/test-account) | Criar, atualizar e excluir lotes de contas de teste do XBOX, acompanhar os trabalhos de criação, ler lotes e consultar o lote de uma conta e se o acesso dela expirou. |
| [`playfab`](https://docs.xbox.com/pt-BR/tools/xbox-cli/commands/playfab) | Inspecionar e gerenciar os serviços do PlayFab. |
| [`xbl`](https://docs.xbox.com/pt-BR/tools/xbox-cli/commands/xbl) | Gerenciar a configuração dos serviços do XBOX (Experimental). |

## Comandos de suporte

| Comando | Descrição |
| - | - |
| [`info`](https://docs.xbox.com/pt-BR/tools/xbox-cli/commands/info) | Mostrar a versão e os links de introdução. |
| [`upgrade`](https://docs.xbox.com/pt-BR/tools/xbox-cli/commands/upgrade) | Verificar se há uma versão mais recente da CLI e mostrar instruções de atualização manual. |
| [`feedback`](https://docs.xbox.com/pt-BR/tools/xbox-cli/commands/feedback) | Abrir um rascunho de relatório de bug com informações do ambiente da CLI. |
| [`help`](https://docs.xbox.com/pt-BR/tools/xbox-cli/commands/help) | Mostrar a ajuda de qualquer comando. |

## 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.

| Opção | Aplica-se a | Descrição |
| - | - | - |
| `--playfab-title-id <id>` | Comandos `playfab` | O título do PlayFab de destino. Prevalece sobre `XBOX_PLAYFAB_TITLE_ID` e o título salvo e não altera nenhum dos dois. Consulte [Contexto](https://docs.xbox.com/pt-BR/tools/xbox-cli/commands/context.md). |
| `--profile <name>` | Comandos que usam valores salvos | Usar os valores salvos neste perfil. O padrão é `XBOX_PROFILE` e, em seguida, `default`. Consulte [Perfis](https://docs.xbox.com/pt-BR/tools/xbox-cli/commands/context.md#profiles). |
| `--client-id <id>` | Login do usuário | Substituir `AzureAd:ClientId`. Recusada ao entrar como entidade de serviço. |
| `--tenant-id <id>` | Login do usuário | Substituir `AzureAd:TenantId`. Recusada ao entrar como entidade de serviço. |
| `--scopes <scopes>` | Login | Substituir `AzureAd:Scopes`. |
| `--output <format>`, `-o` | Comandos de dados | `json` (o padrão), `json-compact` ou `table` nos comandos que oferecem suporte. Consulte [Formatos de saída](#output-formats). |
| `--data-only` | Comandos `playfab` | Gravar somente o campo `data` da resposta do PlayFab. Consulte [Envelope de resposta](https://docs.xbox.com/pt-BR/tools/xbox-cli/commands/playfab.md#response-envelope). |
| `--confirm`, `--yes`, `-y` | Comandos `playfab` e comandos cuja página a lista | Ignorar o prompt de confirmação de um comando que pergunta primeiro. Consulte [Segurança](https://docs.xbox.com/pt-BR/tools/xbox-cli/safety.md). |
| `--verbose` | Todos os comandos | Gravar detalhes de diagnóstico em stderr, incluindo a origem de cada [valor salvo](https://docs.xbox.com/pt-BR/tools/xbox-cli/commands/context.md#how-commands-use-saved-values) que um comando usou. |
| `--disable-telemetry` | Todos os comandos | Desativar a telemetria anônima de uso do produto nesta execução. Consulte [Telemetria](https://docs.xbox.com/pt-BR/tools/xbox-cli/telemetry.md). |

As opções substituem as configurações e as variáveis de ambiente; consulte [Configuração](https://docs.xbox.com/pt-BR/tools/xbox-cli/configuration.md).

## Formatos de saída

Os comandos de dados gravam o resultado em stdout e os erros e diagnósticos em stderr.

| Formato | Saída |
| - | - |
| `json` | JSON formatado. O padrão. |
| `json-compact` | JSON em uma única linha, para redirecionar para `jq` ou um script. |
| `table` | Uma tabela de texto simples, nos comandos cuja página diz que a aceitam. |

Os comandos do PlayFab encapsulam cada resultado em um envelope de resposta que `--data-only` remove; consulte
[Envelope de resposta](https://docs.xbox.com/pt-BR/tools/xbox-cli/commands/playfab.md#response-envelope). `--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](https://docs.xbox.com/pt-BR/tools/xbox-cli/commands/auth.md#auth-status). As operações de arquivo, como `playfab file upload`, não gravam
nada em stdout e informam o que fizeram em stderr; consulte [Arquivos](https://docs.xbox.com/pt-BR/tools/xbox-cli/commands/playfab/file.md#output).

### 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`:

```console theme={null}
$ xbox playfab api /Admin/GetTitleData --output table
Output format 'table' is not available for this command, because it does not declare a
table view. Omit --output to get this command's default output.
```

### 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.

| Código de saída | Significado |
| - | - |
| `0` | O comando foi bem-sucedido. |
| `1` | O comando falhou. O erro está em stderr. |
| `130` | Você pressionou Ctrl+C enquanto o comando estava lendo ou aguardando. |

Uma chamada ao PlayFab com falha grava o JSON do erro em stderr no formato de `--output`; consulte
[Respostas de erro do PlayFab](https://docs.xbox.com/pt-BR/tools/xbox-cli/playfab-api.md#error-responses). Um comando desconhecido grava um erro
e o uso em stderr; consulte [Ajuda](https://docs.xbox.com/pt-BR/tools/xbox-cli/commands/help.md).

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](https://docs.xbox.com/pt-BR/tools/xbox-cli/safety.md#an-interrupted-write-reports-that-its-outcome-is-unknown).

## 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](https://docs.xbox.com/pt-BR/tools/xbox-cli/safety.md) antes de executar comandos que alteram algo.


## Related topics

- [Comandos experimentais](https://docs.xbox.com/pt-BR/tools/xbox-cli/cli-command-lifecycle.md)
- [Comando serve](https://docs.xbox.com/pt-BR/build/core-features/common/game-streaming/tak-command-line-tool/game-streaming-tak-command-line-serve-command.md)
- [Comando version](https://docs.xbox.com/pt-BR/build/core-features/common/game-streaming/tak-command-line-tool/game-streaming-tak-command-line-version-command.md)
- [Comando unpack](https://docs.xbox.com/pt-BR/build/core-features/common/game-streaming/tak-command-line-tool/game-streaming-tak-command-line-unpack-command.md)
- [Comando verify](https://docs.xbox.com/pt-BR/build/core-features/common/game-streaming/tak-command-line-tool/game-streaming-tak-command-line-verify-command.md)
