共用方式為

使用 CLI 管理 Wiki

  • 發行項

Azure DevOps Services

瞭解下列用於管理Wiki的 CLI 命令。

注意

您無法使用 CLI 刪除專案 Wiki。

先決條件

類別 要求
專案存取 Wiki所在的項目成員。 如果您沒有存取權，請向專案管理員要求它。
許可權 身為 貢獻者 群組的成員。
存取層級 至少 基本 存取權。

命令

命令 描述
az devops wiki create（創建維基頁面） 建立Wiki。
az devops wiki delete 刪除維基。
az devops wiki list 列出專案或組織中的所有Wiki。
az DevOps wiki 頁面 管理Wiki頁面。
az devops wiki page create（用於建立一個新的Wiki頁面） 新增頁面。
az DevOps 維基頁面刪除 刪除頁面。
az devops wiki 頁面顯示 取得頁面的內容或開啟頁面。
az devops 維基頁面更新 編輯頁面。
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：選擇性。 項目的名稱或識別碼。 使用 az devops configure -d project=NAME_OR_ID設定預設專案。 如果未設定為預設，或未透過 git config 自動取得，則為必要。
  • --repository -r：[適用於 codewiki 類型的必要項目] 用於發布維基的存放庫名稱或ID。
  • --subscription：選擇性。 訂用帳戶的名稱或標識碼。 使用 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，請輸入 az devops wiki delete 命令。

注意

您只能使用此命令來刪除程式碼 Wiki，而不是刪除專案 Wiki。

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

參數

  • --wiki：必要。 要刪除之Wiki的名稱或標識碼。
  • --project -p：選擇性。 項目的名稱或識別碼。 您可以使用 az devops configure -d project=NAME_OR_ID來設定預設專案。 如果未設定為預設值，或未透過 git config 自動獲取，則為必要的。
  • --subscription：選擇性。 訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。
  • --yes -y：選擇性。 請勿提示確認。

例

刪除此Wiki，且不會提示確認。

az devops wiki delete --wiki myprojectwiki --yes

列出維基

若要列出專案或組織中的所有Wiki，請輸入 az devops wiki list 命令。

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

選擇性參數

  • --project -p：選擇性。 項目的名稱或識別碼。
  • --scope：選擇性。 列出專案或組織層級的Wiki。 接受的值：organization、project。 預設值：project。
  • --subscription：選擇性。 訂用帳戶的名稱或標識碼。 您可以使用 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 的名稱或識別碼。
  • --open：選擇性。 在網頁瀏覽器中開啟Wiki頁面。
  • --project -p：選擇性。 項目的名稱或識別碼。
  • --subscription：選擇性。 訂用帳戶的名稱或標識碼。 使用 az account set -s NAME_OR_ID設定預設訂用帳戶。

例

顯示名為 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 的名稱或識別碼。
  • --comment：選擇性。 檔案添加操作提交訊息中的註解。 預設值：added a new page using Azure DevOps CLI。
  • --content：選擇性。 Wiki 頁面的內容。 如果指定 --file-path，則會忽略 。
  • --encoding：選擇性。 檔案的編碼方式。 與 --file-path 參數搭配使用。
  • --file-path：選擇性。 檔案中若指定了內容，則需提供檔案的輸入路徑。
  • --project -p：選擇性。 項目的名稱或識別碼。
  • --subscription：訂閱的名稱或標識符。 您可以使用 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