< Back
Install-ChocolateyPackage
Post
NAME Install-ChocolateyPackage
SYNOPSIS
Installs a Chocolatey package or a list of packages (sometimes specified as a packages.config).
SYNTAX
Install-ChocolateyPackage [-Name] <String[]> [[-Version] <String>] [[-Source] <Object>] [[-Credential]
<PSCredential>] [-Force] [[-CacheLocation] <String>] [-NoProgress] [-AcceptLicense] [[-Timeout] <Int32>] [-x86]
[[-InstallArguments] <String>] [[-InstallArgumentsSensitive] <String>] [[-PackageParameters] <String>]
[[-PackageParametersSensitive] <String>] [-OverrideArguments] [-NotSilent] [-ApplyArgsToDependencies]
[-AllowDowngrade] [-SideBySide] [-IgnoreDependencies] [-ForceDependencies] [-SkipPowerShell] [-IgnoreChecksum]
[-AllowEmptyChecksum] [-ignorePackageCodes] [-UsePackageCodes] [-StopOnFirstFailure] [-SkipCache]
[-UseDownloadCache] [-SkipVirusCheck] [-VirusCheck] [[-VirusPositive] <Int32>] [-WhatIf] [-Confirm]
[<CommonParameters>]
DESCRIPTION
Once the Chocolatey Software has been installed (see Install-ChocolateySoftware) this command
allows you to install Software packaged for Chocolatey.
PARAMETERS
-Name <String[]>
Package Name to install, either from a configured source, a specified one such as a folder,
or the current directory '.'
Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-Version <String>
Version - A specific version to install. Defaults to unspecified.
Required? false
Position? 2
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Source <Object>
Source - The source to find the package(s) to install. Special sources
include: ruby, webpi, cygwin, windowsfeatures, and python. To specify
more than one source, pass it with a semi-colon separating the values (-
e.g. "'source1;source2'"). Defaults to default feeds.
Required? false
Position? 3
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Credential <PSCredential>
Credential used with authenticated feeds. Defaults to empty.
Required? false
Position? 4
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Force [<SwitchParameter>]
Force - force the behavior. Do not use force during normal operation -
it subverts some of the smart behavior for commands.
Required? false
Position? named
Default value False
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-CacheLocation <String>
CacheLocation - Location for download cache, defaults to %TEMP% or value
in chocolatey.config file.
Required? false
Position? 5
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-NoProgress [<SwitchParameter>]
Do Not Show Progress - Do not show download progress percentages.
Available in 0.10.4+.
Required? false
Position? named
Default value False
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-AcceptLicense [<SwitchParameter>]
AcceptLicense - Accept license dialogs automatically. Reserved for future use.
Required? false
Position? named
Default value False
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Timeout <Int32>
CommandExecutionTimeout (in seconds) - The time to allow a command to
finish before timing out. Overrides the default execution timeout in the
configuration of 2700 seconds. '0' for infinite starting in 0.10.4.
Required? false
Position? 6
Default value 0
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-x86 [<SwitchParameter>]
ForceX86 - Force x86 (32bit) installation on 64 bit systems. Defaults to false.
Required? false
Position? named
Default value False
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-InstallArguments <String>
InstallArguments - Install Arguments to pass to the native installer in
the package. Defaults to unspecified.
Required? false
Position? 7
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-InstallArgumentsSensitive <String>
InstallArgumentsSensitive - Install Arguments to pass to the native
installer in the package that are sensitive and you do not want logged.
Defaults to unspecified. Available in 0.10.1+. [Licensed editions](https://chocolatey.org/compare) only.
Required? false
Position? 8
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-PackageParameters <String>
PackageParameters - Parameters to pass to the package, that should be handled by the ChocolateyInstall.ps1
Required? false
Position? 9
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-PackageParametersSensitive <String>
PackageParametersSensitive - Package Parameters to pass the package that
are sensitive and you do not want logged. Defaults to unspecified.
Available in 0.10.1+. [Licensed editions](https://chocolatey.org/compare) only.
Required? false
Position? 10
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-OverrideArguments [<SwitchParameter>]
OverrideArguments - Should install arguments be used exclusively without
appending to current package passed arguments? Defaults to false.
Required? false
Position? named
Default value False
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-NotSilent [<SwitchParameter>]
NotSilent - Do not install this silently. Defaults to false.
Required? false
Position? named
Default value False
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-ApplyArgsToDependencies [<SwitchParameter>]
Apply Install Arguments To Dependencies - Should install arguments be
applied to dependent packages? Defaults to false.
Required? false
Position? named
Default value False
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-AllowDowngrade [<SwitchParameter>]
AllowDowngrade - Should an attempt at downgrading be allowed? Defaults to false.
Required? false
Position? named
Default value False
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-SideBySide [<SwitchParameter>]
AllowMultipleVersions - Should multiple versions of a package be
installed? Defaults to false.
Required? false
Position? named
Default value False
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-IgnoreDependencies [<SwitchParameter>]
IgnoreDependencies - Ignore dependencies when installing package(s).
Defaults to false.
Required? false
Position? named
Default value False
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-ForceDependencies [<SwitchParameter>]
ForceDependencies - Force dependencies to be reinstalled when force
installing package(s). Must be used in conjunction with --force.
Defaults to false.
Required? false
Position? named
Default value False
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-SkipPowerShell [<SwitchParameter>]
Skip Powershell - Do not run chocolateyInstall.ps1. Defaults to false.
Required? false
Position? named
Default value False
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-IgnoreChecksum [<SwitchParameter>]
IgnoreChecksums - Ignore checksums provided by the package. Overrides
the default feature 'checksumFiles' set to 'True'. Available in 0.9.9.9+.
Required? false
Position? named
Default value False
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-AllowEmptyChecksum [<SwitchParameter>]
Allow Empty Checksums - Allow packages to have empty/missing checksums
for downloaded resources from non-secure locations (HTTP, FTP). Use this
switch is not recommended if using sources that download resources from
the internet. Overrides the default feature 'allowEmptyChecksums' set to
'False'. Available in 0.10.0+.
Required? false
Position? named
Default value False
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-ignorePackageCodes [<SwitchParameter>]
IgnorePackageExitCodes - Exit with a 0 for success and 1 for non-success,
no matter what package scripts provide for exit codes. Overrides the
default feature 'usePackageExitCodes' set to 'True'. Available in 0.-9.10+.
Required? false
Position? named
Default value False
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-UsePackageCodes [<SwitchParameter>]
UsePackageExitCodes - Package scripts can provide exit codes. Use those
for choco's exit code when non-zero (this value can come from a
dependency package). Chocolatey defines valid exit codes as 0, 1605,
1614, 1641, 3010. Overrides the default feature 'usePackageExitCodes'
set to 'True'. Available in 0.9.10+.
Required? false
Position? named
Default value False
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-StopOnFirstFailure [<SwitchParameter>]
Stop On First Package Failure - stop running install, upgrade or
uninstall on first package failure instead of continuing with others.
Overrides the default feature 'stopOnFirstPackageFailure' set to 'False'. Available in 0.10.4+.
Required? false
Position? named
Default value False
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-SkipCache [<SwitchParameter>]
Skip Download Cache - Use the original download even if a private CDN
cache is available for a package. Overrides the default feature
'downloadCache' set to 'True'. Available in 0.9.10+. [Licensed editions](https://chocolatey.org/compare)
only. See https://chocolatey.org/docs/features-private-cdn
Required? false
Position? named
Default value False
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-UseDownloadCache [<SwitchParameter>]
Use Download Cache - Use private CDN cache if available for a package.
Overrides the default feature 'downloadCache' set to 'True'. Available
in 0.9.10+. [Licensed editions](https://chocolatey.org/compare) only. See https://chocolate-
y.org/docs/features-private-cdn
Required? false
Position? named
Default value False
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-SkipVirusCheck [<SwitchParameter>]
Skip Virus Check - Skip the virus check for downloaded files on this run.
Overrides the default feature 'virusCheck' set to 'True'. Available
in 0.9.10+. [Licensed editions](https://chocolatey.org/compare) only.
See https://chocolatey.org/docs/features-virus-check
Required? false
Position? named
Default value False
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-VirusCheck [<SwitchParameter>]
Virus Check - check downloaded files for viruses. Overrides the default
feature 'virusCheck' set to 'True'. Available in 0.9.10+.
Licensed editions only. See https://chocolatey.org/docs/features-virus-check
Required? false
Position? named
Default value False
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-VirusPositive <Int32>
Virus Check Minimum Scan Result Positives - the minimum number of scan
result positives required to flag a package. Used when virusScannerType
is VirusTotal. Overrides the default configuration value
'virusCheckMinimumPositives' set to '5'. Available in 0.9.10+. Licensed
editions only. See https://chocolatey.org/docs/features-virus-check
Required? false
Position? 11
Default value 0
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
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
NOTES
https://github.com/chocolatey/choco/wik ... ndsInstall
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Install-ChocolateyPackage -Name Chocolatey -Version 0.10.8
RELATED LINKS
SYNOPSIS
Installs a Chocolatey package or a list of packages (sometimes specified as a packages.config).
SYNTAX
Install-ChocolateyPackage [-Name] <String[]> [[-Version] <String>] [[-Source] <Object>] [[-Credential]
<PSCredential>] [-Force] [[-CacheLocation] <String>] [-NoProgress] [-AcceptLicense] [[-Timeout] <Int32>] [-x86]
[[-InstallArguments] <String>] [[-InstallArgumentsSensitive] <String>] [[-PackageParameters] <String>]
[[-PackageParametersSensitive] <String>] [-OverrideArguments] [-NotSilent] [-ApplyArgsToDependencies]
[-AllowDowngrade] [-SideBySide] [-IgnoreDependencies] [-ForceDependencies] [-SkipPowerShell] [-IgnoreChecksum]
[-AllowEmptyChecksum] [-ignorePackageCodes] [-UsePackageCodes] [-StopOnFirstFailure] [-SkipCache]
[-UseDownloadCache] [-SkipVirusCheck] [-VirusCheck] [[-VirusPositive] <Int32>] [-WhatIf] [-Confirm]
[<CommonParameters>]
DESCRIPTION
Once the Chocolatey Software has been installed (see Install-ChocolateySoftware) this command
allows you to install Software packaged for Chocolatey.
PARAMETERS
-Name <String[]>
Package Name to install, either from a configured source, a specified one such as a folder,
or the current directory '.'
Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-Version <String>
Version - A specific version to install. Defaults to unspecified.
Required? false
Position? 2
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Source <Object>
Source - The source to find the package(s) to install. Special sources
include: ruby, webpi, cygwin, windowsfeatures, and python. To specify
more than one source, pass it with a semi-colon separating the values (-
e.g. "'source1;source2'"). Defaults to default feeds.
Required? false
Position? 3
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Credential <PSCredential>
Credential used with authenticated feeds. Defaults to empty.
Required? false
Position? 4
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Force [<SwitchParameter>]
Force - force the behavior. Do not use force during normal operation -
it subverts some of the smart behavior for commands.
Required? false
Position? named
Default value False
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-CacheLocation <String>
CacheLocation - Location for download cache, defaults to %TEMP% or value
in chocolatey.config file.
Required? false
Position? 5
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-NoProgress [<SwitchParameter>]
Do Not Show Progress - Do not show download progress percentages.
Available in 0.10.4+.
Required? false
Position? named
Default value False
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-AcceptLicense [<SwitchParameter>]
AcceptLicense - Accept license dialogs automatically. Reserved for future use.
Required? false
Position? named
Default value False
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Timeout <Int32>
CommandExecutionTimeout (in seconds) - The time to allow a command to
finish before timing out. Overrides the default execution timeout in the
configuration of 2700 seconds. '0' for infinite starting in 0.10.4.
Required? false
Position? 6
Default value 0
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-x86 [<SwitchParameter>]
ForceX86 - Force x86 (32bit) installation on 64 bit systems. Defaults to false.
Required? false
Position? named
Default value False
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-InstallArguments <String>
InstallArguments - Install Arguments to pass to the native installer in
the package. Defaults to unspecified.
Required? false
Position? 7
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-InstallArgumentsSensitive <String>
InstallArgumentsSensitive - Install Arguments to pass to the native
installer in the package that are sensitive and you do not want logged.
Defaults to unspecified. Available in 0.10.1+. [Licensed editions](https://chocolatey.org/compare) only.
Required? false
Position? 8
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-PackageParameters <String>
PackageParameters - Parameters to pass to the package, that should be handled by the ChocolateyInstall.ps1
Required? false
Position? 9
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-PackageParametersSensitive <String>
PackageParametersSensitive - Package Parameters to pass the package that
are sensitive and you do not want logged. Defaults to unspecified.
Available in 0.10.1+. [Licensed editions](https://chocolatey.org/compare) only.
Required? false
Position? 10
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-OverrideArguments [<SwitchParameter>]
OverrideArguments - Should install arguments be used exclusively without
appending to current package passed arguments? Defaults to false.
Required? false
Position? named
Default value False
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-NotSilent [<SwitchParameter>]
NotSilent - Do not install this silently. Defaults to false.
Required? false
Position? named
Default value False
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-ApplyArgsToDependencies [<SwitchParameter>]
Apply Install Arguments To Dependencies - Should install arguments be
applied to dependent packages? Defaults to false.
Required? false
Position? named
Default value False
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-AllowDowngrade [<SwitchParameter>]
AllowDowngrade - Should an attempt at downgrading be allowed? Defaults to false.
Required? false
Position? named
Default value False
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-SideBySide [<SwitchParameter>]
AllowMultipleVersions - Should multiple versions of a package be
installed? Defaults to false.
Required? false
Position? named
Default value False
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-IgnoreDependencies [<SwitchParameter>]
IgnoreDependencies - Ignore dependencies when installing package(s).
Defaults to false.
Required? false
Position? named
Default value False
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-ForceDependencies [<SwitchParameter>]
ForceDependencies - Force dependencies to be reinstalled when force
installing package(s). Must be used in conjunction with --force.
Defaults to false.
Required? false
Position? named
Default value False
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-SkipPowerShell [<SwitchParameter>]
Skip Powershell - Do not run chocolateyInstall.ps1. Defaults to false.
Required? false
Position? named
Default value False
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-IgnoreChecksum [<SwitchParameter>]
IgnoreChecksums - Ignore checksums provided by the package. Overrides
the default feature 'checksumFiles' set to 'True'. Available in 0.9.9.9+.
Required? false
Position? named
Default value False
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-AllowEmptyChecksum [<SwitchParameter>]
Allow Empty Checksums - Allow packages to have empty/missing checksums
for downloaded resources from non-secure locations (HTTP, FTP). Use this
switch is not recommended if using sources that download resources from
the internet. Overrides the default feature 'allowEmptyChecksums' set to
'False'. Available in 0.10.0+.
Required? false
Position? named
Default value False
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-ignorePackageCodes [<SwitchParameter>]
IgnorePackageExitCodes - Exit with a 0 for success and 1 for non-success,
no matter what package scripts provide for exit codes. Overrides the
default feature 'usePackageExitCodes' set to 'True'. Available in 0.-9.10+.
Required? false
Position? named
Default value False
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-UsePackageCodes [<SwitchParameter>]
UsePackageExitCodes - Package scripts can provide exit codes. Use those
for choco's exit code when non-zero (this value can come from a
dependency package). Chocolatey defines valid exit codes as 0, 1605,
1614, 1641, 3010. Overrides the default feature 'usePackageExitCodes'
set to 'True'. Available in 0.9.10+.
Required? false
Position? named
Default value False
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-StopOnFirstFailure [<SwitchParameter>]
Stop On First Package Failure - stop running install, upgrade or
uninstall on first package failure instead of continuing with others.
Overrides the default feature 'stopOnFirstPackageFailure' set to 'False'. Available in 0.10.4+.
Required? false
Position? named
Default value False
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-SkipCache [<SwitchParameter>]
Skip Download Cache - Use the original download even if a private CDN
cache is available for a package. Overrides the default feature
'downloadCache' set to 'True'. Available in 0.9.10+. [Licensed editions](https://chocolatey.org/compare)
only. See https://chocolatey.org/docs/features-private-cdn
Required? false
Position? named
Default value False
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-UseDownloadCache [<SwitchParameter>]
Use Download Cache - Use private CDN cache if available for a package.
Overrides the default feature 'downloadCache' set to 'True'. Available
in 0.9.10+. [Licensed editions](https://chocolatey.org/compare) only. See https://chocolate-
y.org/docs/features-private-cdn
Required? false
Position? named
Default value False
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-SkipVirusCheck [<SwitchParameter>]
Skip Virus Check - Skip the virus check for downloaded files on this run.
Overrides the default feature 'virusCheck' set to 'True'. Available
in 0.9.10+. [Licensed editions](https://chocolatey.org/compare) only.
See https://chocolatey.org/docs/features-virus-check
Required? false
Position? named
Default value False
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-VirusCheck [<SwitchParameter>]
Virus Check - check downloaded files for viruses. Overrides the default
feature 'virusCheck' set to 'True'. Available in 0.9.10+.
Licensed editions only. See https://chocolatey.org/docs/features-virus-check
Required? false
Position? named
Default value False
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-VirusPositive <Int32>
Virus Check Minimum Scan Result Positives - the minimum number of scan
result positives required to flag a package. Used when virusScannerType
is VirusTotal. Overrides the default configuration value
'virusCheckMinimumPositives' set to '5'. Available in 0.9.10+. Licensed
editions only. See https://chocolatey.org/docs/features-virus-check
Required? false
Position? 11
Default value 0
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
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
NOTES
https://github.com/chocolatey/choco/wik ... ndsInstall
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Install-ChocolateyPackage -Name Chocolatey -Version 0.10.8
RELATED LINKS