XBOX PC Remote (wdRemote.exe)

O app XBOX PC Toolbox está em versão prévia. Baixe-o na Microsoft Store no Windows.

O XBOX PC Remote (wdRemote.exe) é uma ferramenta de linha de comando para conectar com segurança um PC de desenvolvimento a um dispositivo Windows remoto. Ela oferece suporte ao emparelhamento com PIN, à transferência bidirecional de arquivos, à exclusão remota de arquivos, à implantação e ao gerenciamento do ciclo de vida de jogos e à execução remota de ferramentas. O wdRemote é executado em um PC de desenvolvimento e se comunica com uma instância do wdEndpoint.exe em execução no dispositivo remoto. Veja a Visão geral do XBOX PC Remote Tools para obter uma descrição da função do wdRemote e do wdEndpoint no conjunto de ferramentas de desenvolvimento remoto para dispositivos Windows. Use o XBOX PC Toolbox ou o WinGet para instalar o wdRemote no seu PC de desenvolvimento. winget install Microsoft.Gaming.RemoteIterationClient Use o wdRemote para executar os comandos listados na tabela a seguir.

Comando	Descrição
wdRemote /action:pair	Estabelece uma conexão confiável e segura entre um PC de desenvolvimento e o dispositivo remoto por meio do emparelhamento com PIN.
wdRemote /action:purgekeys	Remove todas as chaves de criptografia e os emparelhamentos de dispositivos de um PC de desenvolvimento.
wdRemote /action:version	Exibe a versão do wdRemote.exe.
wdRemote /action:status	Exibe o status da conexão entre o PC de desenvolvimento e o dispositivo de destino.
wdRemote /action:deploy	Implanta um jogo de um PC de desenvolvimento em um dispositivo Windows remoto.
wdRemote /action:launch	Inicia um jogo em um dispositivo Windows remoto.
wdRemote /action:resume	Retoma, em um dispositivo Windows remoto, um jogo que foi iniciado em estado suspenso.
wdRemote /action:terminate	Encerra o jogo, o trabalho da ferramenta ou o processo especificado em um dispositivo Windows remoto.
wdRemote /action:copy	Copia arquivos do PC de desenvolvimento para um dispositivo Windows remoto.
wdRemote /action:copyfrom	Copia arquivos de um dispositivo Windows remoto para o PC de desenvolvimento.
wdRemote /action:delete	Exclui um arquivo ou o conteúdo de um diretório em um dispositivo Windows remoto.
wdRemote /action:run	Executa um executável em um dispositivo Windows remoto.

Emparelhamento de dispositivos Windows remotos e gerenciamento de chaves de segurança

wdRemote /action:pair

Este comando estabelece uma conexão confiável e segura entre um PC de desenvolvimento e o dispositivo remoto por meio do emparelhamento com PIN. O wdEndpoint em execução no dispositivo remoto gera o PIN. wdRemote /action:pair /device:HostName | IP Address /pin:pin number [/sshKey:filename]

Opção	Descrição
/action:pair	Indica que o wdRemote deve executar uma operação de emparelhamento com PIN.
/device:	O endereço IP ou o nome do host do dispositivo remoto.
/pin:	O PIN gerado por uma instância do wdEndpoint em execução no dispositivo remoto.
/sshKey:	Uma chave SSH opcional a ser instalada no dispositivo remoto. Essa chave pode ser usada para estabelecer uma conexão SSH entre o PC de desenvolvimento e o dispositivo remoto.

Exemplo:

// Start the pairing process by obtaining a pin using `wdEndpoint /pair` on the remote device.  `wdEndpoint /pair` must be executed from a command prompt with Administrator privileges
c:>wdEndpoint /pair

wdEndpoint version: 1.0.0.0
No configuration found at 'C:\ProgramData\Microsoft GDK\wdEndpoint\wdEndpoint.json', using defaults.
Overriding security mode for pairing.

