You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Command utility for interacting with Microsoft Team Foundation Server and Azure DevOps Services (formerly VSTS). It is cross platform and supported on Windows, OS X, and Linux.
7
+
This is a command-line utility for interacting with _Microsoft Team Foundation Server_ and _Azure DevOps Services_ (formerly _VSTS_). It is cross platform and supported on _Windows_, _MacOS_, and _Linux_.
8
8
9
9
## Setup
10
10
11
-
First, download and install [Node.js](http://nodejs.org) 4.0.x or later and NPM (included with the installer)
11
+
First, download and install [Node.js](http://nodejs.org) 4.0.x or later and npm (included with the installer)
12
12
13
13
### Linux/OSX
14
+
14
15
```bash
15
16
sudo npm install -g tfx-cli
16
17
```
17
18
18
19
### Windows
20
+
19
21
```bash
20
22
npm install -g tfx-cli
21
23
```
22
24
23
25
## Commands
24
26
25
-
To see a list of commands:
26
-
```
27
+
To see the list of commands:
28
+
29
+
```bash
27
30
tfx
28
31
```
29
32
30
33
For help with an individual command:
31
-
```
34
+
35
+
```bash
32
36
tfx <command> --help
33
37
```
34
38
35
39
> Help info is dynamically generated, so it should always be the most up-to-date authority.
36
40
37
41
### Command sets
38
42
39
-
*`tfx build` ([builds](docs/builds.md)): Queue, view, and get details for builds
*`tfx workitem` ([work items](docs/workitems.md)): Create, query and view work items.
43
47
44
48
### Login
45
49
46
-
To avoid providing credentials with every command, you can login once. Currently supported credential types: Personal Access Tokens and basic auth credentials.
50
+
To avoid providing credentials with every command, you can login once. Currently supported credential types: _Personal Access Tokens_ and _basic authentication credentials_.
47
51
48
52
> NTLM support is under consideration
49
-
53
+
>
50
54
> Warning! Using this feature will store your login credentials on disk in plain text.
51
-
52
-
> To skip certificate validation connecting to On-Prem Azure DevOps Server you can use parameter`--skip-cert-validation`
55
+
>
56
+
> To skip certificate validation connecting to on-prem _Azure DevOps Server_use the`--skip-cert-validation` parameter.
53
57
54
58
#### Personal access token
55
59
56
-
Start by [creating a personal access token](http://roadtoalm.com/2015/07/22/using-personal-access-tokens-to-access-visual-studio-online) and paste it into the login command.
60
+
Start by [creating a Personal Access Token](http://roadtoalm.com/2015/07/22/using-personal-access-tokens-to-access-visual-studio-online) and paste it into the login command.
You can alternatively use basic auth by passing `--auth-type basic` (see [Configuring Basic Auth](docs/configureBasicAuth.md)).
78
+
You can also use basic authentication by passing the `--auth-type basic`parameter (see [Configuring Basic Auth](docs/configureBasicAuth.md) for details).
75
79
76
80
### Settings cache
77
81
78
-
To avoid providing other options in every command, you can save options out to a settings file by adding the `--save` flag.
82
+
To avoid providing options with every command, you can save them to a settings file by adding the `--save` flag.
If you used `--save` to set a default value for an option, you may need to override it by explicitly providing the option with a different value. You can clear any saved settings by running `tfx reset`.
107
+
If you used `--save` to set a default value for an option, you may need to override it by explicitly providing a different value. You can clear any saved settings by running `tfx reset`.
104
108
105
109
### Troubleshooting
106
110
107
-
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 (and will certainly help if logging an issue).
111
+
To see detailed tracing output, set a value for the `TFX_TRACE` environment variable and then run commands. This may provide clues to the issue and can be helpful when logging an issue.
112
+
113
+
### Troubleshooting on Linux/OSX
108
114
109
-
### Linux/OSX
110
115
```bash
111
116
export TFX_TRACE=1
112
117
```
113
118
114
-
### Windows
119
+
### Troubleshooting on Windows
120
+
115
121
```bash
116
122
set TFX_TRACE=1
117
123
```
118
124
119
-
### PowerShell
125
+
#### PowerShell
126
+
120
127
```bash
121
128
$env:TFX_TRACE=1
122
129
```
123
130
124
131
## Contributing
125
132
126
-
We take contributions and fixes via Pull Request. [Read here](docs/contributions.md) for the details.
133
+
We accept contributions and fixes via Pull Requests. Please read the [Contributions guide](docs/contributions.md) for more details.
0 commit comments