Install-PackageProvider
Installs one or more Package Management package providers.
Syntax
PackageBySearch (Default)
Install-PackageProvider
[-Name] <String[]>
[-RequiredVersion <String>]
[-MinimumVersion <String>]
[-MaximumVersion <String>]
[-Credential <PSCredential>]
[-Scope <String>]
[-Source <String[]>]
[-Proxy <Uri>]
[-ProxyCredential <PSCredential>]
[-AllVersions]
[-Force]
[-ForceBootstrap]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
PackageByInputObject
Install-PackageProvider
[-InputObject] <SoftwareIdentity[]>
[-Scope <String>]
[-Proxy <Uri>]
[-ProxyCredential <PSCredential>]
[-AllVersions]
[-Force]
[-ForceBootstrap]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Install-PackageProvider cmdlet installs matching Package Management providers that are
available in package sources registered with PowerShellGet. By default, this includes modules
available in the Windows PowerShell Gallery with the PackageManagement tag. The
PowerShellGet Package Management provider is used for finding providers in these repositories.
This cmdlet also installs matching Package Management providers that are available using the Package Management bootstrapping application.
Examples
Example 1: Install a package provider from the PowerShell Gallery
This command installs the GistProvider package provider from the PowerShell Gallery.
Install-PackageProvider -Name "GistProvider" -Verbose
Example 2: Install a specified version of a package provider
This example installs a specified version of the NuGet package provider.
The first command finds all versions of the package provider named NuGet. The second command installs a specified version of the NuGet package provider.
Find-PackageProvider -Name "NuGet" -AllVersions
Install-PackageProvider -Name "NuGet" -RequiredVersion "2.8.5.216" -Force
You only need to install the NuGet package provider if you are running PackageManagement v1.1.0.0 in Windows PowerShell. Newer versions of PowerShellGet and PackageManagement include the NuGet package provider by default.
Example 3: Find a provider and install it
This example uses Find-PackageProvider and the pipeline to search for the Gist provider and
install it.
Find-PackageProvider -Name "GistProvider" | Install-PackageProvider -Verbose
Example 4: Install a provider to the current user's module folder
This command installs a package provider to $env:LOCALAPPDATA\PackageManagement\ProviderAssemblies
so that only the current user can use it.
Install-PackageProvider -Name GistProvider -Verbose -Scope CurrentUser
Parameters
-AllVersions
Indicates that this cmdlet installs all available versions of the package provider. By default,
Install-PackageProvider only returns the highest available version.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Credential
Specifies a user account that has permission to install package providers.
Parameter properties
| Type: | PSCredential |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
PackageBySearch
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Force
Indicates that this cmdlet forces all actions with this cmdlet that can be forced. Currently, this means the Force parameter acts the same as the ForceBootstrap parameter.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ForceBootstrap
Indicates that this cmdlet automatically installs the package provider.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-InputObject
Specifies a SoftwareIdentity object. Use the Find-PackageProvider cmdlet to obtain a
SoftwareIdentity object to pipe into Install-PackageProvider.
Parameter properties
| Type: | Microsoft.PackageManagement.Packaging.SoftwareIdentity[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
PackageByInputObject
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-MaximumVersion
Specifies the maximum allowed version of the package provider that you want to install. If you do
not add this parameter, Install-PackageProvider installs the highest available version of the
provider.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
PackageBySearch
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-MinimumVersion
Specifies the minimum allowed version of the package provider that you want to install. If you do
not add this parameter, Install-PackageProvider installs the highest available version of the
package that also satisfies any requirement specified by the MaximumVersion parameter.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
PackageBySearch
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Name
Specifies one or more package provider module names. Separate multiple package names with commas. Wildcard characters aren't supported.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
PackageBySearch
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Proxy
Specifies a proxy server for the request, rather than connecting directly to the Internet resource.
Parameter properties
| Type: | Uri |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ProxyCredential
Specifies a user account that has permission to use the proxy server that's specified by the Proxy parameter.
Parameter properties
| Type: | PSCredential |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-RequiredVersion
Specifies the exact allowed version of the package provider that you want to install. If you don't
add this parameter, Install-PackageProvider installs the highest available version of the provider
that also satisfies any maximum version specified by the MaximumVersion parameter.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
PackageBySearch
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Scope
Specifies the installation scope of the provider. The acceptable values for this parameter are:
AllUsers - installs providers in a location that's accessible to all users of the computer. By default, this is $env:ProgramFiles\PackageManagement\ProviderAssemblies.
CurrentUser - installs providers in a location where they're only accessible to the current user. By default, this is $env:LOCALAPPDATA\PackageManagement\ProviderAssemblies.
Parameter properties
| Type: | String |
| Default value: | None |
| Accepted values: | CurrentUser, AllUsers |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Source
Specifies one or more package sources. Use the Get-PackageSource cmdlet to get a list of available
package sources.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
PackageBySearch
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet isn't run.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
Microsoft.PackageManagement.Packaging.SoftwareIdentity
You can pipe a SoftwareIdentity object to this cmdlet. Use Find-PackageProvider to get a
SoftwareIdentity object that can be piped into Install-PackageProvider.
Notes
Important
As of April 2020, the PowerShell Gallery no longer supports Transport Layer Security (TLS) versions 1.0 and 1.1. If you aren't 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.
