Installing modules (Install-Module) in PowerShell

Introduction

Modules add new commands to PowerShell. Installing modules lets you use extra tools easily.

You want to add new commands to automate tasks.

You need to use a specific feature not built into PowerShell.

You want to share your scripts with others using common modules.

You want to update or install the latest version of a tool.

You are setting up a new computer and need required modules.

Syntax

PowerShell

Install-Module -Name <ModuleName> [-Scope <Scope>] [-Force] [-AllowClobber]

-Name is the module name you want to install.

-Scope can be CurrentUser (just you) or AllUsers (everyone on the PC).

Examples

Installs the PowerShellGet module for the current user by default.

PowerShell

Install-Module -Name PowerShellGet

Installs the Pester module only for the current user.

PowerShell

Install-Module -Name Pester -Scope CurrentUser

Installs or updates the Az module, forcing overwrite if needed.

PowerShell

Install-Module -Name Az -Force -AllowClobber

Sample Program

This script installs the PSReadLine module for the current user and confirms the installation.

PowerShell

Install-Module -Name PSReadLine -Scope CurrentUser -Force
Write-Output "Module PSReadLine installed successfully."

Important Notes

You may need to run PowerShell as Administrator to install modules for all users.

If you get a prompt about an untrusted repository, type 'Y' to continue.

Use Get-InstalledModule to see what modules are installed.

Summary

Install-Module adds new commands by downloading modules.

Use -Scope to control who can use the module.

Use -Force to overwrite existing modules if needed.

Practice

1. What does the PowerShell command Install-Module do?

easy

A. Downloads and installs a module to add new commands

B. Removes an installed module from the system

C. Lists all installed modules on the system

D. Updates all installed modules to the latest version

Solution

1. Step 1: Understand the purpose of Install-Module

   The command Install-Module is used to download and install new modules from online repositories.

2. Step 2: Differentiate from other module commands

   Commands like Remove-Module remove modules, Get-Module lists modules, and Update-Module updates them. These are different from Install-Module.

3. Final Answer:

   Downloads and installs a module to add new commands -> Option A

4. Quick Check:

   Install-Module = Downloads and installs [OK]

Hint: Install-Module always adds new modules, not removes or lists [OK]

Common Mistakes:

• Confusing Install-Module with Remove-Module
• Thinking it only lists modules
• Assuming it updates modules

2. Which of the following is the correct syntax to install a module named Az for the current user only?

easy

A. Install-Module Az -User

B. Install-Module -Name Az -UserScope

C. Install-Module -Name Az -Scope CurrentUser

D. Install-Module -Module Az -Scope User

Solution

1. Step 1: Identify correct parameter for scope

   The correct parameter to specify installation scope is -Scope with values like CurrentUser or AllUsers.

2. Step 2: Match correct syntax for module name and scope

   The module name is passed with -Name. So the correct syntax is Install-Module -Name Az -Scope CurrentUser.

3. Final Answer:

   Install-Module -Name Az -Scope CurrentUser -> Option C

4. Quick Check:

   Use -Scope CurrentUser to install for current user [OK]

Hint: Use -Scope CurrentUser to install module for yourself only [OK]

Common Mistakes:

• Using incorrect parameter names like -UserScope or -User
• Omitting -Name parameter
• Using wrong values for -Scope

3. What will be the output of this command if the module PSReadLine is already installed and you run:
Install-Module -Name PSReadLine

medium

A. It prompts to confirm overwriting the existing module

B. It installs the module again without any prompt

C. It throws an error saying module already exists

D. It skips installation silently

Solution

1. Step 1: Understand default behavior of Install-Module

   By default, if a module is already installed, Install-Module prompts the user to confirm overwriting the existing module.

2. Step 2: Check if -Force is used

   Since -Force is not used here, it will not overwrite silently or throw an error but ask for confirmation.

3. Final Answer:

   It prompts to confirm overwriting the existing module -> Option A

4. Quick Check:

   Install-Module prompts before overwriting without -Force [OK]

Hint: Without -Force, Install-Module asks before replacing existing modules [OK]

Common Mistakes:

• Assuming it overwrites silently
• Expecting an error instead of prompt
• Thinking it skips installation silently

4. You run Install-Module -Name Pester but get an error: Install-Module : The term 'Install-Module' is not recognized. What is the most likely fix?

medium

A. Run PowerShell as Administrator and try again

B. Use Install-Package instead

C. Restart the computer and rerun the command

D. Use Import-Module PowerShellGet before installing

Solution

1. Step 1: Identify cause of unrecognized command

   The error means the Install-Module command is not available, usually because the PowerShellGet module is not imported.

2. Step 2: Import PowerShellGet module

   Running Import-Module PowerShellGet loads the commands including Install-Module.

3. Final Answer:

   Use Import-Module PowerShellGet before installing -> Option D

4. Quick Check:

   Import PowerShellGet to enable Install-Module [OK]

Hint: Import PowerShellGet module if Install-Module is unknown [OK]

Common Mistakes:

• Assuming admin rights fix this error
• Restarting without importing module
• Using wrong command Install-Package

5. You want to install the module Az for all users and overwrite any existing version without prompts. Which command achieves this?

hard

A. Install-Module -Name Az -Scope CurrentUser -Force

B. Install-Module -Name Az -Scope AllUsers -Force

C. Install-Module -Name Az -Force

D. Install-Module -Name Az -Scope AllUsers

Solution

1. Step 1: Set installation scope for all users

   Use -Scope AllUsers to install the module for every user on the machine.

2. Step 2: Use -Force to overwrite without prompts

   Adding -Force forces the installation to overwrite any existing module version silently.

3. Final Answer:

   Install-Module -Name Az -Scope AllUsers -Force -> Option B

4. Quick Check:

   AllUsers scope + -Force = overwrite silently for all users [OK]

Hint: Use -Scope AllUsers and -Force to overwrite for everyone silently [OK]

Common Mistakes:

• Using CurrentUser scope instead of AllUsers
• Omitting -Force and expecting no prompts
• Using -Force without specifying scope