Install-PackageProvider
Installs one or more Package Management package providers.
Syntax
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>] Install-PackageProvider
[-Scope <String>]
[-InputObject] <SoftwareIdentity[]>
[-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.
This cmdlet also installs matching Package Management providers that are available in the Package Management Azure Blob store. Use the bootstrapper provider to find and install them.
In order to execute the first time, PackageManagement requires an internet connection to download the NuGet package provider. However, if your computer does not have an internet connection and you need to use the NuGet or PowerShellGet provider, you can download them on another computer and copy them to your target computer. Use the following steps to do this:
- Run
Install-PackageProvider -Name NuGet -RequiredVersion 2.8.5.201 -Forceto install the provider from a computer with an internet connection. - After the install, you can find the provider installed in
$env:ProgramFiles\PackageManagement\ProviderAssemblies\<ProviderName>\<ProviderVersion>or$env:LOCALAPPDATA\PackageManagement\ProviderAssemblies\<ProviderName>\<ProviderVersion>. - Place the
<ProviderName>folder, which in this case is the NuGet folder, in the corresponding location on your target computer. If your target computer is a Nano server, you need to runInstall-PackageProviderfrom Nano Server to download the correct NuGet binaries. - Restart PowerShell to auto-load the package provider. Alternatively, run
Get-PackageProvider -ListAvailableto list all the package providers available on the computer. Then useImport-PackageProvider -Name NuGet -RequiredVersion 2.8.5.201to import the provider to the current Windows PowerShell session.
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" -VerboseExample 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" -ForceExample 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 -VerboseExample 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 CurrentUserParameters
-AllVersions
Indicates that this cmdlet installs all available versions of the package provider. By default,
Install-PackageProvider only returns the highest available version.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Credential
Specifies a user account that has permission to install package providers.
| Type: | PSCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | 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.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ForceBootstrap
Indicates that this cmdlet automatically installs the package provider.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InputObject
Specifies a SoftwareIdentity object. Use the Find-PackageProvider cmdlet to obtain a
SoftwareIdentity object to pipe into Install-PackageProvider.
| Type: | Microsoft.PackageManagement.Packaging.SoftwareIdentity[] |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | 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.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | 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.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Name
Specifies one or more package provider module names. Separate multiple package names with commas. Wildcard characters are not supported.
| Type: | String[] |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Proxy
Specifies a proxy server for the request, rather than connecting directly to the Internet resource.
| Type: | Uri |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ProxyCredential
Specifies a user account that has permission to use the proxy server that is specified by the Proxy parameter.
| Type: | PSCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-RequiredVersion
Specifies the exact 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
that also satisfies any maximum version specified by the MaximumVersion parameter.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Scope
Specifies the installation scope of the provider. The acceptable values for this parameter are:
AllUsers - installs providers in a location that is accessible to all users of the computer. By default, this is $env:ProgramFiles\PackageManagement\ProviderAssemblies.
CurrentUser - installs providers in a location where they are only accessible to the current user. By default, this is $env:LOCALAPPDATA\PackageManagement\ProviderAssemblies.
| Type: | String |
| Accepted values: | CurrentUser, AllUsers |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Source
Specifies one or more package sources. Use the Get-PackageSource cmdlet to get a list of available
package sources.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
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 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