Microsoft Visual Studio Team Services CLI
VSTS CLI is currently in preview but we encourage you to give it a try and provide feedback (or contribute).
Refer to the install guide for detailed install instructions for Windows, Mac, and Linux.
Also refer to the "get started" guide for in-depth instructions including first-time setup steps.
For help, pass the
--help argument, for example:
vsts -h vsts code -h
Use the VSTS CLI to work with and manage build, code repositories, projects, work items, and more in your VSTS account or on-premises Team Foundation Server collection.
Here are just a few of the commands:
- vsts build queue
- vsts code pr create
- vsts code pr list
- vsts code pr complete
- vsts code pr reviewers add
- vsts code pr work-items list
- vsts project create
- vsts work item create
- vsts work item update
See the full list of available commands.
Login (setup credentials)
Create a personal access token and provide to the VSTS CLI via the login command:
vsts login --instance https://MYACCOUNT.visualstudio.com --token MYTOKEN
Using VSTS CLI Behind a Proxy
The VSTS CLI picks the network proxy configuration from the environment variables
Configure defaults, Git aliases, and more
You can change your default settings using the
vsts configure command, for example you can set the default output format for all commands. The options are:
- JSON (with color highlighting)
- Table (human-readable tabular output)
- TSV (tab and new line delimited)
You can also add aliases in Git for certain VSTS CLI commands. For example,
git pr list will be an alias for
vsts code pr list.
Querying and filtering output
You can use the
--query parameter and the JMESPath query syntax to customize your output, for example:
Result ------------------------------------------------------------- [Demos]\CLI Team [Demos]\Demo Team Fabrikam Fiber
Examples and snippets
For more usage examples, see the official VSTS CLI documentation.
To contribute or to just play with the CLI in your development environment, see developer setup
VSTS CLI MIT License Copyright (c) Microsoft Corporation. All rights reserved. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE
VSTS CLI collects usage data and sends it to Microsoft to help improve our products and services. Read our privacy statement to learn more.
To disable telemetry use the
vsts configure command.
If you encounter any bugs with the tool please report an issue on the VSTS Developer Community using the vsts-cli tag.
To find where to provide feedback from the CLI, run
This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.
When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.