Compartilhar via


Comandos

Instalação

Etapa 1: Instalar o .NET Windows Runtime

Caso ainda não tenha feito, instale a versão mais recente do .NET 8 Desktop Runtime. Esse é um requisito para executar a Developer CLI da Microsoft Store.

A maneira mais fácil de instalá-la é usar winget:

winget install Microsoft.DotNet.DesktopRuntime.8

Etapa 2: Instalar a CLI do desenvolvedor da Microsoft Store no Windows

Você pode baixar a Developer CLI da Microsoft Store da própria Microsoft Store. Como alternativa, você pode usar o winget:

winget install "Microsoft Store Developer CLI"

Etapa 1: Instalar o .NET macOS Runtime

Caso ainda não tenha feito, instale a versão mais recente do .NET 8 Runtime. Esse é um requisito para executar a Developer CLI da Microsoft Store.

Etapa 2: instalar a CLI do desenvolvedor da Microsoft Store no macOS

Você pode baixar o .tar.gz do macOS para sua arquitetura específica (x64 ou Arm64) na página de versões da Developer CLI da Microsoft Store. Uma vez baixado, extraia o arquivo e coloque-o em seu PATH, no entanto, você deseja fazer isso, por exemplo:

mkdir MSStoreCLI
curl https://github.com/microsoft/msstore-cli/releases/latest/download/MSStoreCLI-osx-x64.tar.gz -o MSStoreCLI-osx-x64.tar.gz
tar -xvf MSStoreCLI-osx-x64.tar.gz -C ./MSStoreCLI
sudo cp -R MSStoreCLI/. /usr/local/bin

Como alternativa, você pode usar brew:

brew install microsoft/msstore-cli/msstore-cli

Etapa 1: Instalar o .NET Linux Runtime

Caso ainda não tenha feito, instale a versão mais recente do .NET 8 Runtime. Esse é um requisito para executar a Developer CLI da Microsoft Store.

Etapa 2: Instalar a CLI do Desenvolvedor da Microsoft Store no Linux

Você pode baixar o .tar.gz do Linux para sua arquitetura específica (x64 ou Arm64) na página de versões da Developer CLI da Microsoft Store. Uma vez baixado, extraia o arquivo e coloque-o em seu PATH, no entanto, você deseja fazer isso, por exemplo:

mkdir MSStoreCLI
wget https://github.com/microsoft/msstore-cli/releases/latest/download/MSStoreCLI-linux-x64.tar.gz
tar -xvf MSStoreCLI-linux-x64.tar.gz -C ./MSStoreCLI
sudo cp -R MSStoreCLI/. /usr/local/bin

Como alternativa, você pode usar brew:

brew install microsoft/msstore-cli/msstore-cli

Comando Info

Imprima a configuração existente.

Comando Info - Uso

msstore info

Comando Info - Opções

Opção Descrição
-v, --verbose Imprima a saída detalhada.

Comando Reconfigure

Reconfigure a CLI do Desenvolvedor da Microsoft Store. Você pode fornecer um Segredo do Cliente ou um Certificado. Os certificados podem ser fornecidos por meio de sua impressão digital ou fornecendo um caminho de arquivo (com ou sem senha).

Reconfigurar - Uso

msstore reconfigure

Reconfigurar - Opções

Opção Descrição
-t, --tenantId Especifique a ID do locatário que deve ser usada.
-s, --sellerId Especifique a ID do vendedor que deve ser usada.
-c, --clientId Especifique a ID do cliente que deve ser usada.
-cs, --clientSecret Especifique o segredo do cliente que deve ser usado.
-ct, --certificateImpressão digital Especifique a impressão digital do certificado que deve ser usada.
-cfp, --certificateFilePath Especifique o caminho do arquivo de certificado que deve ser usado.
-cp, --certificatePassword Especifique a senha do certificado que deve ser usada.
--repor Apenas redefina as credenciais, sem começar de novo.

Comando de configurações

Altere as configurações da CLI do Desenvolvedor da Microsoft Store.

Configurações - Uso

msstore settings
Subcomando Descrição
setpdn Defina a propriedade Nome de Exibição do Publicador que é usada pelo comando init.

Configurações - Opções

