Get-Package
Returns a list of all software packages that were installed with PackageManagement.
Syntax
Get-Package
[[-Name] <String[]>]
[-RequiredVersion <String>]
[-MinimumVersion <String>]
[-MaximumVersion <String>]
[-AllVersions]
[-Force]
[-ForceBootstrap]
[-ProviderName <String[]>]
[-Destination <String>]
[-ExcludeVersion]
[-Scope <String>]
[-SkipDependencies]
[<CommonParameters>]Get-Package
[[-Name] <String[]>]
[-RequiredVersion <String>]
[-MinimumVersion <String>]
[-MaximumVersion <String>]
[-AllVersions]
[-Force]
[-ForceBootstrap]
[-ProviderName <String[]>]
[-Scope <String>]
[-PackageManagementProvider <String>]
[-Type <String>]
[-AllowClobber]
[-SkipPublisherCheck]
[-InstallUpdate]
[-NoPathUpdate]
[-AllowPrereleaseVersions]
[<CommonParameters>]Description
The Get-Package cmdlet returns a list of all software packages on the local computer that were
installed with PackageManagement. You can run Get-Package on remote computers by running it as
part of an Invoke-Command or Enter-PSSession command or script.
Important
The commands contained in the PackageManagement module are different than the commands provided by the NuGet module in the Package Manager Console of Visual Studio. Each module has commands that are not available in the other. Commands with the same name differ in their specific arguments. For more information, see the PowerShell reference documentation for the Package Manager Console of Visual Studio.
Examples
Example 1: Get all installed packages
The Get-Package cmdlet gets all packages that are installed on the local computer.
Get-Package
Name Version Source ProviderName
---- ------- ------ ------------
posh-git 0.7.3 https://www.powershellgallery.com/api/v2 PowerShellGetExample 2: Get packages that are installed on a remote computer
This command gets a list of packages that were installed by PackageManagement on a remote computer. This command prompts you to provide the specified user's password.
PS> Invoke-Command -ComputerName Server01 -Credential CONTOSO\TestUser -ScriptBlock {Get-Package}Invoke-Command uses the ComputerName parameter to specify a remote computer, Server01. The
Credential parameter specifies a domain and user name with permissions to run commands on the
computer. The ScriptBlock parameter runs the Get-Package cmdlet on the remote computer.
Example 3: Get packages for a specified provider
This command gets software packages installed on the local computer from a specific provider.
Get-Package -ProviderName PowerShellGet -AllVersions
Name Version Source ProviderName
---- ------- ------ ------------
PackageManagement 1.2.2 https://www.powershellgallery.com/api/v2 PowerShellGet
PackageManagement 1.3.1 https://www.powershellgallery.com/api/v2 PowerShellGet
posh-git 0.7.3 https://www.powershellgallery.com/api/v2 PowerShellGet
PowerShellGet 2.0.1 https://www.powershellgallery.com/api/v2 PowerShellGetGet-Package uses the ProviderName parameter to specify a specific provider, PowerShellGet.
The AllVersions parameter displays each version that is installed.
Example 4: Get an exact version of a specific package
This command gets a specific version of an installed package. More than one version of a package can be installed.
Get-Package -Name PackageManagement -ProviderName PowerShellGet -RequiredVersion 1.3.1
Name Version Source ProviderName
---- ------- ------ ------------
PackageManagement 1.3.1 https://www.powershellgallery.com/api/v2 PowerShellGetGet-Package uses Name parameter to specify the package name, PackageManagement. The
ProviderName parameter specifies the provider, PowerShellGet. The RequiredVersion
parameter specifies an installed version.
Example 5: Uninstall a package
This example gets package information and then uninstalls the package.
Get-Package -Name posh-git -RequiredVersion 0.7.3 | Uninstall-PackageGet-Package uses the Name parameter to specify the package name, posh-git. The
RequiredVersion parameter is a specific version of the package. The object is sent down the
pipeline to the Uninstall-Package cmdlet. Uninstall-Package removes the package.
Parameters
-AllowClobber
Overrides warning messages about conflicts with existing commands. Overwrites existing commands that have the same name as commands being installed by a module.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-AllowPrereleaseVersions
Includes packages marked as a prerelease in the results.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-AllVersions
Indicates that Get-Package returns all available versions of the package. By default,
Get-Package only returns the newest available version.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Destination
Specifies the path to a directory that contains extracted package files.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ExcludeVersion
Switch to exclude the version number in the folder path.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Force
Forces the command to run without asking for user confirmation.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ForceBootstrap
Indicates that Get-Package forces PackageManagement to automatically install the package
provider.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InstallUpdate
Indicates that this cmdlet installs updates.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-MaximumVersion
Specifies the maximum package version that you want to find.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-MinimumVersion
Specifies the minimum package version that you want to find. If a higher version is available, that version is returned.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Name
Specifies one or more package names, or package names with wildcard characters. Separate multiple package names with commas.
| Type: | String[] |
| Position: | 0 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-NoPathUpdate
NoPathUpdate only applies to the Install-Script cmdlet. NoPathUpdate is a dynamic
parameter added by the provider and isn't supported by Get-Package.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PackageManagementProvider
Specifies the name of a package management provider.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ProviderName
Specifies one or more package provider names. Separate multiple package provider names with commas.
Use Get-PackageProvider to get a list of available package providers.
| Type: | String[] |
| Aliases: | Provider |
| Accepted values: | Bootstrap, NuGet, PowerShellGet |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-RequiredVersion
Specifies the exact version of the package to find.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Scope
Specifies the search scope for the package.
| Type: | String |
| Accepted values: | CurrentUser, AllUsers |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SkipDependencies
Switch that specifies to skip finding any package dependencies.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SkipPublisherCheck
Allows you to get a package version that is newer than your installed version. For example, an installed package that is digitally signed by a trusted publisher but a new version isn't digitally signed.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Type
Specifies whether to search for packages with a module, a script, or either.
| Type: | String |
| Accepted values: | Module, Script, All |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Outputs
Microsoft.PackageManagement.Packaging.SoftwareIdentity
This cmdlet returns a SoftwareIdentity object for each installed package that matches the parameters. By default, it returns every installed package.
Notes
Including a package provider in a command can make dynamic parameters available to a cmdlet. Dynamic
parameters are specific to a package provider. The Get-Help cmdlet lists a cmdlet's parameter sets
and includes the provider's parameter set. For example, Get-Package has the PowerShellGet
parameter set that includes -NoPathUpdate, AllowClobber, and SkipPublisherCheck.
Important
As of April 2020, the PowerShell Gallery no longer supports Transport Layer Security (TLS) versions 1.0 and 1.1. If you are not using TLS 1.2 or higher, you will receive an error when trying to access the PowerShell Gallery. Use the following command to ensure you are using TLS 1.2:
[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12
For more information, see the announcement in the PowerShell blog.
Related Links
PowerShellGet
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for