Installing Evergreen¶

PowerShell Support¶

Evergreen supports Windows PowerShell 5.1 and PowerShell 7.0+. Evergreen should work on PowerShell Core 6.x; however, we are not actively testing on that version of PowerShell, so support cannot be guaranteed.

Install from the PowerShell Gallery¶

The Evergreen module is published to the PowerShell Gallery and can be found here: Evergreen. The module can be installed from the gallery with:

Install-Module -Name Evergreen
Import-Module -Name Evergreen

Updating the Module¶

If you have installed a previous version of the module from the gallery, you can install the latest update with Update-Module and the -Force parameter:

Update-Module -Name Evergreen -Force

Advanced Installation¶

In scripted installations (e.g. operating system deployment), you may wish to ensure that the PowerShell Gallery is first trusted before attempting to install the module:

if (Get-PSRepository | Where-Object { $_.Name -eq "PSGallery" -and $_.InstallationPolicy -ne "Trusted" }) {
    Install-PackageProvider -Name "NuGet" -MinimumVersion 2.8.5.208 -Force
    Set-PSRepository -Name "PSGallery" -InstallationPolicy "Trusted"
}

Then we can install or update Evergreen based on whether the module is already installed or out of date:

$Installed = Get-Module -Name "Evergreen" -ListAvailable | `
    Sort-Object -Property @{ Expression = { [System.Version]$_.Version }; Descending = $true } | `
    Select-Object -First 1
$Published = Find-Module -Name "Evergreen"
if ($Null -eq $Installed) {
    Install-Module -Name "Evergreen"
}
elseif ([System.Version]$Published.Version -gt [System.Version]$Installed.Version) {
    Update-Module -Name "Evergreen"
}

Manual Installation from the Repository¶

The module can be downloaded from the GitHub source repository which includes the module in the Evergreen folder. The folder needs to be copied into one of your PowerShell Module Paths. To see the full list of available PowerShell Module paths, use $env:PSModulePath.split(';') in a PowerShell console.

Common PowerShell module paths include:

Current User: %USERPROFILE%\Documents\WindowsPowerShell\Modules\
All Users: %ProgramFiles%\WindowsPowerShell\Modules\
OneDrive: $env:OneDrive\Documents\WindowsPowerShell\Modules\

To install from the repository

Download the main branch to your workstation
Copy the contents of the Evergreen folder onto your workstation into the desired PowerShell Module path
Open a Powershell console with the Run as Administrator option
Run Set-ExecutionPolicy using the parameter RemoteSigned or Bypass
Unblock the files with Get-ChildItem -Path <path to module> -Recurse | Unblock-File

Once installation is complete, you can validate that the module exists by running Get-Module -ListAvailable Evergreen. To use the module, load it with:

Import-Module Evergreen