Device ID: <example-device-id>
Security Mode: Private
Common Roots:
  (Default) C:\ProgramData\Microsoft GDK\gameroot

Server startup.
Listening for requests on: https://+:4275/gamingTransport/.
Entered exclusive pairing mode for 120 seconds.
PIN: <example-pin>

// Specify the result PIN to the pairing /action to wdRemote on the development PC
c:>wdRemote /action:pair /device:example-device /pin:<example-pin>

Successfully paired.
Client: <example-client-id>
Device: <example-device-id>

Voltar ao início deste tópico.

wdRemote /action:purgekeys

Todo o tráfego entre o wdRemote e o wdEndpoint é criptografado. O wdRemote cria automaticamente as chaves de criptografia e os certificados necessários na primeira vez em que é solicitado a se conectar a um dispositivo remoto. Essas chaves também são usadas no processo de emparelhamento. Esta ação remove todas as chaves e os emparelhamentos de dispositivos de um PC de desenvolvimento. wdRemote /action:purgekeys Voltar ao início deste tópico.

Informações de status e versão

wdRemote /action:version

Exibe a versão do wdRemote.exe. wdRemote /action:version Voltar ao início deste tópico.

wdRemote /action:status

Exibe o status da conexão entre o PC de desenvolvimento e o dispositivo de destino. O wdRemote /action:pair verifica todos os emparelhamentos de dispositivos e confirma se a criptografia está em vigor. wdRemote /action:status /device:HostName | IP Address

Opção	Descrição
/action:status	Indica que o `wdRemote` deve exibir o status da conexão entre o PC de desenvolvimento e o dispositivo identificado pelo argumento `/device:`
/device:	O endereço IP ou o nome do host do dispositivo remoto.

Voltar ao início deste tópico.

Implantar, iniciar e encerrar aplicativos

wdRemote /action:deploy

Implanta um jogo de um PC de desenvolvimento no dispositivo de destino especificado pelo argumento /device:. Todas as implantações são incrementais, o que significa que apenas os arquivos alterados desde a última implantação são transferidos para o dispositivo de destino. Os jogos são armazenados no dispositivo de destino em um diretório chamado Common Root. Por padrão, a Common Root é %ProgramData%\Microsoft GDK\gameroot. Os caminhos de destino passados ao wdRemote são relativos à Common Root, a menos que você especifique um caminho absoluto; nesse caso, a Common Root é ignorada. Você pode alterar o local da Common Root padrão e adicionar mais Common Roots criando um arquivo chamado wdEndpoint.json e colocando-o em %ProgramData%\Microsoft GDK\wdEndpoint\ no dispositivo de destino. O wdEndpoint.json contém uma lista de Common Roots no formato a seguir.

{
  root:<absolute file path>,
  alias:<name>,
  default:true|false
}

Especificar default é opcional. Se vários padrões forem especificados, o primeiro listado se tornará o padrão. Se nenhuma raiz for marcada como padrão, a primeira listada se tornará o padrão. O exemplo de wdEndpoint.json a seguir define duas Common Roots: uma raiz padrão em c:\developmentbuilds e outra raiz em d:\releasedbuilds.

{
    "gameRoots": [
        {
            "root": "c:\\developmentbuilds",
            "alias": "primary",
            "default": true
        },
        {
            "root": "d:\\releasedbuilds",
            "alias": "released"
        }
    ]
}

wdRemote /action:deploy /device:<remote device> /source:<source directory> /destination:<absolute or common root relative destination directory> [/root:<common root alias>] [/attributes:<-AHSR>]

Opção	Descrição
/action:deploy	Indica que o `wdRemote` deve executar uma ação de implantação.
/device:	O endereço IP ou o nome do host do dispositivo remoto.
/source:	O diretório no PC de desenvolvimento que contém o jogo a ser implantado.
/destination:	Os caminhos de destino relativos são resolvidos na Common Root selecionada. Se um caminho absoluto for especificado, a Common Root será ignorada.
/root:	Um alias opcional de Common Root. Se não for especificado, a Common Root padrão será usada.
/attributes:	Opcionalmente, inclui ou exclui arquivos e diretórios de acordo com seus atributos de arquivo.

