NAME
Install-Package
SYNOPSIS
Installs one or more software packages.SYNTAX
Install-Package [-AdditionalArguments
] [-AllVersions] [-Confirm] [-Credential ] [-Force] [-ForceBootstrap] [-Proxy
] [-ProxyCredential ] [-WhatIf] [ ] Install-Package [-AdditionalArguments
] [-AllVersions] [-Confirm] [-Credential ] [-Force] [-ForceBootstrap] [-Proxy
] [-ProxyCredential ] [-WhatIf] [ ] Install-Package [-AllVersions] [-AllowClobber] [-Command
] [-Confirm] [-Credential ] [-DscResource
] [-Filter ] [-Force] [-ForceBootstrap] [-Includes {DscResource | Cmdlet | Function | Workflow | RoleCapability}] [-InstallUpdate] [-NoPathUpdate] [-PackageManagementProvider
] [-Proxy
] [-ProxyCredential ] [-PublishLocation ] [-RoleCapability ] [-Scope {CurrentUser | AllUsers}] [-ScriptPublishLocation
] [-ScriptSourceLocation ] [-SkipPublisherCheck] [-Tag
] [-Type {Module | Script | All}] [-WhatIf] [ ] Install-Package [-AllVersions] [-AllowClobber] [-Command
] [-Confirm] [-Credential ] [-DscResource
] [-Filter ] [-Force] [-ForceBootstrap] [-Includes {DscResource | Cmdlet | Function | Workflow | RoleCapability}] [-InstallUpdate] [-NoPathUpdate] [-PackageManagementProvider
] [-Proxy
] [-ProxyCredential ] [-PublishLocation ] [-RoleCapability ] [-Scope {CurrentUser | AllUsers}] [-ScriptPublishLocation
] [-ScriptSourceLocation ] [-SkipPublisherCheck] [-Tag
] [-Type {Module | Script | All}] [-WhatIf] [ ] Install-Package [-AllVersions] [-AllowPrereleaseVersions] [-ConfigFile
] [-Confirm] [-Contains ] [-Credential
] [-Destination ] [-ExcludeVersion] [-FilterOnTag ] [-Force] [-ForceBootstrap] [-Headers
] [-Proxy ] [-ProxyCredential ] [-Scope {CurrentUser | AllUsers}] [-SkipDependencies] [-SkipValidate] [-WhatIf] [
] Install-Package [-AllVersions] [-AllowPrereleaseVersions] [-ConfigFile
] [-Confirm] [-Contains ] [-Credential
] [-Destination ] [-ExcludeVersion] [-FilterOnTag ] [-Force] [-ForceBootstrap] [-Headers
] [-Proxy ] [-ProxyCredential ] [-Scope {CurrentUser | AllUsers}] [-SkipDependencies] [-SkipValidate] [-WhatIf] [
] Install-Package [-AllVersions] [-Confirm] [-Credential
] [-Force] [-ForceBootstrap] [-IncludeSystemComponent] [-IncludeWindowsInstaller] [-Proxy
[] [-ProxyCredential ] [-WhatIf] ] Install-Package [-AllVersions] [-Confirm] [-Credential
] [-Force] [-ForceBootstrap] [-IncludeSystemComponent] [-IncludeWindowsInstaller] [-Proxy
[] [-ProxyCredential ] [-WhatIf] ] Install-Package [-InputObject]
[-AllVersions] [-Confirm] [-Credential ] [-Force] [-ForceBootstrap] [-Proxy
] [-ProxyCredential ] [-WhatIf] [ ] Install-Package [-Name]
[-AllVersions] [-Confirm] [-Credential ] [-Force] [-ForceBootstrap] [-MaximumVersion
] [-MinimumVersion ] [-ProviderName {msi | NuGet | msu | Programs | PowerShellGet | psl | chocolatey}] [-Proxy
] [-ProxyCredential ] [-RequiredVersion
] [-Source ] [-WhatIf] [ ] DESCRIPTION
The Install-Package cmdlet installs one or more software packages on the local computer.
PARAMETERS
-AdditionalArguments
Specifies one or more additional arguments for installation. Required? false Position? named Default value None Accept pipeline input? False Accept wildcard characters? false-AllVersions [
] Indicates that this cmdlet installs all available versions of the package. By default, Install -Package only
installs the newest available version. Required? false Position? named Default value False Accept pipeline input? False Accept wildcard characters? false-AllowClobber [
@{Text=} Required? false Position? named Default value False Accept pipeline input? False Accept wildcard characters? false] -AllowPrereleaseVersions [
{{Fill AllowPrereleaseVersions Description}} Required? false Position? named Default value False Accept pipeline input? False Accept wildcard characters? false] -Command
Specifies one or more commands for which Find-Package searches.
Required? false Position? named Default value None Accept pipeline input? False Accept wildcard characters? false-ConfigFile
{{Fill ConfigFile Description}} Required? false Position? named Default value None Accept pipeline input? False Accept wildcard characters? false-Confirm [
Prompts you for confirmation before running the cmdlet. Required? false Position? named Default value False Accept pipeline input? False Accept wildcard characters? false] -Contains
{{Fill Contains Description}} Required? false Position? named Default value None Accept pipeline input? False Accept wildcard characters? false-Credential
Specifies a user account that has rights to install a package for a specified package provider or source. Required? false Position? named Default value None Accept pipeline input? False Accept wildcard characters? false-Destination
{{Fill Destination Description}} Required? false Position? named Default value None Accept pipeline input? False Accept wildcard characters? false-DscResource
Specifies one or more Desired State Configuration (DSC) resources for which Find-Package searches.
Required? false Position? named Default value None Accept pipeline input? False Accept wildcard characters? false-ExcludeVersion [
{{Fill ExcludeVersion Description}} Required? false Position? named Default value False Accept pipeline input? False Accept wildcard characters? false] -Filter
Specifies terms to search for within the Name and Description properties.
Required? false Position? named Default value None Accept pipeline input? False Accept wildcard characters? false-FilterOnTag
{{Fill FilterOnTag Description}} Required? false Position? named Default value None Accept pipeline input? False Accept wildcard characters? false-Force [
Indicates that this cmdlet overrides restrictions that prevent the command from succeeding, as long as the changes do not compromise security. Required? false Position? named Default value False Accept pipeline input? False Accept wildcard characters? false] -ForceBootstrap [
Forces PackageManagement to automatically install the package provider for the specified package. Required? false Position? named Default value False Accept pipeline input? False Accept wildcard characters? false] -Headers
{{Fill Headers Description}} Required? false Position? named Default value None Accept pipeline input? False Accept wildcard characters? false-IncludeSystemComponent [
Indicates that this cmdlet includes system components in the results. Required? false Position? named Default value False Accept pipeline input? False Accept wildcard characters? false] -IncludeWindowsInstaller [
Indicates that this cmdlet includes the Windows installer in the results. Required? false Position? named Default value False Accept pipeline input? False Accept wildcard characters? false] -Includes
Specifies whether Find-Package should find all packages with DSC resources, cmdlets, functions, or workflows.
The acceptable values for this parameter are:- Cmdlet
- DscResource
- Function
- Workflow
Required? false Position? named Default value None Accept pipeline input? False Accept wildcard characters? false-InputObject
Specifies a package by using the package's SoftwareIdentity type, which is shown in the results of theFind-Package cmdlet.
Required? true Position? 0 Default value None Accept pipeline input? True (ByValue) Accept wildcard characters? false-InstallUpdate [
Indicates that this cmdlet installs updates. Required? false Position? named Default value False Accept pipeline input? False Accept wildcard characters? false] -MaximumVersion
Specifies the maximum allowed version of the package that you want to find. If you do not specify thisparameter, Install-Package installs the finds the highest-numbered available version of the package.
Required? false Position? named Default value None Accept pipeline input? False Accept wildcard characters? false-MinimumVersion
Specifies the minimum allowed version of the package that you want to find. If you do not add this parameter,Install-Package finds the highest available version of the package that also satisfies any maximum specified
version specified by the MaximumVersion parameter. Required? false Position? named Default value None Accept pipeline input? False Accept wildcard characters? false-Name
Specifies one or more package names. Multiple names must be separated by commas. Required? true Position? 0 Default value None Accept pipeline input? False Accept wildcard characters? false-NoPathUpdate [
@{Text=} Required? false Position? named Default value False Accept pipeline input? False Accept wildcard characters? false] -PackageManagementProvider
Specifies the name of the Package Management provider. Required? false Position? named Default value None Accept pipeline input? False Accept wildcard characters? false-ProviderName
Specifies one or more package provider names to which to scope your package search. You can get packageprovider names by running the Get-PackageProvider cmdlet.
Required? false Position? named Default value NoneAccept pipeline input? True (ByPropertyName)
Accept wildcard characters? false-Proxy
@{Text=} Required? false Position? named Default value None Accept pipeline input? False Accept wildcard characters? false-ProxyCredential
@{Text=} Required? false Position? named Default value None Accept pipeline input? False Accept wildcard characters? false-PublishLocation
Specifies a location for publishing the package. Required? false Position? named Default value None Accept pipeline input? False Accept wildcard characters? false-RequiredVersion
Specifies the exact allowed version of the package that you want to install. If you do not add this parameter,Install-Package installs the newest available version of the package that also satisfies any maximum version
specified by the MaximumVersion parameter. Required? false Position? named Default value None Accept pipeline input? False Accept wildcard characters? false-RoleCapability
@{Text=} Required? false Position? named Default value None Accept pipeline input? False Accept wildcard characters? false-Scope
Specifies the scope to which to install the package. The acceptable values for this parameter are:- CurrentUser
- AllUsers
Required? false Position? named Default value None Accept pipeline input? False Accept wildcard characters? false-ScriptPublishLocation
Specifies the script publish location. Required? false Position? named Default value None Accept pipeline input? False Accept wildcard characters? false-ScriptSourceLocation
Specifies the script source location. Required? false Position? named Default value None Accept pipeline input? False Accept wildcard characters? false-SkipDependencies [
{{Fill SkipDependencies Description}} Required? false Position? named Default value False Accept pipeline input? False Accept wildcard characters? false] -SkipPublisherCheck [
@{Text=} Required? false Position? named Default value False Accept pipeline input? False Accept wildcard characters? false] -SkipValidate [
{{Fill SkipValidate Description}} Required? false Position? named Default value False Accept pipeline input? False Accept wildcard characters? false] -Source
Specifies one or more package sources. Multiple package source names must be separated by commas. You can getpackage source names by running the Get-PackageSource cmdlet.
Required? false Position? named Default value NoneAccept pipeline input? True (ByPropertyName)
Accept wildcard characters? false-Tag
Specifies one or more strings to search for in the package metadata. Required? false Position? named Default value None Accept pipeline input? False Accept wildcard characters? false-Type
Specifies whether to search for packages with a module, a script, or both. The acceptable values for this parameter are:- Module
- Script
- All
Required? false Position? named Default value None Accept pipeline input? False Accept wildcard characters? false-WhatIf [
Shows what would happen if the cmdlet runs. The cmdlet is not run. Required? false Position? named Default value False Accept pipeline input? False Accept wildcard characters? false] This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216). INPUTS
OUTPUTS
SoftwareIdentity[]NOTES
Example 1: Install a package by package name
PS C:\>Install-Package -Name "DSCAccelerator" -Credential "CONTOSO\TestUser"
This command installs a package named DSCAccelerator. When you run this command, you are prompted to provide a password for the account that has rights to install the package.Example 2: Install a package that you find with Find-Package
PS C:\>Find-Package "zoomit" | Install-Package
This command installs a package named zoomit by piping the package from a Find-Package command.
Example 3: Install packages by specifying a range of versions
PS C:\>Install-Package -Name "DSCAccel" -MinimumVersion 2.1.2 -MaximumVersion 2.2
This command installs any package that has a name matching the partial name DSCAccel. The command installs the newest version of the package, within a range of versions that is specified by adding the MinimumVersion and MaximumVersion parameters.RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkID=517138 about_PackageManagementGet-Package
Find-Package
Save-Package
Uninstall-Package