TFS Extensions Command Line Utility

This is a utility to manage extensions for TFS. It is cross platform and supported on Windows, OSX and Linux.

Pre-release but supported

Install

sudo npm install -g tfx-cli

_{Note: windows does not need sudo}

Help

Just type tfx. It will list the commands and sub commands available

~$ tfx

Login

To avoid providing credentials in every command, you can login once. Currently supported credential types are Personal Access Tokens and basic auth. Create a personal access token and paste it in the login command

~$ tfx login
Copyright Microsoft Corporation

Enter collection url > https://youraccount.visualstudio.com/DefaultCollection
Enter personal access token > 
logged in successfully

You can alternatively use basic auth by passing --authType basic (read Configuring Basic Auth). NTLM will come soon.

Command Documentation

Build Tasks: create, list, upload and delete your build tasks

App Extensions: manage your app extensions

Troubleshooting

To see detailed tracing output, you can set a value for the TFX_TRACE environment value and then run commands. That may offer a clue into the problem. It will certainly help if logging an issue.

_Linux/OSX

export TFX_TRACE=1

_Windows

set TFX_TRACE=1

_PowerShell

$env:TFX_TRACE=1

setting TFX_TRACE_CREDS=1 or TFX_TRACE_CACHE=1 will trace out cred storage. Typically those should not be set (to avoid leaking creds when sending traces). Only set if you are troubleshooting credentials.

Contributing

We take contributions and fixes. Read here for the details.