azure-devops-cli

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Azure DevOps CLI Setup (macOS)

Azure DevOps CLI 环境搭建(macOS)

Install Azure CLI via Homebrew, add the Azure DevOps extension, log in, configure defaults, and verify the full setup with a sanity check. macOS only.
Announce at start: "I'm using the azure-devops-cli skill to set up Azure DevOps CLI tools."
通过Homebrew安装Azure CLI,添加Azure DevOps扩展,完成登录、默认配置,并通过完整性检查验证整个设置。仅适用于macOS。
开始时提示: "我将使用azure-devops-cli技能来搭建Azure DevOps CLI工具。"

Prerequisites — macOS Guard

前置条件 — macOS 校验

Before anything else, confirm the OS is macOS:
bash
if [ "$(uname -s)" != "Darwin" ]; then
  echo "ERROR: This skill is macOS-only. Detected OS: $(uname -s)" >&2
  exit 1
fi
If not macOS, stop and inform the user this skill only supports macOS with Homebrew.

在开始操作前,先确认当前系统为macOS:
bash
if [ "$(uname -s)" != "Darwin" ]; then
  echo "ERROR: This skill is macOS-only. Detected OS: $(uname -s)" >&2
  exit 1
fi
如果不是macOS系统,停止操作并告知用户本技能仅支持带有Homebrew的macOS系统。

Step 1 — Homebrew

步骤1 — 安装Homebrew

Check if Homebrew is installed:
bash
command -v brew
If missing, install it:
bash
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
After install, ensure
brew
is on PATH by evaluating the shellenv:
bash
eval "$(/opt/homebrew/bin/brew shellenv)"

检查Homebrew是否已安装:
bash
command -v brew
如果未安装,执行以下命令安装:
bash
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
安装完成后,通过执行shellenv确保
brew
已添加到PATH中:
bash
eval "$(/opt/homebrew/bin/brew shellenv)"

Step 2 — Install Azure CLI

步骤2 — 安装Azure CLI

Check if
az
is already installed:
bash
az --version 2>/dev/null
If not installed, run:
bash
brew update && brew install azure-cli
If already installed, skip and move on.

检查
az
是否已安装:
bash
az --version 2>/dev/null
如果未安装,执行以下命令:
bash
brew update && brew install azure-cli
如果已安装,跳过此步骤直接进入下一步。

Step 3 — Install Azure DevOps Extension

步骤3 — 安装Azure DevOps扩展

Check if the extension is present:
bash
az extension show --name azure-devops 2>/dev/null
If not present, install it:
bash
az extension add --name azure-devops

检查Azure DevOps扩展是否已安装:
bash
az extension show --name azure-devops 2>/dev/null
如果未安装,执行以下命令添加扩展:
bash
az extension add --name azure-devops

Step 4 — Login

步骤4 — 登录Azure

Check if the user is already logged in:
bash
az account show 2>/dev/null
If not logged in (command fails), run interactive login:
bash
az login
This opens a browser window for authentication. Wait for the user to complete the flow.
After login, display the active subscription:
bash
az account show --query "{Subscription:name, TenantId:tenantId}" -o table

检查用户是否已登录:
bash
az account show 2>/dev/null
如果未登录(命令执行失败),执行交互式登录:
bash
az login
此命令会打开浏览器窗口进行身份验证。等待用户完成验证流程。
登录完成后,显示当前激活的订阅信息:
bash
az account show --query "{Subscription:name, TenantId:tenantId}" -o table

Step 5 — Configure Defaults

步骤5 — 配置默认项

