Skip to main content

Add-VSTeamWiki

SYNOPSIS​

Publish a project or code wiki in the project provided

SYNTAX​

projectWiki (Default)​

Add-VSTeamWiki -Name <String> -ProjectName <String> [<CommonParameters>]

codeWiki​

Add-VSTeamWiki -Name <String> -RepositoryId <String> -Branch <String> -MappedPath <String>
 -ProjectName <String> [<CommonParameters>]

DESCRIPTION​

Publish a code or project wiki in to the selected repo

You must call Set-VSTeamAccount before calling this function.

EXAMPLES​

Example 1​

Add-VSTeamWiki -ProjectName myProject -Name myProjectWiki

This will create a project wiki

Example 2​

Add-VSTeamWiki -ProjectName myProject -Name myCodeWiki -repositoryId 00000000-0000-0000-0000-000000000000 -branch main -mappedPath '/.Docs'

This will create a code wiki from main branch and publish '.Docs' folder

PARAMETERS​

-ProjectName​

Specifies the team project for which this function operates.

You can tab complete from a list of available projects.

You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Name​

Name or ID of the Wiki to return

Type: String
Parameter Sets: (All)
Aliases: WikiName

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-RepositoryId​

ID of the repository to publish from

Type: String
Parameter Sets: codeWiki
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Branch​

Name of the branch in the repo to publish from

Type: String
Parameter Sets: codeWiki
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-MappedPath​

Path inside the repo to publish

Type: String
Parameter Sets: codeWiki
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters​

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS​

OUTPUTS​

NOTES​

Prerequisites:

Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.

tips:

  • check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo
  • use Set-VSTeamDefaultProject to set default project for every call
  • use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.
  • use Profiles to load an account and the correct version

Get-VSTeamWiki

Remove-VSTeamWiki