Opção Descrição
-t, --enableTelemetry Habilitar (vazio/verdadeiro) ou Desabilitar (falso) telemetria.
-v, --verbose Imprima a saída detalhada.

Configurações - Uso do comando SetPDN

msstore settings setpdn <publisherDisplayName>

Argumentos

Argument Descrição
publisherDisplayName A propriedade Nome de Exibição do Publicador que será definida globalmente.

Ajuda

msstore settings setpdn --help

Comando Apps

Subcomando Descrição
lista Lista todos os aplicativos em sua conta.
get Obtém os detalhes de um aplicativo específico.

Aplicativos - Listar o uso do comando

msstore apps list

Comando List - Ajuda

msstore apps list --help

Aplicativos - Obter uso de comando

msstore apps get <productId>

Aplicativos – Obter argumentos de comando

Argument Descrição
productId A ID do produto.

Aplicativos - Obter Ajuda do Command

msstore apps get --help

Comando Submission

Subcomando Descrição
status Obtém o status de um envio.
get Obtém os detalhes de um envio específico.
getListingAssets Obtém os ativos de listagem de um envio específico.
updateMetadata Atualiza os metadados de um envio específico.
update Atualiza os detalhes de um envio específico.
pesquisa Sonda o status de um envio.
publicar Publica uma submissão específica.
excluir Exclui um envio específico.

Envio - Uso do comando Status

msstore submission status <productId>

Submissão - Argumentos do comando Status

Argument Descrição
productId A ID do produto.

Envio - Ajuda do Comando de Status

msstore submission status --help

Envio - Obter uso do comando

msstore submission get <productId>

Submissão - Obter argumentos de comando

Argument Descrição
productId A ID do produto.

Envio - Obter opções de comando

Opção Descrição
-m, --módulo Selecione qual módulo você deseja recuperar ('disponibilidade', 'listagens' ou 'propriedades').
-l, --language Selecione o idioma que deseja recuperar. [padrão: en]

Envio - Obter Ajuda do Comando

msstore submission get --help

Envio - Uso do comando GetListingAssets

Recupera os ativos de listagem de rascunho existentes do envio da loja.

msstore submission getListingAssets <productId>

Envio - Argumentos de comando GetListingAssets

Argument Descrição
productId A ID do produto.

Envio - Opções de comando GetListingAssets

Opção Descrição
-l, --language Selecione o idioma que deseja recuperar. [padrão: en]

Envio - Ajuda do comando GetListingAssets

msstore submission getListingAssets --help

Envio - Uso do comando UpdateMetadata

msstore submission updateMetadata <productId> <metadata>

Envio - Argumentos de comando UpdateMetadata

Argument Descrição
productId A ID do produto.
metadata A representação de metadados JSON atualizada.

Submissão - Opções de comando UpdateMetadata

Opção Descrição
-s, --skipInitialPolling Ignore a sondagem inicial antes de executar a ação. [padrão: Falso]

Envio - Ajuda do comando UpdateMetadata

msstore submission updateMetadata --help

Submissão - Atualizar uso do comando

msstore submission update <productId> <product>

Submissão - Atualizar argumentos de comando

Argument Descrição
productId A ID do produto.
product A representação atualizada do produto JSON.

Submissão - Opções de comando de atualização

Opção Descrição
-s, --skipInitialPolling Ignore a sondagem inicial antes de executar a ação. [padrão: Falso]

Envio - Ajuda do Comando de Atualização

msstore submission update --help

Envio - Uso do comando de pesquisa

msstore submission poll <productId>

Submissão - Argumentos do comando de sondagem

Argument Descrição
productId A ID do produto.

Envio - Ajuda do Comando de Sondagem

msstore submission poll --help

Envio - Uso do comando de publicação

msstore submission publish <productId>

Submissão - Publicar argumentos de comando

Argument Descrição
productId A ID do produto.

Envio - Ajuda do Comando de Publicação

msstore submission publish --help

Envio - Excluir uso do comando

Exclui o envio pendente do repositório.

Submissão - Excluir argumentos de comando

Argument Descrição
productId A ID do produto.

Submissão - Opções de comando Excluir

Opção Descrição
--não-confirmar Não solicite confirmação. [padrão: Falso]

Envio - Ajuda do Comando Excluir

msstore submission delete --help

Comando Init

