Publish from the command line
You can use the TFS Cross Platform Command Line Interface (tfx-cli) to publish your extension to the Visual Studio Marketplace.
See the overview of publish, install, and share for additional details.
Before you begin
Before you begin, you need to get the TFX CLI from Node Package Manager and generate a personal access token. Also, if you have not done so, you will need to set up a Publisher in the Gallery.
Acquire the TFS Cross Platform Command Line Interface
If you don't have it, download and install NodeJS. During Setup, ensure that you leave Add to PATH chosen.
Open a Command Prompt and type
npm i -g tfx-cli.
If you already have the TFX CLI installed, you can update to the latest release by running
npm up -g tfx-cli.
Acquire a personal access token
Sign in to your VSTS account (
From your home page, open your profile. Go to your security details.
Under Security, go to Personal access tokens, then choose Add.
Add a description for your token, then select an expiration timeframe for your token.
In the Accounts list, select All accessible accounts. This is required because the Visual Studio Marketplace publishing APIs work outside the context of an account.
Select the Marketplace (publish) scope. This will limit the token to only being able to publish extensions to the Visual Studio Marketplace.
Finish creating your token.
Copy your generated personal access token. Make sure to keep it secret.
Create a publisher
If you haven't already created a publisher, you can do so using the command line tool.
To create a publisher using the TFS Cross Platform Command Line Interface, simply run the following command, replacing each argument with the necessary value.
tfx extension publisher create
Publisher name must match the publisher property in your extension manifest.
C:\tfs-cli>tfx extension publisher create Copyright Microsoft Corporation > Publisher name: Fabrikam > Display name: Fabrikam, Inc. > Description: Fabrikam's main publisher === Completed operation: create publisher === - Name: Fabrikam - Display Name: Fabrikam, Inc. - Description: Fabrikam's main publisher
Publish from the command line
Once the TFX CLI is installed and you have your personal access token, you can use the tool to package and publish your extension.
- Open a command prompt to the root directory of your extension.
- Run the
tfx extension publishcommand passing in any necessary parameters. Run
tfx extension publish --helpto see all available options.
You may receive the following error when publishing if your extension has already been published:
Failed Request: Internal Server Error(500) - Version number must increase each time an extension is published. Extension: fabrikam.my-extension Current version: 0.1.9 Updated version: 0.1.9
You can add the
--rev-version command line option to automatically increment the patch version of your extension.
Note that this will also save the new version to your manifest.
C:\vso-team-calendar>tfx extension publish --share-with fabrikam --rev-version Copyright Microsoft Corporation > Personal access token: Checking if this extension is already published It is, update the extension Waiting for server to validate extension package... Sharing extension with fabrikam. === Completed operation: publish extension === - Packaging: C:\vso-team-calendar\fabrikam.team-calendar-0.2.6.vsix - Publishing: success - Sharing: shared with fabrikam