public/Install-ChocolateyPackage.ps1
|
<# .SYNOPSIS Installs a Chocolatey package or a list of packages (sometimes specified as a packages.config). .DESCRIPTION Once the Chocolatey Software has been installed (see Install-ChocolateySoftware) this command allows you to install Software packaged for Chocolatey. .PARAMETER Name Package Name to install, either from a configured source, a specified one such as a folder, or the current directory '.' .PARAMETER Version Version - A specific version to install. Defaults to unspecified. .PARAMETER Source 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. .PARAMETER Credential Credential used with authenticated feeds. Defaults to empty. .PARAMETER Force Force - force the behavior. Do not use force during normal operation - it subverts some of the smart behavior for commands. .PARAMETER CacheLocation CacheLocation - Location for download cache, defaults to %TEMP% or value in chocolatey.config file. .PARAMETER NoProgress Do Not Show Progress - Do not show download progress percentages. Available in 0.10.4+. .PARAMETER AcceptLicense AcceptLicense - Accept license dialogs automatically. Reserved for future use. .PARAMETER Timeout 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. .PARAMETER x86 ForceX86 - Force x86 (32bit) installation on 64 bit systems. Defaults to false. .PARAMETER InstallArguments InstallArguments - Install Arguments to pass to the native installer in the package. Defaults to unspecified. .PARAMETER InstallArgumentsSensitive 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. .PARAMETER PackageParameters PackageParameters - Parameters to pass to the package, that should be handled by the ChocolateyInstall.ps1 .PARAMETER PackageParametersSensitive 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. .PARAMETER OverrideArguments OverrideArguments - Should install arguments be used exclusively without appending to current package passed arguments? Defaults to false. .PARAMETER NotSilent NotSilent - Do not install this silently. Defaults to false. .PARAMETER ApplyArgsToDependencies Apply Install Arguments To Dependencies - Should install arguments be applied to dependent packages? Defaults to false. .PARAMETER AllowDowngrade AllowDowngrade - Should an attempt at downgrading be allowed? Defaults to false. .PARAMETER SideBySide AllowMultipleVersions - Should multiple versions of a package be installed? Defaults to false. .PARAMETER IgnoreDependencies IgnoreDependencies - Ignore dependencies when installing package(s). Defaults to false. .PARAMETER ForceDependencies ForceDependencies - Force dependencies to be reinstalled when force installing package(s). Must be used in conjunction with --force. Defaults to false. .PARAMETER SkipPowerShell Skip Powershell - Do not run chocolateyInstall.ps1. Defaults to false. .PARAMETER IgnoreChecksum IgnoreChecksums - Ignore checksums provided by the package. Overrides the default feature 'checksumFiles' set to 'True'. Available in 0.9.9.9+. .PARAMETER AllowEmptyChecksum 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+. .PARAMETER ignorePackageCodes 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+. .PARAMETER UsePackageCodes 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+. .PARAMETER StopOnFirstFailure 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+. .PARAMETER SkipCache 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 .PARAMETER UseDownloadCache 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 .PARAMETER SkipVirusCheck 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 .PARAMETER VirusCheck 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 .PARAMETER VirusPositive 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 .EXAMPLE Install-ChocolateyPackage -Name Chocolatey -Version 0.10.8 .NOTES https://github.com/chocolatey/choco/wiki/CommandsInstall #> function Install-ChocolateyPackage { [CmdletBinding( SupportsShouldProcess=$true, ConfirmImpact='High' )] Param( [Parameter( Mandatory ,ValueFromPipeline ,ValueFromPipelineByPropertyName )] [String[]] $Name, [Parameter( ,ValueFromPipelineByPropertyName )] [ValidateNotNullOrEmpty()] [String] $Version, [Parameter( ValueFromPipelineByPropertyName )] $Source, [Parameter( ValueFromPipelineByPropertyName )] [PSCredential] $Credential, [Parameter( ValueFromPipelineByPropertyName )] [switch] $Force, [Parameter( ValueFromPipelineByPropertyName )] [String] $CacheLocation, [Parameter( ValueFromPipelineByPropertyName )] [switch] $NoProgress, [Parameter( ValueFromPipelineByPropertyName )] [switch] $AcceptLicense, [Parameter( ValueFromPipelineByPropertyName )] [int] $Timeout, [Parameter( ValueFromPipelineByPropertyName )] [switch] $x86, [Parameter( ValueFromPipelineByPropertyName )] [String] $InstallArguments, [Parameter( ValueFromPipelineByPropertyName )] [String] $InstallArgumentsSensitive, [Parameter( ValueFromPipelineByPropertyName )] [String] $PackageParameters, [Parameter( ValueFromPipelineByPropertyName )] [String] $PackageParametersSensitive, [Parameter( ValueFromPipelineByPropertyName )] [switch] $OverrideArguments, [Parameter( ValueFromPipelineByPropertyName )] [switch] $NotSilent, [Parameter( ValueFromPipelineByPropertyName )] [switch] $ApplyArgsToDependencies, [Parameter( ValueFromPipelineByPropertyName )] [switch] $AllowDowngrade, [Parameter( ValueFromPipelineByPropertyName )] [switch] $SideBySide, [Parameter( ValueFromPipelineByPropertyName )] [switch] $IgnoreDependencies, [Parameter( ValueFromPipelineByPropertyName )] [switch] $ForceDependencies, [Parameter( ValueFromPipelineByPropertyName )] [switch] $SkipPowerShell, [Parameter( ValueFromPipelineByPropertyName )] [switch] $IgnoreChecksum, [Parameter( ValueFromPipelineByPropertyName )] [switch] $AllowEmptyChecksum, [Parameter( ValueFromPipelineByPropertyName )] [switch] $ignorePackageCodes, [Parameter( ValueFromPipelineByPropertyName )] [switch] $UsePackageCodes, [Parameter( ValueFromPipelineByPropertyName )] [switch] $StopOnFirstFailure, [Parameter( ValueFromPipelineByPropertyName )] [switch] $SkipCache, [Parameter( ValueFromPipelineByPropertyName )] [switch] $UseDownloadCache, [Parameter( ValueFromPipelineByPropertyName )] [switch] $SkipVirusCheck, [Parameter( ValueFromPipelineByPropertyName )] [switch] $VirusCheck, [Parameter( ValueFromPipelineByPropertyName )] [ValidateNotNullOrEmpty()] [int] $VirusPositive ) begin { $null = $PSboundParameters.remove('Name') if (-not ($chocoCmd = Get-Command 'choco.exe' -CommandType Application -ErrorAction SilentlyContinue)) { Throw "Chocolatey Software not found" } } Process { foreach ($PackageName in $Name) { $ChocoArguments = @('install',$PackageName) $ChocoArguments += Get-ChocolateyDefaultArgument @PSBoundParameters Write-Verbose "choco $($ChocoArguments -join ' ')" if ($PSCmdlet.ShouldProcess($PackageName,"Install")) { #Impact confirmed, go choco go! $ChocoArguments += '-y' $ChocoOut = &$chocoCmd $ChocoArguments if($ChocoOut) { Write-Output $ChocoOut } } } } } |