Skip to content
PowerShell Commands

Install-PackageProvider

Install-PackageProvider [-Name*] <String[]> [-AllVersions] [-Confirm] [-Credential <PSCredential>] [-Force][-ForceBootstrap] [-MaximumVersion <String>] [-MinimumVersion <String>] [-Proxy <Uri>] [-ProxyCredential<PSCredential>] [-RequiredVersion <String>] [-Scope {CurrentUser | AllUsers}] [-Source <String[]>] [-WhatIf][<CommonParameters>]
Install-PackageProvider [-InputObject*] <SoftwareIdentity[]> [-AllVersions] [-Confirm] [-Force] [-ForceBootstrap][-Proxy <Uri>] [-ProxyCredential <PSCredential>] [-Scope {CurrentUser | AllUsers}] [-WhatIf] [<CommonParameters>]

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 . 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:

1. Run `Install-PackageProvider -Name NuGet -RequiredVersion 2.8.5.201 -Force` to install the provider from a computer with an internet connection.

2. After the install, you can find the provider installed in `$env:ProgramFiles\PackageManagement\ReferenceAssemblies\\` or `$env:LOCALAPPDATA\PackageManagement\ProviderAssemblies\\`.

3. Place the 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 run Install-PackageProvider from Nano Server to download the correct Nuget binaries.

4. Restart PowerShell to auto-load the package provider. Alternatively, run `Get-PackageProvider -ListAvailable` to list all the package providers available on the computer. Then use `Import-PackageProvider -Name -RequiredVersion 2.8.5.201` to import the provider to the current Windows PowerShell session.

Parameters

-AllVersions [<SwitchParameter>]

  • Default value is False
  • Accepts pipeline input False

Indicates that this cmdlet installs all available versions of the package provider. By default, Install-PackageProvider only returns the highest available version.

-Confirm [<SwitchParameter>]

  • Default value is False
  • Accepts pipeline input False

Prompts you for confirmation before running the cmdlet.

-Credential <PSCredential>

  • Default value is None
  • Accepts pipeline input False

Specifies a user account that has permission to install package providers.

-Force [<SwitchParameter>]

  • Default value is False
  • Accepts pipeline input False

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.

-ForceBootstrap [<SwitchParameter>]

  • Default value is False
  • Accepts pipeline input False

Indicates that this cmdlet automatically installs the package provider.

-InputObject <SoftwareIdentity[]>

  • This value is required
  • Default value is None
  • Accepts pipeline input ByValue

Specifies a SoftwareIdentity object. Use the Find-PackageProvider cmdlet to obtain a SoftwareIdentity object to pipe into Install-PackageProvider .

-MaximumVersion <String>

  • Default value is None
  • Accepts pipeline input False

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.

-MinimumVersion <String>

  • Default value is None
  • Accepts pipeline input False

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.

-Name <String[]>

  • This value is required
  • Default value is None
  • Accepts pipeline input False

Specifies one or more package provider module names. Separate multiple package names with commas. Wildcard characters are not supported.

-Proxy <Uri>

  • Default value is None
  • Accepts pipeline input False

@{Text=}

-ProxyCredential <PSCredential>

  • Default value is None
  • Accepts pipeline input False

@{Text=}

-RequiredVersion <String>

  • Default value is None
  • Accepts pipeline input False

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.

-Scope <String>

  • Default value is None
  • Accepts pipeline input False

Specifies the installation scope of the provider. The acceptable values for this parameter are: AllUsers and CurrentUser .

The AllUsers scope installs providers in a location that is accessible to all users of the computer. By default, this is $env:ProgramFiles\PackageManagement\ProviderAssemblies. The CurrentUser scope installs providers in a location where they are only accessible to the current user. By default, this is $env:LOCALAPPDATA\PackageManagement\ProviderAssemblies.

-Source <String[]>

  • Default value is None
  • Accepts pipeline input ByPropertyName

Specifies one or more package sources. Use the Get-PackageSource cmdlet to get a list of available package sources.

-WhatIf [<SwitchParameter>]

  • Default value is False
  • Accepts pipeline input False

Shows what would happen if the cmdlet runs. The cmdlet is not run.

<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,ErrorAction, ErrorVariable, WarningAction, WarningVariable,OutBuffer, PipelineVariable, and OutVariable.

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 .
Examples
  1. Install a package provider from the PowerShell Gallery:
    PS C:\> Install-PackageProvider -Name "Gistprovider" -Verbose

    This command installs the Gistprovider from the PowerShell Gallery.

  2. Install a specified version of a package provider:
    PS C:\> Find-PackageProvider -Name "Nuget" -AllVersions
PS C:\>  Install-PackageProvider -Name "Nuget" -RequiredVersion "2.8.5.216" -Force

    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.

  3. Find a provider and install it:
    PS C:\> Find-PackageProvider -Name "Gistprovider" | Install-PackageProvider -Verbose

    This command uses Find-PackageProvider and the pipeline to search for the Gist provider and install it.

  4. Install a provider to the current user's module folder:
    PS C:\> Install-PackageProvider -Name Gistprovider -Verbose -Scope CurrentUser

    This command installs a package provider to $env:LOCALAPPDATA\PackageManagement\ProviderAssemblies so that only the current user can use it.

Additional Notes

This work is licensed under a Creative Commons Attribution 4.0 International. It is attributed to Microsoft Corporation and can be found here.

PowerShell Commands