Get started with Azure DevOps CLI
Azure DevOps Services
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.
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.
To start using the Azure DevOps extension for Azure CLI, perform the following steps:
Install Azure CLI: Follow the instructions provided in Install the 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 --versionto validate.
Add the Azure DevOps extension:
az extension add --name azure-devops
You can use
az extension listor
az extension show --name azure-devopsto confirm the installation.
Sign in: Run
az loginto 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).
Configure defaults: We recommend you set the default configuration for your organization and project. Otherwise, you can set these within the individual commands themselves.
az devops configure --defaults organization=https://dev.azure.com/contoso project=ContosoWebApp
Adding the Azure DevOps Extension adds
For usage and help content for any command, enter the -h parameter, for example:
$ az devops -h
Group az devops : Manage Azure DevOps organization level operations. Related Groups az pipelines: Manage Azure Pipelines az boards: Manage Azure Boards az repos: Manage Azure Repos az artifacts: Manage Azure Artifacts. Subgroups: admin : Manage administration operations. extension : Manage extensions. project : Manage team projects. security : Manage security related operations. service-endpoint : Manage service endpoints/service connections. team : Manage teams. user : Manage users. wiki : Manage wikis. Commands: configure : Configure the Azure DevOps CLI or view your configuration. feedback : Displays information on how to provide feedback to the Azure DevOps CLI team. invoke : This command will invoke request for any DevOps area and resource. Please use only json output as the response of this command is not fixed. Helpful docs - https://learn.microsoft.com/rest/api/azure/devops/. login : Set the credential (PAT) to use for a particular organization. logout : Clear the credential for all or a particular organization.
Open items in browser
You can use
--open switch to open any artifact in Azure DevOps portal in your default browser.
For example :
az pipelines build show --id 1 --open
This command shows the details of build with
id 1 on the command-line and also opens it in the default browser.