Save-Module

Reference

Module:: PowershellGet

Saves a module and its dependencies on the local computer but doesn't install the module.

Syntax

Save-Module
    [-Name] <String[]>
    [-MinimumVersion <Version>]
    [-MaximumVersion <Version>]
    [-RequiredVersion <Version>]
    [-Repository <String[]>]
    -Path <String>
    [-Force]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Save-Module
    [-Name] <String[]>
    [-MinimumVersion <Version>]
    [-MaximumVersion <Version>]
    [-RequiredVersion <Version>]
    [-Repository <String[]>]
    -LiteralPath <String>
    [-Force]
    [-WhatIf]
    [-Confirm] 
    [<CommonParameters>]

Save-Module
    [-InputObject] <PSObject[]>
    -LiteralPath <String>
    [-Force]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Save-Module
    [-InputObject] <PSObject[]>
    -Path <String>
    [-Force]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The Save-Module cmdlet downloads a module and any dependencies from a registered repository. Save-Module downloads and saves the most current version of a module. The files are saved to a specified path on the local computer. The module isn't installed, but the contents are available for inspection by an administrator.

Get-PSRepository displays the local computer's registered repositories. You can use the Find-Module cmdlet to search registered repositories.

Examples

Example 1: Save a module

In this example, a module and its dependencies are saved to the local computer.

Save-Module -Name PowerShellGet -Path C:\Test\Modules -Repository PSGallery
Get-ChildItem -Path C:\Test\Modules

Directory: C:\Test\Modules

Mode                LastWriteTime         Length Name
----                -------------         ------ ----
d-----         7/1/2019     13:31                PackageManagement
d-----         7/1/2019     13:31                PowerShellGet

Save-Module uses the Name parameter to specify the module, PowerShellGet. The Path parameter specifies where to store the downloaded module. The Repository parameter specifies a registered repository, PSGallery. After the download is finished, Get-ChildItem displays the contents of Path where the files are stored.

Example 2: Save a specific version of a module

This example shows how to use a parameter such as MaximumVersion, or RequiredVersion to specify a module version.

Save-Module -Name PowerShellGet -Path C:\Test\Modules -Repository PSGallery -MaximumVersion 2.1.0
Get-ChildItem -Path C:\Test\Modules\PowerShellGet\

Directory: C:\Test\Modules\PowerShellGet

Mode                LastWriteTime         Length Name
----                -------------         ------ ----
d-----         7/1/2019     13:40                2.1.0

Save-Module uses the Name parameter to specify the module, PowerShellGet. The Path parameter specifies where to store the downloaded module. The Repository parameter specifies a registered repository, PSGallery. MaximumVersion specifies that version 2.1.0 is downloaded and saved. After the download is finished, Get-ChildItem displays the contents of Path where the files are stored.

Example 3: Find and save a specific version of a module

In this example, a required module version is found in the repository and saved to the local computer.

Find-Module -Name PowerShellGet -Repository PSGallery -RequiredVersion 1.6.5 |
  Save-Module -Path C:\Test\Modules
Get-ChildItem -Path C:\Test\Modules\PowerShellGet

Directory: C:\Test\Modules\PowerShellGet

Mode                LastWriteTime         Length Name
----                -------------         ------ ----
d-----         7/1/2019     14:04                1.6.5

Find-Module uses the Name parameter to specify the module, PowerShellGet. The Repository parameter specifies a registered repository, PSGallery. RequiredVersion specifies version 1.6.5.

The object is sent down the pipeline to Save-Module. The Path parameter specifies where to store the downloaded module. After the download is finished, Get-ChildItem displays the contents of Path where the files are stored.

Parameters

-Confirm

Prompts you for confirmation before running the Save-Module.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Force

Forces Save-Module to run without asking for user confirmation.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-InputObject

Accepts a PSRepositoryItemInfo object. For example, output Find-Module to a variable and use that variable as the InputObject argument.

Type:	PSObject[]
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-LiteralPath

Specifies a path to one or more locations. The value of the LiteralPath parameter is used exactly as entered. No characters are interpreted as wildcards. If the path includes escape characters, enclose them in single quotation marks. PowerShell does not interpret any characters enclosed in single quotation marks as escape sequences.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-MaximumVersion

Specifies the maximum, or newest, version of the module to save. The MaximumVersion and RequiredVersion parameters can't be used in the same command.

Type:	Version
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-MinimumVersion

Specifies the minimum version of a single module to save. You cannot add this parameter if you are attempting to install multiple modules. The MinimumVersion and RequiredVersion parameters can't be used in the same command.

Type:	Version
Aliases:	Version
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-Name

Specifies an array of names of modules to save.

Type:	String[]
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Path

Specifies the location on the local computer to store a saved module. Accepts wildcard characters.

Type:	String
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	True

-Repository

Specifies the friendly name of a repository that has been registered by running Register-PSRepository. Use Get-PSRepository to display registered repositories.

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-RequiredVersion

Specifies the exact version number of the module to save.

Type:	Version
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-WhatIf

Shows what would happen if the Save-Module runs. The cmdlet isn't run.

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Share via