Install-Package
SYNOPSIS
Installs the package.
SYNTAX
Name (Default)
Install-Package [-Name] <String[]> [[-Version] <PackageVersionRange>] [-Source <String>] [-Prerelease]
[-PassThru] [-TrustSource] [-Provider <String>] [-WhatIf] [-Confirm]
[<CommonParameters>]
InputObject
Install-Package <PackageInfo[]> [-PassThru] [-TrustSource] [-InputObject]
[-WhatIf] [-Confirm] [<CommonParameters>]
Path
Install-Package -Path <String[]> [-PassThru] [-Provider <String>]
[-WhatIf] [-Confirm] [<CommonParameters>]
LiteralPath
Install-Package -LiteralPath <String[]> [-PassThru] [-Provider <String>]
[-WhatIf] [-Confirm] [<CommonParameters>]
Uri
Install-Package -Uri <Uri[]> [-PassThru] [-Provider <String>] [-WhatIf]
[-Confirm] [<CommonParameters>]
DESCRIPTION
Installs the package.
EXAMPLES
Example 1
Install-Package -Name PowerShellGet
This command installs the PowerShellGet package.
PARAMETERS
-InputObject
Specifies a PackageInfo object that represents the package to install. Enter a variable that contains the object, or type a command or expression that gets the object, such as a Find-Package command. You can use the pipeline to send a package object to Install-Package.
Type: PackageInfo[]
Parameter Sets: InputObject
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-Name
Specifies the package name.
Type: String[]
Parameter Sets: Name
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-PassThru
If the package information should be output to the pipeline.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Prerelease
If a prerelease version should be allowed.
Type: SwitchParameter
Parameter Sets: Name
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Provider
Specifies the package provider.
Type: String
Parameter Sets: Name, Path, LiteralPath, Uri
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Source
Specifies the package source name.
Type: String
Parameter Sets: Name
Aliases: Repository
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-TrustSource
If an untrusted source should be trusted for this execution suppressing prompts.
Type: SwitchParameter
Parameter Sets: Name, InputObject
Aliases: TrustRepository
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Version
Specifies the package version. The format is NuGet version range syntax with minor changes. In normal NuGet version range value of 1.0 would be minimum version inclusive but this parameter converts that value to be exact version of [1.0]. If you need to have minimum version inclusive then use this format [1.0,]. For more information refer to NuGet version range syntax.
Type: PackageVersionRange
Parameter Sets: Name
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
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.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-LiteralPath
Specifies a path to one or more locations. The value of LiteralPath is used exactly as it’s typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell PowerShell to not interpret any characters as escape sequences.
Type: String[]
Parameter Sets: LiteralPath
Aliases: PSPath
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Path
Specifies a path to one or more locations. Wildcards are accepted.
Type: String[]
Parameter Sets: Path
Aliases: FilePath
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True
-Uri
Specifies a Uri.
Type: Uri[]
Parameter Sets: Uri
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
INPUTS
System.String, AnyPackage.Provider.PackageVersionRange, AnyPackage.Provider.PackageInfo
You can pipe a package name, version range, and package info to this cmdlet.
OUTPUTS
AnyPackage.Provider.PackageInfo
By default, this cmdlet doesn’t return any objects. Use the PassThru parameter to a return objects that represent a package.