O init comando ajuda você a configurar seu aplicativo para publicar na Microsoft Store. Atualmente, ele suporta os seguintes tipos de aplicativos:

  • SDK do Aplicativo Windows/WinUI 3
  • UWP
  • .NET MAUI
  • Flutter
  • Electron
  • React Native para Windows
  • PWA

Comando Init - Exemplos de uso

Comando Init – SDK do Aplicativo Windows/WinUI 3

msstore init "C:\path\to\winui3_app"

Comando de inicialização - UWP

msstore init "C:\path\to\uwp_app"

Comando de inicialização - .NET MAUI

msstore init "C:\path\to\maui_app"

Comando de inicialização - Flutter

msstore init "C:\path\to\flutter_app"

Comando de inicialização - Elétron

msstore init "C:\path\to\electron_app"

Comando Init - React Native para Windows

msstore init "C:\path\to\react_native_app"

Observação

Para projetos Electron, bem como React Native para Windows, ambos Npm Yarn são suportados. A presença do Yarn arquivo de bloqueio (yarn.lock) será usada para determinar qual gerenciador de pacotes usar, portanto, certifique-se de fazer check-in do arquivo de bloqueio no sistema de controle do código-fonte.

Comando de inicialização - PWA

msstore init https://contoso.com --output .

Comando Init - Argumentos

Argument Descrição
pathOrUrl O caminho do diretório raiz onde está o arquivo do projeto ou uma URL pública que aponta para um PWA.

Comando Init - Opções

Opção Descrição
-n, --publisherDisplayName O Nome de Exibição do Publicador usado para configurar o aplicativo. Se fornecido, evita uma chamada extra de APIs.
--pacote Se compatível com o tipo de aplicativo, empacota automaticamente o projeto.
--publicar Se houver suporte no tipo de aplicativo, publicará automaticamente o projeto. Implica '--package true'
-f, --flightId Especifica a ID de Voo em que o pacote será publicado.
-prp, --packageRolloutPercentage Especifica a porcentagem de distribuição do pacote. O valor precisa estar entre 0 e 100.
-a, --arch A(s) arquitetura(s) para a qual construir. Se não for fornecido, a arquitetura padrão para o sistema operacional atual e o tipo de projeto serão usados. Valores permitidos: "x86", "x64", "arm64". Usei apenas em conjunto com '--package true'.
-o, --output O diretório de saída em que o aplicativo empacotado será armazenado. Se não for fornecido, o diretório padrão para cada tipo diferente de aplicativo será usado.
-ver, --version A versão usada ao criar o aplicativo. Se não for fornecida, a versão do arquivo de projeto será usada.

Comando Package

Ajuda você a empacotar seu aplicativo da Microsoft Store como um MSIX.

Comando Package - Exemplos de uso

Comando de pacote – SDK do Aplicativo Windows/WinUI 3

msstore package "C:\path\to\winui3_app"

Comando de pacote – UWP

msstore package "C:\path\to\uwp_app"

Comando de pacote - .NET MAUI

msstore package "C:\path\to\maui_app"

Comando de pacote - Flutter

msstore package "C:\path\to\flutter_app"

Comando de Pacote - Electron

msstore package "C:\path\to\electron_app"

Comando de pacote - React Native para Windows

msstore package "C:\path\to\react_native_app"

Comando de pacote - PWA

msstore package "C:\path\to\pwa_app"

Comando de pacote - Argumentos

Opção Descrição
pathOrUrl O caminho do diretório raiz onde está o arquivo do projeto ou uma URL pública que aponta para um PWA.

Comando de pacote - Opções

Opção Descrição
-o, --output O diretório de saída em que o aplicativo empacotado será armazenado. Se não for fornecido, o diretório padrão para cada tipo diferente de aplicativo será usado.
-a, --arch A(s) arquitetura(s) para a qual construir. Se não for fornecido, a arquitetura padrão para o sistema operacional atual e o tipo de projeto serão usados. Valores permitidos: "x86", "x64", "arm64".
-ver, --version A versão usada ao criar o aplicativo. Se não for fornecida, a versão do arquivo de projeto será usada.

Comando Publish

Publica sua Aplicação na Microsoft Store.

Comando Publicar - Exemplos de Uso

Comando de publicação – SDK do Aplicativo Windows/WinUI 3