A opção /attributes: oferece suporte às letras a seguir.

Letra	Atributo de arquivo
`A`	Arquivo morto
`H`	Oculto
`R`	Somente leitura
`S`	Sistema

As letras antes de - são incluídas. As letras depois de - são excluídas. Exemplos

// Deploys the contents of c:\gamesource\x64\Debug to a directory named Daily under the default Common Root.  Using the example config file above, the game
// will be deployed to c:\developmentbuilds\Daily on the target device.
c:\>wdRemote /action:deploy /device:example-device /source:c:\gamesource\x64\Debug /destination:Daily

// Deploys the contents of \\example-server\builds\buildoutput to a directory named october2025 under the Common Root at d:\releasedbuilds.  Using the example config file above,
// the game will be deployed to d:\releasedbuilds\october2025 on the target device.
c:\>wdRemote /action:deploy /device:example-device /source:\\example-server\builds\buildoutput /destination:october2025 /root:released

// Deploys everything except hidden files and directories.
c:\>wdRemote /action:deploy /device:example-device /source:C:\game /destination:game1 /attributes:-H

Voltar ao início deste tópico.

wdRemote /action:launch

Inicia um jogo no dispositivo remoto especificado pelo argumento /device:. A ID do processo do jogo iniciado é exibida como saída. O wdRemote garante que apenas um jogo esteja em execução por vez no dispositivo remoto. Se um jogo já estiver em execução no dispositivo remoto quando você executar wdRemote /action:launch, o jogo em execução será encerrado antes que o novo jogo seja iniciado.

wdRemote /action:launch /device:<remote device> /path:<absolute or Common Root-relative executable path> [/root:<Common Root alias>] [/args:"<arguments>"] [/suspend]

Opção	Descrição
/action:launch	Indica que o wdRemote deve executar uma ação de inicialização.
/device:	O endereço IP ou o nome do host do dispositivo remoto.
/path:	O caminho para o executável a ser iniciado. Os caminhos relativos são resolvidos na Common Root. Se um caminho absoluto for especificado, a Common Root será ignorada.
/args:	Uma lista de argumentos a serem passados ao executável.
/root:	Um alias opcional de Common Root. Se não for especificado, a Common Root padrão será usada.
/suspend:	Um sinalizador opcional que inicia o jogo em estado suspenso. Use `wdRemote /action:resume` para retomar um jogo iniciado com `/suspend`.

Exemplos

// Launches a game in the default Common Root, passing a command line argument to the game
c:\>wdRemote /action:launch /device:example-device /path:Daily\Game.exe /args:"-level 2"

// Launches a game in a suspended state
c:\>wdRemote /action:launch /device:example-device /path:Daily\Game.exe /suspend

Voltar ao início deste tópico.

wdRemote /action:resume

Retoma, no dispositivo remoto, um jogo que foi iniciado em estado suspenso usando wdRemote /action:launch com o sinalizador /suspend. wdRemote /action:resume /device:HostName | IP Address

Opção	Descrição
/action:resume	Indica que o `wdRemote` deve executar uma ação de retomada.
/device:	O endereço IP ou o nome do host do dispositivo remoto.

Exemplos

c:\>wdRemote /action:resume /device:example-device

Voltar ao início deste tópico.

wdRemote /action:terminate

Encerra o jogo remoto, o trabalho da ferramenta remota ou o processo remoto especificado.

wdRemote /action:terminate /device:<remote device>
wdRemote /action:terminate /device:<remote device> /tool[:<pid>]

Forma	Comportamento
Sem argumento `/tool`	Encerra o jogo remoto.
`/tool`	Encerra o trabalho da ferramenta remota.
`/tool:pid`	Tenta encerrar o processo com a ID de processo especificada.

