az devops wiki

Note

This reference is part of the azure-devops extension for Azure CLI and requires version 2.2.0 or higher. The extension will automatically install the first time you run an az devops wiki command. Learn more about extensions.

Manage wikis.

Commands

az devops wiki create

Create a wiki.

az devops wiki delete

Delete a wiki.

az devops wiki list

List all the wikis in a project or organization.

az devops wiki page

Manage wiki pages.

az devops wiki page create

Add a new page.

az devops wiki page delete

Delete a page.

az devops wiki page show

Get the content of a page or open a page.

az devops wiki page update

Edit a page.

az devops wiki show

Show details of a wiki.

az devops wiki create

Create a wiki.

az devops wiki create [--detect {false, true}]
                      [--mapped-path]
                      [--name]
                      [--org]
                      [--project]
                      [--repository]
                      [--type {codewiki, projectwiki}]
                      [--version]

Examples

Create a project wiki

az devops wiki create --name myprojectwiki

Create a code wiki from a folder in a code repository

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

Optional Parameters

--detect

Automatically detect organization.

accepted values: false, true
--mapped-path

[Required for codewiki type] Mapped path of the new wiki e.g. '/' to publish from root of repository.

--name

Name of the new wiki.

--org --organization

Azure DevOps organization URL. You can configure the default organization using az devops configure -d organization=ORG_URL. Required if not configured as default or picked up via git config. Example: https://dev.azure.com/MyOrganizationName/.

--project -p

Name or ID of the project. You can configure the default project using az devops configure -d project=NAME_OR_ID. Required if not configured as default or picked up via git config.

--repository -r

[Required for codewiki type] Name or ID of the repository to publish the wiki from.

--type --wiki-type

Type of wiki to create.

accepted values: codewiki, projectwiki
default value: projectwiki
--version -v

[Required for codewiki type] Repository branch name to publish the code wiki from.

az devops wiki delete

Delete a wiki.

az devops wiki delete --wiki
                      [--detect {false, true}]
                      [--org]
                      [--project]
                      [--yes]

Required Parameters

--wiki

Name or Id of the wiki to delete.

Optional Parameters

--detect

Automatically detect organization.

accepted values: false, true
--org --organization

Azure DevOps organization URL. You can configure the default organization using az devops configure -d organization=ORG_URL. Required if not configured as default or picked up via git config. Example: https://dev.azure.com/MyOrganizationName/.

--project -p

Name or ID of the project. You can configure the default project using az devops configure -d project=NAME_OR_ID. Required if not configured as default or picked up via git config.

--yes -y

Do not prompt for confirmation.

az devops wiki list

List all the wikis in a project or organization.

az devops wiki list [--detect {false, true}]
                    [--org]
                    [--project]
                    [--scope {organization, project}]

Examples

List all wikis for a project

az devops wiki list

List all wikis in the organization

az devops wiki list --scope organization

Optional Parameters

--detect

Automatically detect organization.

accepted values: false, true
--org --organization

Azure DevOps organization URL. You can configure the default organization using az devops configure -d organization=ORG_URL. Required if not configured as default or picked up via git config. Example: https://dev.azure.com/MyOrganizationName/.

--project -p

Name or ID of the project. You can configure the default project using az devops configure -d project=NAME_OR_ID. Required if not configured as default or picked up via git config.

--scope

List the wikis at project or organization level.

accepted values: organization, project
default value: project

az devops wiki show

Show details of a wiki.

az devops wiki show --wiki
                    [--detect {false, true}]
                    [--open]
                    [--org]
                    [--project]

Required Parameters

--wiki

Name or Id of the wiki.

Optional Parameters

--detect

Automatically detect organization.

accepted values: false, true
--open

Open the wiki in your web browser.

--org --organization

Azure DevOps organization URL. You can configure the default organization using az devops configure -d organization=ORG_URL. Required if not configured as default or picked up via git config. Example: https://dev.azure.com/MyOrganizationName/.

--project -p

Name or ID of the project. You can configure the default project using az devops configure -d project=NAME_OR_ID. Required if not configured as default or picked up via git config.