msstore publish "C:\path\to\winui3_app"

Comando de publicação – UWP

msstore publish "C:\path\to\uwp_app"

Comando de publicação - .NET MAUI

msstore publish "C:\path\to\maui_app"

Comando de publicação - Flutter

msstore publish "C:\path\to\flutter_app"

Comando de publicação - Electron

msstore publish "C:\path\to\electron_app"

Comando de publicação - React Native para Windows

msstore publish "C:\path\to\react_native_app"

Comando de publicação - PWA

msstore publish "C:\path\to\pwa_app"

Comando Publicar - Argumentos

Opção Descrição
pathOrUrl O caminho do diretório raiz onde está o arquivo do projeto ou uma URL pública que aponta para um PWA.

Comando Publicar - Opções

Opção Descrição
-i, --inputDirectory O diretório onde o arquivo '.msix' ou '.msixupload' será usado para o comando de publicação. Se não for fornecido, o cli tentará encontrar o melhor candidato com base no argumento 'pathOrUrl'.
-id, --appId Especifica o ID do aplicativo. Necessário somente se o projeto não tiver sido inicializado antes com o comando "init".
-nc, --noCommit Desabilita a confirmação do envio, mantendo-o no estado de rascunho.
-f, --flightId Especifica a ID de Voo em que o pacote será publicado.
-prp, --packageRolloutPercentage Especifica a porcentagem de distribuição do pacote. O valor precisa estar entre 0 e 100.

Ambientes de CI/CD

A CLI do Desenvolvedor da Microsoft Store (versão prévia) dá suporte à execução em ambientes de CI/CD. Isso significa que você pode usar a CLI do Desenvolvedor da Microsoft Store (versão prévia) em seus pipelines de CI/CD para, por exemplo, publicar automaticamente seus aplicativos na Microsoft Store.

A primeira etapa para conseguir isso é instalar a CLI do desenvolvedor da Microsoft Store (versão prévia) em seu ambiente de CI/CD. Você pode encontrar instruções sobre como fazer isso aqui.

Depois de instalar a CLI do Desenvolvedor da Microsoft Store (versão prévia), você precisa configurar seu ambiente para poder executar comandos. Você pode fazer isso executando o msstore reconfigure comando com os parâmetros específicos que identificam sua conta do Partner Center (TenantId, SellerId, ClientId). Você também precisa fornecer um ClientSecret ou um Certificate.

É muito importante ocultar essas credenciais, pois elas ficarão visíveis nos logs do seu pipeline de CI/CD. Você pode fazer isso usando segredos. Cada sistema de pipeline de CI/CD tem nomes diferentes para esses segredos. Por exemplo, o Azure DevOps as chama de Variáveis Secretas, mas o GitHub Action as chama de Segredos Criptografados. Crie um segredo para cada um dos parâmetros (TenantId, SellerId, ClientId e ClientSecret ou um Certificado) e use o reconfigure comando para configurar seu ambiente.

Por exemplo:

Azure DevOps

- task: UseMSStoreCLI@0
  displayName: Setup Microsoft Store Developer CLI
- script: msstore reconfigure --tenantId $(PARTNER_CENTER_TENANT_ID) --sellerId $(PARTNER_CENTER_SELLER_ID) --clientId $(PARTNER_CENTER_CLIENT_ID) --clientSecret $(PARTNER_CENTER_CLIENT_SECRET)
  displayName: Configure Microsoft Store Developer CLI

GitHub Actions

- name: Setup Microsoft Store Developer CLI
  uses: microsoft/setup-msstore-cli@v1
- name: Configure Microsoft Store Developer CLI
  run: msstore reconfigure --tenantId ${{ secrets.PARTNER_CENTER_TENANT_ID }} --sellerId ${{ secrets.PARTNER_CENTER_SELLER_ID }} --clientId ${{ secrets.PARTNER_CENTER_CLIENT_ID }} --clientSecret ${{ secrets.PARTNER_CENTER_CLIENT_SECRET }}

Depois que esse comando for executado, a CLI do Desenvolvedor da Microsoft Store (versão prévia) será configurada para usar as credenciais fornecidas. Agora você pode usar a CLI do Desenvolvedor da Microsoft Store (versão prévia) em seu pipeline de CI/CD.