Hantera wikis med CLI

Azure DevOps Services

Lär dig följande CLI-kommandon för att hantera wikis.

Kommentar

Du kan inte ta bort projekt-wikis med CLI.

Kommandon

Kommandon	description
az devops wiki create	Skapa en wiki.
az devops wiki delete	Ta bort en wiki.
az devops wiki list	Visa en lista över alla wikis i ett projekt eller en organisation.
az devops wiki-sida	Hantera wiki-sidor.
az devops wiki page create	Lägg till en ny sida.
az devops wiki page delete	Ta bort en sida.
az devops wiki page show	Hämta innehållet på en sida eller öppna en sida.
az devops wiki page update	Redigera en sida.
az devops wiki show	Visa information om en wiki.

Skapa en wiki

Om du vill skapa en wiki anger du az devops wiki create kommandot .

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

Valfria parametrar

• --mapped-path: [Krävs för codewiki typ] Mappad sökväg för den nya wikin, till exempel / för att publicera från roten på lagringsplatsen.
• --name: Namnet på den nya wikin.
• --project -p: Valfritt. Projektets namn eller ID. Konfigurera standardprojektet med .az devops configure -d project=NAME_OR_ID Krävs om det inte har konfigurerats som standard eller hämtats via git-konfiguration.
• --repository -r: [Krävs för typ] Namn eller ID för codewiki lagringsplatsen för att publicera wikin från.
• --subscription: Valfritt. Namn eller ID för prenumerationen. Konfigurera standardprenumerationen med .az account set -s NAME_OR_ID
• --type --wiki-type: Typ av wiki som ska skapas. Godkända värden: codewiki, projectwiki. Standardvärde: projectwiki.

Exempel

Skapa en namngiven projekt-wiki.

az devops wiki create --name myprojectwiki

Skapa en kod-wiki från en mapp på en kodlagringsplats.

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

Ta bort en wiki

Om du vill ta bort en wiki anger du az devops wiki delete kommandot .

Kommentar

Du kan bara använda det här kommandot för att ta bort en kod-wiki, inte för att ta bort en projekt-wiki.

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

Parametrar

• --wiki: Krävs. Namn eller ID för wikin som ska tas bort.
• --project -p: Valfritt. Projektets namn eller ID. Du kan konfigurera standardprojektet med .az devops configure -d project=NAME_OR_ID Krävs om det inte har konfigurerats som standard eller hämtats via git-konfiguration.
• --subscription: Valfritt. Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID
• --yes -y: Valfritt. Fråga inte efter bekräftelse.

Exempel

Ta bort en wiki utan att fråga efter bekräftelse.

az devops wiki delete --wiki myprojectwiki --yes

Lista wikis

Ange kommandot om du vill visa en lista över alla wikis i ett projekt eller en organisation az devops wiki list .

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

Valfria parametrar

• --project -p: Valfritt. Projektets namn eller ID.
• --scope: Valfritt. Lista wikis på projekt- eller organisationsnivå. Godkända värden: organization, project. Standardvärde: project.
• --subscription: Valfritt. Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

Exempel

Visa en lista över alla wikis för ett projekt.

az devops wiki list

Visa en lista över alla wikis i organisationen.

az devops wiki list --scope organization

Visa wiki

Om du vill visa information om en wiki anger du az devops wiki show kommandot .

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

Parametrar

• --wiki: Krävs. Namn eller ID för wikin.
• --open: Valfritt. Öppna wiki-sidan i webbläsaren.
• --project -p: Valfritt. Projektets namn eller ID.
• --subscription: Valfritt. Namn eller ID för prenumerationen. Konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

Exempel

Visa wikin med namnet myprojectwiki och öppna wiki-sidan i webbläsaren.

az devops wiki show --wiki myprojectwiki --open

Skapa en wiki-sida

Om du vill lägga till en ny wiki-sida anger du az devops wiki page create kommandot .

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

Parametrar

• --path: Krävs. Sökväg till wiki-sidan.
• --wiki: Krävs. Namn eller ID för wikin.
• --comment: Valfritt. Kommentera i incheckningsmeddelandet för filtilläggsåtgärden. Standardvärde: added a new page using Azure DevOps CLI.
• --content: Valfritt. Innehållet på wiki-sidan. Ignoreras om --file-path har angetts.
• --encoding: Valfritt. Kodning av filen. Används med --file-path parameter.
• --file-path: Valfritt. Sökväg till filindata om innehåll anges i filen.
• --project -p: Valfritt. Projektets namn eller ID.
• --subscription: namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

Exempel

Skapa en ny sida med sökvägen my page i en wiki med namnet myprojectwiki med infogat innehåll.

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

Skapa en ny sida med sökvägen "min sida" i en wiki med namnet "myprojectwiki" med innehåll från en fil.

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