Exemplos

// Terminates the remote game.
c:\>wdRemote /action:terminate /device:example-device

// Terminates the remote tool job.
c:\>wdRemote /action:terminate /device:example-device /tool

// Attempts to terminate the specified process.
c:\>wdRemote /action:terminate /device:example-device /tool:1234

Voltar ao início deste tópico.

Copiar e excluir arquivos

wdRemote /action:copy

Copia arquivos do PC de desenvolvimento para um dispositivo Windows remoto.

wdRemote /action:copy /device:HostName | IP Address /source:source directory /destination:remote directory [/root:gameRoot alias]

Opção	Descrição
/action:copy	Indica que o `wdRemote` deve executar uma operação de cópia.
/device:	O endereço IP ou o nome do host do dispositivo Windows remoto.
/source:	O diretório de origem no PC de desenvolvimento.
/destination:	O diretório de destino no dispositivo Windows remoto.
/root:	Um alias opcional de Common Root usado para resolver um caminho de destino relativo. Se omitido para um caminho relativo, a Common Root padrão será usada. As Common Roots são ignoradas para caminhos de destino absolutos.

Exemplo

c:\>wdRemote /action:copy /device:example-device /source:C:\game /destination:game1

wdRemote /action:copyfrom

Copia arquivos de um dispositivo Windows remoto para o PC de desenvolvimento. /source é o caminho remoto e /destination é o caminho local. /root resolve um caminho de origem remoto relativo e é ignorado quando /source é absoluto.

wdRemote /action:copyfrom /device:HostName | IP Address /source:remote source directory /destination:local destination directory [/root:gameRoot alias]

Opção	Descrição
/action:copyfrom	Indica que o `wdRemote` deve executar uma operação de cópia a partir do dispositivo.
/device:	O endereço IP ou o nome do host do dispositivo Windows remoto.
/source:	O diretório de origem no dispositivo Windows remoto.
/destination:	O diretório de destino no PC de desenvolvimento.
/root:	Um alias opcional de Common Root usado para resolver um caminho de origem remoto relativo.

Exemplo

c:\>wdRemote /action:copyfrom /device:example-device /source:game1 /destination:C:\local_copy

wdRemote /action:delete

Tenta excluir um arquivo ou o conteúdo selecionado de um diretório em um dispositivo Windows remoto. A exclusão de diretórios é feita com base no melhor esforço. O log do ponto de extremidade registra o número de itens excluídos e o número de falhas, mas não os caminhos de arquivo individuais.

wdRemote /action:delete /device:HostName | IP Address /path:remote directory or file [/root:gameRoot alias] [/include:pattern] [/exclude:pattern] [/excludedir:pattern] [/attributes:<-AHSR>] [/deleteroot]

Opção	Descrição
/action:delete	Indica que o `wdRemote` deve executar uma operação de exclusão.
/device:	O endereço IP ou o nome do host do dispositivo Windows remoto.
/path:	O diretório ou arquivo remoto a ser excluído.
/root:	Um alias opcional de Common Root usado para resolver um caminho remoto relativo.
/include:	Inclui os arquivos que correspondem ao padrão. Os caracteres curinga `*` e `?` são compatíveis.
/exclude:	Exclui os arquivos que correspondem ao padrão. Os caracteres curinga `*` e `?` são compatíveis. A exclusão tem precedência sobre a inclusão.
/excludedir:	Exclui os diretórios cujos nomes correspondem ao padrão. Os caracteres curinga `*` e `?` são compatíveis.
/attributes:	Inclui ou exclui arquivos e diretórios pelos atributos Arquivo morto, Oculto, Somente leitura e Sistema. Excluir um atributo também exclui os diretórios que o possuem, junto com todo o seu conteúdo.
/deleteroot	Tenta remover o diretório especificado por `/path` depois de excluir seu conteúdo. O diretório só é removido se estiver vazio. Independentemente dessa opção, a operação tenta remover os subdiretórios vazios que passam pelos filtros de diretório.

