Install-Module

Syntax

Install-Module
       [-Name] <String[]>
       [-MinimumVersion <String>]
       [-MaximumVersion <String>]
       [-RequiredVersion <String>]
       [-Repository <String[]>]
       [-Credential <PSCredential>]
       [-Scope <String>]
       [-Proxy <Uri>]
       [-ProxyCredential <PSCredential>]
       [-AllowClobber]
       [-SkipPublisherCheck]
       [-Force]
       [-AllowPrerelease]
       [-AcceptLicense]
       [-PassThru]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

Install-Module
       [-InputObject] <PSObject[]>
       [-Credential <PSCredential>]
       [-Scope <String>]
       [-Proxy <Uri>]
       [-ProxyCredential <PSCredential>]
       [-AllowClobber]
       [-SkipPublisherCheck]
       [-Force]
       [-AcceptLicense]
       [-PassThru]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

Description

The Install-Module cmdlet gets one or more modules that meet specified criteria from an online repository. The cmdlet verifies that search results are valid modules and copies the module folders to the installation location. Installed modules are not automatically imported after installation. You can filter which module is installed based on the minimum, maximum, and exact versions of specified modules.

If the module being installed has the same name or version, or contains commands in an existing module, warning messages are displayed. After you confirm that you want to install the module and override the warnings, use the -Force and -AllowClobber parameters. Dependent upon your repository settings, you might need to answer a prompt for the module installation to continue.

These examples use the PowerShell Gallery as the only registered repository. Get-PSRepository displays the registered repositories. If you have multiple registered repositories, use the -Repository parameter to specify the repository's name.

Examples

Example 1: Find and install a module

This example finds a module in the repository and installs the module.

Find-Module -Name PowerShellGet | Install-Module

The Find-Module uses the Name parameter to specify the PowerShellGet module. By default, the newest version of the module is downloaded from the repository. The object is sent down the pipeline to the Install-Module cmdlet. Install-Module installs the module for all users in $env:ProgramFiles\PowerShell\Modules.

Example 2: Install a module by name

In this example, the newest version of the PowerShellGet module is installed.

Install-Module -Name PowerShellGet

The Install-Module uses the Name parameter to specify the PowerShellGet module. By default, the newest version of the module is downloaded from the repository and installed.

Example 3: Install a module using its minimum version

In this example, the minimum version of the PowerShellGet module is installed. The MinimumVersion parameter specifies the lowest version of the module that should be installed. If a newer version of the module is available, that version is downloaded and installed for all users.

Install-Module -Name PowerShellGet -MinimumVersion 2.0.1

The Install-Module uses the Name parameter to specify the PowerShellGet module. The MinimumVersion parameter specifies that version 2.0.1 is downloaded from the repository and installed. Because version 2.0.4 is available, that version is downloaded and installed for all users.

Example 4: Install a specific version of a module

In this example, a specific version of the PowerShellGet module is installed.

Install-Module -Name PowerShellGet -RequiredVersion 2.0.0

The Install-Module uses the Name parameter to specify the PowerShellGet module. The RequiredVersion parameter specifies that version 2.0.0 is downloaded and installed for all users.

Example 5: Install a module only for the current user

This example downloads and installs the newest version of a module, only for the current user.

Install-Module -Name PowerShellGet -Scope CurrentUser

The Install-Module uses the Name parameter to specify the PowerShellGet module. Install-Module downloads and installs the newest version of PowerShellGet into the current user's directory, $home\Documents\PowerShell\Modules.

Parameters

Inputs

PSRepositoryItemInfo

Find-Module creates PSRepositoryItemInfo objects that can be sent down the pipeline to Install-Module.

String[]

PSObject[]

String

PSCredential

Uri

Outputs

Microsoft.PowerShell.Commands.PSRepositoryItemInfo

When using the PassThru parameter, Install-Module outputs a PSRepositoryItemInfo object for the module. This is the same information that you get from the Find-Module cmdlet.

Notes

Install-Module runs on PowerShell 5.0 or later releases, on Windows 7 or Windows 2008 R2 and later releases of Windows.

As a security best practice, evaluate a module's code before running any cmdlets or functions for the first time. To prevent running modules that contain malicious code, installed modules are not automatically imported after installation.

If the module name specified by the Name parameter does not exist in the repository, Install-Module returns an error.

To install multiple modules, use the Name parameter and specify a comma-separated array of module names. If you specify multiple module names, you cannot use MinimumVersion, MaximumVersion, or RequiredVersion. Find-Module creates PSRepositoryItemInfo objects that can be sent down the pipeline to Install-Module. The pipeline is another way to specify multiple modules to install in a single command.

By default, modules for the scope of AllUsers are installed in $env:ProgramFiles\PowerShell\Modules. The default prevents confusion when you install PowerShell Desired State Configuration (DSC) resources.

A module installation fails and cannot be imported if it does not have a .psm1, .psd1, or .dll of the same name within the folder. Use the Force parameter to install the module.

If an existing module's version matches the name specified by the Name parameter, and the MinimumVersion or RequiredVersion parameter are not used, Install-Module silently continues but does not install the module.

If an existing module's version is greater than the value of the MinimumVersion parameter, or equal to the value of the RequiredVersion parameter, Install-Module silently continues but does not install the module.

If the existing module does not match the values specified by the MinimumVersion or RequiredVersion parameters, an error occurs in the Install-Module command. For example, if the version of the existing installed module is lower than the MinimumVersion value or not equal to the RequiredVersion value.

A module installation will also install any dependent modules specified as required by the module publisher. The publisher will specify the required modules and their versions in the module manifest.

Related Links

• Find-Module
• Get-PSRepository
• Import-Module
• Publish-Module
• Register-PSRepository
• Uninstall-Module
• Update-Module
• about_Module