使用 CLI 管理 Wiki

  • 项目

Azure DevOps Services

了解以下用于管理 wiki 的 CLI 命令。

注意

无法使用 CLI 删除项目 Wiki。

命令

命令 description
az devops wiki create 创建 Wiki。
az devops wiki delete 删除 Wiki。
az devops wiki list 列出项目或组织中的所有 Wiki。
az devops wiki page 管理 Wiki 页面。
az devops wiki page create 添加新页面。
az devops wiki page delete 删除页面。
az devops wiki page show 获取页面的内容或打开页面。
az devops wiki page update 编辑 页面。
az devops wiki show 显示 Wiki 的详细信息。

创建 Wiki

若要创建 Wiki，请输入 az devops wiki create 命令。

az devops wiki create [--mapped-path]
                      [--name]
                      [--project]
                      [--repository]
                      [--subscription]
                      [--type {codewiki, projectwiki}]

可选参数

  • --mapped-path：[类型必需 codewiki ] 新 Wiki 的映射路径，例如， / 从存储库根目录发布。
  • --name：新 Wiki 的名称。
  • --project -p：可选。 项目的名称或 ID。 使用 az devops configure -d project=NAME_OR_ID 配置默认项目。 如果未配置为默认或通过 git 配置进行选取，则为必需。
  • --repository -r： [类型必需 codewiki ] 要从中发布 Wiki 的存储库的名称或 ID。
  • --subscription：可选。 订阅的名称或 ID。 使用 az account set -s NAME_OR_ID. 配置默认订阅。
  • --type --wiki-type：要创建的 wiki 的类型。 接受的值：codewiki、projectwiki。 默认值：projectwiki。

示例

创建命名项目 Wiki。

az devops wiki create --name myprojectwiki

从代码存储库中的文件夹创建代码 Wiki。

az devops wiki create --name WIKI_NAME --type codewiki
--repository REPO_NAME --mapped-path PATH_TO_PUBLISH

删除 Wiki

若要删除 Wiki，请输入 az devops wiki delete 命令。

注意

只能使用此命令删除代码 Wiki，而不能删除项目 Wiki。

az devops wiki delete 
                      [--wiki]
                      [--project]
                      [--subscription]
                      [--yes]

参数

  • --wiki：必需。 要删除的 Wiki 的名称或 ID。
  • --project -p：可选。 项目的名称或 ID。 可以使用 az devops configure -d project=NAME_OR_ID 配置默认项目。 如果未配置为默认或通过 git 配置进行选取，则为必需。
  • --subscription：可选。 订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。
  • --yes -y：可选。 不提示确认。

示例

在不提示确认的情况下删除 Wiki。

az devops wiki delete --wiki myprojectwiki --yes

列出 Wiki

若要列出项目或组织中的所有 Wiki，请输入 az devops wiki list 命令。

az devops wiki list 
                    [--project]
                    [--scope {organization, project}]
                    [--subscription]

可选参数

  • --project -p：可选。 项目的名称或 ID。
  • --scope：可选。 列出项目或组织级别的 Wiki。 接受的值：organization、project。 默认值：project。
  • --subscription：可选。 订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

示例

列出项目的所有 Wiki。

az devops wiki list

列出组织中的所有 Wiki。

az devops wiki list --scope organization

显示 Wiki

若要显示 Wiki 的详细信息，请输入 az devops wiki show 命令。

az devops wiki show --wiki
                    [--open]
                    [--project]
                    [--subscription]

参数

  • --wiki：必需。 Wiki 的名称或 ID。
  • --open：可选。 在 Web 浏览器中打开 Wiki 页面。
  • --project -p：可选。 项目的名称或 ID。
  • --subscription：可选。 订阅的名称或 ID。 使用 az account set -s NAME_OR_ID. 配置默认订阅。

示例

在 Web 浏览器中显示命名 myprojectwiki 的 Wiki 并打开 Wiki 页面。

az devops wiki show --wiki myprojectwiki --open

创建 Wiki 页面

若要添加新的 Wiki 页面，请输入 az devops wiki page create 命令。

az devops wiki page create --path
                           --wiki
                           [--comment]
                           [--content]
                           [--encoding {ascii, utf-16be, utf-16le, utf-8}]
                           [--file-path]
                           [--project]
                           [--subscription]

参数

  • --path：必需。 Wiki 页面的路径。
  • --wiki：必需。 Wiki 的名称或 ID。
  • --comment：可选。 文件添加操作提交消息中的注释。 默认值：added a new page using Azure DevOps CLI。
  • --content：可选。 Wiki 页面的内容。 如果 --file-path 指定，则忽略。
  • --encoding：可选。 文件的编码。 与参数一起使用 --file-path 。
  • --file-path：可选。 如果在文件中指定了内容，则文件输入的路径。
  • --project -p：可选。 项目的名称或 ID。
  • --subscription：订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

示例

使用内联内容命名myprojectwiki的 Wiki 中创建路径的新页面my page。

az devops wiki page create --path 'my page' --wiki myprojectwiki --content "Hello World"

使用文件中的内容在名为“myprojectwiki”的 Wiki 中创建路径为“my page”的新页面。

az devops wiki page create --path 'my page' --wiki myprojectwiki --file-path a.txt --encoding utf-8