Install-RequiredModule

4.0.2

Parses a RequiredModules.psd1 listing modules and attempts to import those modules.
If it can't find the module in the PSModulePath, attempts to install it from PowerShellGet.

The RequiredModules list looks like this (uses nuget version range syntax):
@{
   "PowerShellGet" = "2.0.4"
   "Configuration" = "[1.3.1,2.0)"
   "Pester"        = "[4.4.2,4.7.0]"
}

https:/
Parses a RequiredModules.psd1 listing modules and attempts to import those modules.
If it can't find the module in the PSModulePath, attempts to install it from PowerShellGet.

The RequiredModules list looks like this (uses nuget version range syntax):
@{
   "PowerShellGet" = "2.0.4"
   "Configuration" = "[1.3.1,2.0)"
   "Pester"        = "[4.4.2,4.7.0]"
}

https://docs.microsoft.com/en-us/nuget/reference/package-versioning#version-ranges-and-wildcards

Show more
There is a newer prerelease version of this script available.
See the version list below for details.

Installation Options

Copy and Paste the following command to install this package using PowerShellGet More Info

Install-Script -Name Install-RequiredModule -RequiredVersion 4.0.2

Copy and Paste the following command to install this package using Microsoft.PowerShell.PSResourceGet More Info

You can deploy this package directly to Azure Automation. Note that deploying packages with dependencies will deploy all the dependencies to Azure Automation. Learn More

Manually download the .nupkg file to your system's default download location. Note that the file won't be unpacked, and won't include any dependencies. Learn More

Owners

Copyright

Copyright 2019, Joel Bennett

Package Details

Author(s)

  • Joel 'Jaykul' Bennett

Tags

Install Modules Development ModuleBuilder

Functions

GetModuleVersion FindModuleVersion ImportRequiredModulesFile InstallModuleVersion Install-RequiredModule

Dependencies

This script has no dependencies.

Release Notes

4.0.2 Fix Remove-Module error
4.0.1 Add logging outputs
4.0.0 Breaking change: require the -Destination to start empty (allow -CleanDestination to clear it)
Fix for adding the destination to PSModulePath multiple times
Started testing this so I can ship it to PowerShellGet
3.0.0 Breaking change: switch -SkipImport to -Import -- inverting the logic to NOT import by default
Add -Destination parameter to support installing in a local tool path
2.0.1 Squash mistaken "InstallError" message caused by Select-Object -First
Clean up output that was unexpected
2.0.0 Breaking change: use NuGetVersion to support wildcards like 3.*
Improve the error messages around aborted or failed installs
1.0.1 Fix "Version '3.4.0' of module 'Pester' is already installed"
1.0.0 This is the first public release - it probably doesn't work right

FileList

Version History

Version Downloads Last updated
5.1.2 2,853 8/20/2024
5.1.0 3,672 5/16/2024
5.1.0-upgrad... 325 9/22/2022
5.1.0-upgrad... 13 9/22/2022
5.1.0-upgrad... 19 9/14/2022
5.1.0-upgrad... 15 9/14/2022
5.0.5 42,553 9/3/2022
5.0.2 6,477 12/2/2021
5.0.1 20 12/2/2021
5.0.0 44 12/1/2021
4.0.6 50,613 6/4/2019
4.0.5 62 5/15/2019
4.0.4 87 4/27/2019
4.0.3 26 4/27/2019
4.0.2 (current version) 37 4/27/2019
4.0.1 26 4/27/2019
4.0.0 33 4/24/2019
3.0.0 40 3/22/2019
2.0.1 27 3/21/2019
2.0.0 33 3/21/2019
1.0.1 29 3/21/2019
1.0.0 29 3/20/2019
Show less