Ask the user for their Azure DevOps organization URL and project name:
What is your Azure DevOps organization URL?
(e.g. https://dev.azure.com/my-org)
What is your default project name?
(e.g. my-project)
Then configure:
bash
az devops configure --defaults organization=<ORG_URL> project=<PROJECT_NAME>
Verify the defaults were saved:
bash
az devops configure --list

询问用户Azure DevOps组织URL和项目名称:
请输入你的Azure DevOps组织URL?
(示例:https://dev.azure.com/my-org)
请输入你的默认项目名称?
(示例:my-project)
然后执行配置命令:
bash
az devops configure --defaults organization=<ORG_URL> project=<PROJECT_NAME>
验证默认配置是否已保存:
bash
az devops configure --list

Step 6 — Sanity Check

步骤6 — 完整性检查

Run all checks and collect pass/fail results. Present as a summary table.
bash
echo "=== Azure DevOps CLI Sanity Check ==="
运行所有检查并收集通过/失败结果,以汇总表格形式展示。
bash
echo "=== Azure DevOps CLI 完整性检查 ==="

1. CLI installed

1. CLI 是否已安装

echo -n "az CLI installed ........... " az --version >/dev/null 2>&1 && echo "PASS" || echo "FAIL"
echo -n "az CLI 已安装 ........... " az --version >/dev/null 2>&1 && echo "通过" || echo "失败"

2. DevOps extension

2. DevOps 扩展是否存在

echo -n "azure-devops extension ..... " az extension show --name azure-devops >/dev/null 2>&1 && echo "PASS" || echo "FAIL"
echo -n "azure-devops 扩展 ..... " az extension show --name azure-devops >/dev/null 2>&1 && echo "通过" || echo "失败"

3. Logged in

3. 是否已登录

echo -n "Logged in .................. " az account show >/dev/null 2>&1 && echo "PASS" || echo "FAIL"
echo -n "已登录 .................. " az account show >/dev/null 2>&1 && echo "通过" || echo "失败"

4. Defaults configured

4. 默认项是否已配置

echo -n "Defaults configured ........ " az devops configure --list 2>/dev/null | grep -q "organization" && echo "PASS" || echo "FAIL"
echo -n "默认项已配置 ........ " az devops configure --list 2>/dev/null | grep -q "organization" && echo "通过" || echo "失败"

5. End-to-end connectivity

5. 端到端连通性

echo -n "DevOps connectivity ........ " az devops project list --top 1 >/dev/null 2>&1 && echo "PASS" || echo "FAIL"
echo "======================================"
undefined
echo -n "DevOps 连通性 ........ " az devops project list --top 1 >/dev/null 2>&1 && echo "通过" || echo "失败"
echo "======================================"
undefined

Troubleshooting Failures

故障排查

CheckFix
az CLI installedRun
brew install azure-cli
azure-devops extensionRun
az extension add --name azure-devops
Logged inRun
az login
Defaults configuredRun
az devops configure --defaults organization=<URL> project=<NAME>
DevOps connectivityVerify org URL is correct and you have network access
If any check fails, re-run the corresponding step above, then re-run the sanity check.

检查项修复方法
az CLI 已安装执行
brew install azure-cli
azure-devops 扩展执行
az extension add --name azure-devops
已登录执行
az login
默认项已配置执行
az devops configure --defaults organization=<URL> project=<NAME>
DevOps 连通性验证组织URL是否正确,以及是否有网络访问权限
如果任何检查项失败,重新执行对应的步骤,然后再次运行完整性检查。

Quick Reference

快速参考

TaskCommand
List projects
az devops project list
List repos
az repos list
Create a repo
az repos create --name <name>
List pipelines
az pipelines list
Trigger a pipeline run
az pipelines run --name <name>
List work items (query)
az boards query --wiql "SELECT ... FROM WorkItems"
Create a work item
az boards work-item create --type Task --title "<title>"
List PRs
az repos pr list
Create a PR
az repos pr create --title "<title>" --source-branch <branch>
Show current defaults
az devops configure --list
Switch organization
az devops configure --defaults organization=<URL>
Switch project
az devops configure --defaults project=<NAME>
任务命令
列出项目
az devops project list
列出代码仓库
az repos list
创建代码仓库
az repos create --name <name>
列出流水线
az pipelines list
触发流水线运行
az pipelines run --name <name>
查询工作项
az boards query --wiql "SELECT ... FROM WorkItems"
创建工作项
az boards work-item create --type Task --title "<title>"
列出拉取请求
az repos pr list
创建拉取请求
az repos pr create --title "<title>" --source-branch <branch>
查看当前默认配置
az devops configure --list
切换组织
az devops configure --defaults organization=<URL>
切换项目
az devops configure --defaults project=<NAME>