Uninstall-PWSHModule

SYNOPSIS

Will uninstall the module from the system.

SYNTAX

Private (Default)

Uninstall-PWSHModule [-GitHubToken <String>] [<CommonParameters>]

List

Uninstall-PWSHModule [-ListName] <String[]> [-ModuleName] <String[]> -GitHubUserID <String> [-PublicGist]
 [-GitHubToken <String>] [<CommonParameters>]

OldVersions

Uninstall-PWSHModule [-UninstallOldVersions] [-ForceUninstall] [<CommonParameters>]

Public

Uninstall-PWSHModule [-PublicGist] [<CommonParameters>]

DESCRIPTION

Will uninstall the module from the system. Select OldVersions to remove duplicates only.

EXAMPLES

EXAMPLE 1

Uninstall-PWSHModule  -ListName base -OldVersions -GitHubUserID smitpi -PublicGist

PARAMETERS

-ListName

The File Name on GitHub Gist.

Type: String[]
Parameter Sets: List
Aliases:

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

-ModuleName

Name of the module to uninstall. Use * to select all modules in the list.

Type: String[]
Parameter Sets: List
Aliases: Name

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

-UninstallOldVersions

Will uninstall old versions of All modules.

Type: SwitchParameter
Parameter Sets: OldVersions
Aliases:

Required: False
Position: 1
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-ForceUninstall

Will force delete the base folder if uninstall fail.

Type: SwitchParameter
Parameter Sets: OldVersions
Aliases:

Required: False
Position: 2
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-GitHubUserID

The GitHub User ID.

Type: String
Parameter Sets: List
Aliases:

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

-PublicGist

Select if the list is hosted publicly.

Type: SwitchParameter
Parameter Sets: List, Public
Aliases:

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

-GitHubToken

GitHub Token with access to the Users' Gist.

Type: String
Parameter Sets: Private, List
Aliases:

Required: False
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