A exclusão pode seguir junções de diretório e links simbólicos de diretório abaixo de /path e excluir arquivos correspondentes fora desse diretório. O comando ainda pode relatar sucesso; não são fornecidos resultados por item nem operação de desfazer. Verifique se o próprio /path não é um diretório vinculado e use /excludedir para excluir pelo nome subdiretórios vinculados conhecidos.

Quando /path identifica um único arquivo, as opções de pesquisa e /deleteroot são ignoradas. Exemplos

c:\>wdRemote /action:delete /device:example-device /path:game1
c:\>wdRemote /action:delete /device:example-device /path:game1 /exclude:"*.pdb" /excludedir:"logs"
c:\>wdRemote /action:delete /device:example-device /path:game1 /deleteroot
c:\>wdRemote /action:delete /device:example-device /path:game1\readme.txt

Executar ferramentas remotas

wdRemote /action:run

Executa um executável em um dispositivo Windows remoto.

wdRemote /action:run /device:HostName | IP Address /path:absolute executable path [/args:"arguments"] [/waitForExit] [/streamOutput] [/asAdmin]

Opção	Descrição
/action:run	Indica que o `wdRemote` deve executar um executável.
/device:	O endereço IP ou o nome do host do dispositivo Windows remoto.
/path:	O caminho absoluto para o executável no dispositivo Windows remoto.
/args:	Argumentos passados ao executável.
/waitForExit	Aguarda o executável ser encerrado.
/streamOutput	Transmite a saída padrão e o erro padrão até que o executável seja encerrado.
/asAdmin	Executa o executável como administrador.

/waitForExit não pode ser combinado com /streamOutput. /asAdmin não pode ser combinado com /streamOutput. Sem /waitForExit ou /streamOutput, o comando informa a ID do processo e a ID do thread iniciados. Com /waitForExit ou /streamOutput, o wdRemote.exe retorna o código de saída do processo remoto. Exemplos

c:\>wdRemote /action:run /device:example-device /path:C:\tools\mytool.exe
c:\>wdRemote /action:run /device:example-device /path:C:\tools\mytool.exe /args:"-arg1 -arg2" /waitForExit
c:\>wdRemote /action:run /device:example-device /path:C:\tools\mytool.exe /args:"-arg1 -arg2" /streamOutput
c:\>wdRemote /action:run /device:example-device /path:C:\tools\mytool.exe /asAdmin

Recursos adicionais

wdEndpoint XBOX PC Remote Tools

​XBOX PC Remote (wdRemote.exe)

​Emparelhamento de dispositivos Windows remotos e gerenciamento de chaves de segurança

​wdRemote /action:pair

​wdRemote /action:purgekeys

​Informações de status e versão

​wdRemote /action:version

​wdRemote /action:status

​Implantar, iniciar e encerrar aplicativos

​wdRemote /action:deploy

​wdRemote /action:launch

​wdRemote /action:resume

​wdRemote /action:terminate

​Copiar e excluir arquivos

​wdRemote /action:copy

​wdRemote /action:copyfrom

​wdRemote /action:delete

​Executar ferramentas remotas

​wdRemote /action:run

​Recursos adicionais

XBOX PC Remote (wdRemote.exe)

Emparelhamento de dispositivos Windows remotos e gerenciamento de chaves de segurança

wdRemote /action:pair

wdRemote /action:purgekeys

Informações de status e versão

wdRemote /action:version

wdRemote /action:status

Implantar, iniciar e encerrar aplicativos

wdRemote /action:deploy

wdRemote /action:launch

wdRemote /action:resume

wdRemote /action:terminate

Copiar e excluir arquivos

wdRemote /action:copy

wdRemote /action:copyfrom

wdRemote /action:delete

Executar ferramentas remotas

wdRemote /action:run

Recursos adicionais