|
1 | 1 | --- |
2 | | -title: Learn about Azure DevOps command line interface extension |
| 2 | +title: Get Started with Azure DevOps CLI |
3 | 3 | titleSuffix: Azure DevOps |
4 | | -description: Use Azure DevOps extension command line interface |
| 4 | +description: Install the Azure DevOps extension command line interface. Learn how to sign on, configure defaults, access help, and open Azure DevOps services in a browser. |
5 | 5 | ms.topic: quickstart |
6 | 6 | ms.subservice: azure-devops-reference |
7 | 7 | ms.manager: mijacobs |
8 | 8 | ms.author: chcomley |
9 | 9 | author: chcomley |
10 | 10 | monikerRange: 'azure-devops' |
11 | | -ms.date: 08/17/2020 |
| 11 | +ms.date: 05/30/2025 |
| 12 | +#customer intent: As a project team member, I want to set up Azure DevOps CLI and understand how to access pipelines, boards, repos, and artifacts. |
12 | 13 | --- |
13 | 14 |
|
14 | | -# Get started with Azure DevOps CLI |
| 15 | +# Quickstart: Get started with Azure DevOps CLI |
15 | 16 |
|
16 | | -[!INCLUDE [version-eq-azure-devops](../includes/version-eq-azure-devops.md)] |
| 17 | +[!INCLUDE [version-eq-azure-devops](../includes/version-eq-azure-devops.md)] |
17 | 18 |
|
18 | | -With the Azure DevOps extension for Azure Command Line Interface (CLI), you can manage many Azure DevOps Services from the command line. CLI commands enable you to streamline your tasks with faster and flexible interactive canvas, bypassing user interface workflows. |
| 19 | +In this quickstart, you set up and start using the Azure DevOps extension for Azure Command Line Interface (CLI). With Azure CLI, you can manage many Azure DevOps Services from the command line. Azure CLI commands enable you to streamline your tasks with faster and flexible interactive canvas, bypassing user interface workflows. |
19 | 20 |
|
20 | 21 | > [!NOTE] |
21 | | -> The Azure DevOps Command Line Interface (CLI) is only available for use with Azure DevOps Services. The Azure DevOps extension for the Azure CLI does not support any version of Azure DevOps Server. |
| 22 | +> The Azure DevOps CLI is only available for use with Azure DevOps Services. The Azure DevOps extension for the Azure CLI doesn't support any version of Azure DevOps Server. |
22 | 23 |
|
23 | | -To start using the Azure DevOps extension for Azure CLI, perform the following steps: |
| 24 | +To start using the Azure DevOps extension for Azure CLI: |
24 | 25 |
|
25 | | -1. Install Azure CLI: Follow the instructions provided in [Install the Azure CLI](/cli/azure/install-azure-cli) to set up your Azure CLI environment. At a minimum, your Azure CLI version must be 2.10.1. You can use `az --version` to validate. |
| 26 | +1. Install Azure CLI. Follow the instructions in [Install the Azure CLI](/cli/azure/install-azure-cli) to set up your Azure CLI environment. At a minimum, your Azure CLI version must be 2.10.1. You can use the `az --version` command to validate. |
26 | 27 |
|
27 | | -2. Add the Azure DevOps extension: |
| 28 | +1. Add the Azure DevOps extension. |
28 | 29 |
|
29 | | - ``` |
30 | | - az extension add --name azure-devops |
31 | | - ``` |
| 30 | + ```azurecli |
| 31 | + az extension add --name azure-devops |
| 32 | + ``` |
32 | 33 |
|
33 | | - You can use `az extension list` or `az extension show --name azure-devops` to confirm the installation. |
| 34 | +1. To confirm the installation, run the command `az extension list` or `az extension show --name azure-devops`. |
34 | 35 |
|
35 | | -3. Sign in: Run `az login` to sign in. Note that we support only interactive or log in using user name and password with `az login`. To sign in using a Personal Access Token (PAT), see [Sign in via Azure DevOps Personal Access Token (PAT)](log-in-via-pat.md). |
| 36 | +1. To sign in, run the `az login` command. Azure CLI supports only interactive sign-in using user name and password with `az login`. To sign in using a Personal Access Token (PAT), see [Sign in via Azure DevOps PAT](log-in-via-pat.md). |
36 | 37 |
|
37 | | -> [!NOTE] |
38 | | -> The Azure DevOps extension does not currently support authenticating with [Managed Identities](../integrate/get-started/authentication/service-principal-managed-identity.md). |
| 38 | + > [!NOTE] |
| 39 | + > The Azure DevOps extension doesn't currently support authenticating by using [Managed Identities](../integrate/get-started/authentication/service-principal-managed-identity.md). |
39 | 40 |
|
40 | | -4. Configure defaults: We recommend you set the default configuration for your organization and project. Otherwise, you can set these within the individual commands themselves. |
| 41 | +1. We recommend that you set the default configuration for your organization and project. Otherwise, you can specify the values in the individual commands themselves. |
41 | 42 |
|
42 | | - ``` |
43 | | - az devops configure --defaults organization=https://dev.azure.com/contoso project=ContosoWebApp |
44 | | - ``` |
| 43 | + ```azurecli |
| 44 | + az devops configure --defaults organization=https://dev.azure.com/contoso project=ContosoWebApp |
| 45 | + ``` |
45 | 46 |
|
46 | | -## Command usage |
| 47 | +## Use commands |
47 | 48 |
|
48 | 49 | Adding the Azure DevOps Extension adds `devops`, `pipelines`, `artifacts`, `boards`, and `repos` groups. |
49 | | -For usage and help content for any command, enter the **-h** parameter, for example: |
| 50 | + |
| 51 | +For usage and help content for any command, specify the `--help` parameter, for example: |
50 | 52 |
|
51 | 53 | ```azurecli |
52 | | -az devops -h |
| 54 | +az devops --help |
53 | 55 | ``` |
54 | 56 |
|
55 | 57 | ```output |
@@ -83,19 +85,17 @@ Commands: |
83 | 85 |
|
84 | 86 | ## Open items in browser |
85 | 87 |
|
86 | | -You can use `--open` switch to open any artifact in Azure DevOps portal in your default browser. |
87 | | - |
88 | | -For example : |
| 88 | +You can use `--open` parameter to open any artifact in Azure DevOps portal in your default browser. |
89 | 89 |
|
90 | 90 | ```azurecli |
91 | 91 | az pipelines build show --id 1 --open |
92 | 92 | ``` |
93 | 93 |
|
94 | | -This command shows the details of build with `id 1` on the command-line and also opens it in the default browser. |
| 94 | +This command shows the details of the build with `--id 1` in the Command Prompt window and also opens it in the default browser. |
95 | 95 |
|
96 | 96 | ## Related articles |
97 | 97 |
|
98 | | -- [Sign in via Azure DevOps Personal Access Token (PAT)](log-in-via-pat.md) |
99 | | -- [Output formats](/cli/azure/format-output-azure-cli) |
100 | | -- [Index to az devops examples](quick-reference.md) |
| 98 | +- [Sign in via Azure DevOps personal access token](log-in-via-pat.md) |
| 99 | +- [Output formats for Azure CLI commands](/cli/azure/format-output-azure-cli) |
| 100 | +- [Index to az devops CLI examples](quick-reference.md) |
101 | 101 | - [Azure DevOps CLI Extension GitHub Repo](https://github.com/Azure/azure-devops-cli-extension) |
0 commit comments