Install the VSTS CLI

VSTS CLI is a command line interface for Visual Studio Team Services (VSTS) and Team Foundation Server (TFS). With the VSTS CLI, you can manage and work with resources including pull requests, work items, builds, and more.

For information about the latest release, see the release notes.

Install on Windows

Download and run the installer

Install on Linux

VSTS CLI has been verified on the following Linux distributions, but will likely work on other variations as well:

  • Ubuntu 17
  • Ubuntu 16
  • Debian 9
  • Debian 8
  • Alpine 3.6

To install:

  1. Ensure prerequisites are installed

    • Python 2 or 3
    • Other packages: libssl-dev, libffi-dev, and python-dev
  2. Run the install script

    curl -L https://aka.ms/install-vsts-cli | bash
    

Note

You will likely need to restart your shell for some changes to take effect. You can start a new shell instance by running exec -l $SHELL.

Install on macOS

  1. From a Terminal window run the install script:

    curl -L https://aka.ms/install-vsts-cli | bash
    

Note

You will likely need to restart your shell for some changes to take effect. You can start a new shell instance by running exec -l $SHELL.

Docker

VSTS CLI is also available as a Docker image. To start a new container:

docker pull microsoft/vsts-cli:0.1.0

docker run -it microsoft/vsts-cli:0.1.0

Uninstall on Windows

  1. From system settings, open Apps & features

  2. Find the Microsoft VSTS CLI in the list of installed apps

  3. Tap Uninstall

Uninstall on Linux and macOS

You need to manually remove the files the VSTS CLI install script placed on your machine and undo the change to your .bashrc or .bash_profile for VSTS CLI tab completion.

  1. Run vsts logout to remove any VSTS credentials that might be persisted.

  2. Delete the executable link (run which vsts to get the path to this file)

    rm root/bin/vsts
    
  3. Delete installed files

    rm -r <install location>/lib/vsts-cli   
    
  4. Delete the line for tab completion (contains "vsts.completion") from either ~/.bash_profile or ~/.bashrc

Update the CLI

Use the same method that you used to install it.

Report issues and feedback

If you have trouble installing, updating, or uninstaling the VSTS CLI, let us know by opening an issue.

Next steps