Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Installation
Step 1: Install .NET Windows Runtime
If you haven't done so already, install the latest version of the .NET 8 Desktop Runtime. This is a requirement to run the Microsoft Store Developer CLI.
The easiest way to install it is to use winget:
winget install Microsoft.DotNet.DesktopRuntime.8
Step 2: Install the Microsoft Store Developer CLI on Windows
You can download the Microsoft Store Developer CLI from the Microsoft Store. Alternatively, you can use winget:
winget install "Microsoft Store Developer CLI"
Step 1: Install .NET macOS Runtime
If you haven't done so already, install the latest version of the .NET 8 Runtime. This is a requirement to run the Microsoft Store Developer CLI.
Step 2: Install the Microsoft Store Developer CLI on macOS
You can download the macOS .tar.gz for your specific architecture (x64 or Arm64) from the Microsoft Store Developer CLI releases page. Once downloaded, extract the archive and put it in your PATH, however you want to do that, for example:
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
Alternatively, you can use brew:
brew install microsoft/msstore-cli/msstore-cli
Step 1: Install .NET Linux Runtime
If you haven't done so already, install the latest version of the .NET 8 Runtime. This is a requirement to run the Microsoft Store Developer CLI.
Step 2: Install the Microsoft Store Developer CLI on Linux
You can download the Linux .tar.gz for your specific architecture (x64 or Arm64) from the Microsoft Store Developer CLI releases page. Once downloaded, extract the archive and put it in your PATH, however you want to do that, for example:
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
Alternatively, you can use brew:
brew install microsoft/msstore-cli/msstore-cli
Info Command
Print existing configuration.
Usage
msstore info
Options
| Option | Description |
|---|---|
| -v, --verbose | Print verbose output. |
| -?, -h, --help | Show help and usage information. |
Reconfigure Command
Re-configure the Microsoft Store Developer CLI. You can provide either a Client Secret or a Certificate. Certificates can be provided either through its Thumbprint or by providing a file path (with or without a password).
Usage
msstore reconfigure
Options
| Option | Description |
|---|---|
| -t, --tenantId | Specify the tenant Id that should be used. |
| -s, --sellerId | Specify the seller Id that should be used. |
| -c, --clientId | Specify the client Id that should be used. |
| -cs, --clientSecret | Specify the client Secret that should be used. |
| -ct, --certificateThumbprint | Specify the certificate Thumbprint that should be used. |
| -cfp, --certificateFilePath | Specify the certificate file path that should be used. |
| -cp, --certificatePassword | Specify the certificate password that should be used. |
| --reset | Only reset the credentials, without starting over. |
| -v, --verbose | Print verbose output. |
| -?, -h, --help | Show help and usage information. |
Settings Command
Change settings of the Microsoft Store Developer CLI.
Usage
msstore settings
Options
| Option | Description |
|---|---|
| -t, --enableTelemetry | Enable (empty/true) or Disable (false) telemetry. |
| -v, --verbose | Print verbose output. |
| -?, -h, --help | Show help and usage information. |
SetPDN Sub-Command
Set the Publisher Display Name property.
Usage
msstore settings setpdn <publisherDisplayName>
Arguments
| Argument | Description |
|---|---|
publisherDisplayName |
The Publisher Display Name property that will be set globally. |
Options
| Option | Description |
|---|---|
| -?, -h, --help | Show help and usage information. |
Submission Command
| Sub-Command | Description |
|---|---|
| status | Gets the status of a submission. |
| get | Gets the metadata and package info of a specific submission. |
| getListingAssets | Gets the listing assets of a specific submission. |
| updateMetadata | Updates the metadata of a specific submission. |
| update | Updates the package info of a specific submission. |
| poll | Polls the status of a submission. |
| publish | Publishes a specific submission. |
Submission - Status - Usage
msstore submission status <productId>
Arguments
| Argument | Description |
|---|---|
productId |
The Partner center ID. |
Options
| Option | Description |
|---|---|
| -v, --verbose | Print verbose output. |
| -?, -h, --help | Show help and usage information. |
Submission - Get - Usage
msstore submission get <productId>
Arguments
| Argument | Description |
|---|---|
productId |
The Partner center ID. |
Options
| Option | Description |
|---|---|
| -l, --language | Select which language you want to retrieve. [default: en] |
| -v, --verbose | Print verbose output. |
| -?, -h, --help | Show help and usage information. |
Submission - GetListingAssets - Usage
msstore submission getListingAssets <productId>
Arguments
| Argument | Description |
|---|---|
productId |
The Partner center ID. |
Options
| Option | Description |
|---|---|
| -l, --language | Select which language you want to retrieve. [default: en] |
| -v, --verbose | Print verbose output. |
| -?, -h, --help | Show help and usage information. |
Submission - UpdateMetadata - Usage
msstore submission updateMetadata <productId> <metadata>
Arguments
| Argument | Description |
|---|---|
productId |
The Partner center ID. |
metadata |
The updated JSON metadata representation. |
Options
| Option | Description |
|---|---|
| -s, --skipInitialPolling | Skip the initial polling before executing the action. [default: False] |
| -v, --verbose | Print verbose output. |
| -?, -h, --help | Show help and usage information. |
Submission - Update - Usage
msstore submission update <productId> <package>
Arguments
| Argument | Description |
|---|---|
productId |
The Partner center ID. |
package |
The updated JSON representation of the app package. |
Options
| Option | Description |
|---|---|
| -s, --skipInitialPolling | Skip the initial polling before executing the action. [default: False] |
| -v, --verbose | Print verbose output. |
| -?, -h, --help | Show help and usage information. |
Submission - Poll - Usage
msstore submission poll <productId>
Arguments
| Argument | Description |
|---|---|
productId |
The Partner center ID. |
Options
| Option | Description |
|---|---|
| -v, --verbose | Print verbose output. |
| -?, -h, --help | Show help and usage information. |
Submission - Publish - Usage
msstore submission publish <productId>
Arguments
| Argument | Description |
|---|---|
productId |
The Partner center ID. |
Options
| Option | Description |
|---|---|
| -v, --verbose | Print verbose output. |
| -?, -h, --help | Show help and usage information. |
CI/CD Environments
The Microsoft Store Developer CLI (preview) supports running in CI/CD environments. This means that you can use the Microsoft Store Developer CLI (preview) in your CI/CD pipelines to, for example, automatically publish your applications to the Microsoft Store.
The firststep to achieve this it to install the Microsoft Store Developer CLI (preview) on your CI/CD environment. You can find instructions on how to do this here.
After installing the Microsoft Store Developer CLI (preview), you have to configure your environment to be able to run commands. You can do this by running the msstore reconfigure command with the specific parameters that identify your partner center account (TenantId, SellerId, ClientId). You also need to provide either a ClientSecret or a Certificate.
It is very important to hide these credentials, as they will be visible in the logs of your CI/CD pipeline. You can do this by using secrets. Each CI/CD pipeline system have different names for these secrets. For example, Azure DevOps call them Secret Variables, but GitHub Action calls them Encrypted Secrets. Create one secret for each of the parameters (TenantId, SellerId, ClientId, and ClientSecret or a Certificate), and then use the reconfigure command to setup your environment.
For example:
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/microsoft-store-apppublisher@v1.1
- 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 }}
Once this command is executed, the Microsoft Store Developer CLI (preview) will be configured to use the credentials provided. You can now use the Microsoft Store Developer CLI (preview) in your CI/CD pipeline.
Collaborate with us on GitHub
The source for this content can be found on GitHub, where you can also create and review issues and pull requests. For more information, see our contributor guide.
Windows developer