Windows PowerShell command on Get-command Install-Script

NAME

Install-Script

SYNOPSIS

Installs a script.

SYNTAX

Install-Script [-InputObject] [-Confirm] [-Credential ] [-Force] [-NoPathUpdate]

[-Proxy ] [-ProxyCredential ] [-Scope {CurrentUser | AllUsers}] [-WhatIf] []

Install-Script [-Name] [-Confirm] [-Credential ] [-Force] [-MaximumVersion ]

[-MinimumVersion ] [-NoPathUpdate] [-Proxy ] [-ProxyCredential ] [-Repository

] [-RequiredVersion ] [-Scope {CurrentUser | AllUsers}] [-WhatIf] []

DESCRIPTION

The Install-Script cmdlet acquires a script payload from a repository, verifies that the payload is a valid

PowerShell script, and copies the script file to a specified installation location.

The default repositories Install-Script operates against are configurable through the Register-PSRepository,

Set-PSRepository, Unregister-PSRepository, and Get-PSRepository cmdlets. When operating against multiple

repositories, Install-Script installs the first script that matches the specified search criteria ( Name ,

MinimumVersion , or MaximumVersion ) from the first repository without any error.

PARAMETERS

-Confirm []

Prompts you for confirmation before running the cmdlet. Required? false Position? named Default value False Accept pipeline input? False Accept wildcard characters? false

-Credential

@{Text=} Required? false Position? named Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false

-Force []

Forces the command to run without asking for user confirmation. Required? false Position? named Default value False Accept pipeline input? False Accept wildcard characters? false

-InputObject

{{Fill InputObject Description}} Required? true Position? 0 Default value None

Accept pipeline input? True (ByPropertyName, ByValue)

Accept wildcard characters? false

-MaximumVersion

Specifies the maximum, or newest, version of the script to install. The MaximumVersion and RequiredVersion parameters are mutually exclusive; you cannot use both parameters in the same command. This parameter accepts

the wildcard character (*).

Required? false Position? named Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false

-MinimumVersion

Specifies the minimum version of the script to install. The MinimumVersion and RequiredVersion parameters are mutually exclusive; you cannot use both parameters in the same command. Required? false Position? named Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false

-Name

Specifies an array of names of scripts to install. Required? true Position? 0 Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false

-NoPathUpdate []

@{Text=} Required? false Position? named Default value False Accept pipeline input? False Accept wildcard characters? false

-Proxy

@{Text=} Required? false Position? named Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false

-ProxyCredential

@{Text=} Required? false Position? named Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false

-Repository

Specifies the friendly name of a repository that has been registered with the Register-PSRepository cmdlet.

The default is all registered repositories. Required? false Position? named Default value None Accept pipeline input? False Accept wildcard characters? false

-RequiredVersion

Specifies the exact version number of the script to install. Required? false Position? named Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false

-Scope

Specifies the installation scope of the script. Valid values are: AllUsers and CurrentUser. The default is CurrentUser.

The AllUsers scope specifies to install a script to %systemdrive%:\ProgramFiles\WindowsPowerShell\Scripts so

that the script is available to all users. The CurrentUser scope specifies to install the script in

$home\Documents\WindowsPowerShell\Scripts so that the script is available only to the current user.

Required? false Position? named Default value None Accept pipeline input? False Accept wildcard characters? false

-WhatIf []

Shows what would happen if the cmdlet runs. The cmdlet is not run. Required? false Position? named Default value False Accept pipeline input? False Accept wildcard characters? false This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

OUTPUTS

NOTES

Example 1: Find a script and install it

PS C:\>Find-Script -Repository "Local1" -Name "Required-Script2"

Version Name Type Repository Description

------- ---- ---- ---------- -----------

2.5 Required-Script2 Script local1 Description for the

Required-Script2 script PS C:\>Find-Script -Repository "Local1" -Name "Required-Script2" | Install-Script

PS C:\> Get-Command -Name "Required-Script2"

CommandType Name Version Source

----------- ---- ------- ------

ExternalScript Required-Script2.ps1 2.0

C:\Users\pattif\Documents\WindowsPowerShell\Scripts\Required-Script2.ps1 PS C:\>Get-InstalledScript -Name

"Required-Script2"

Version Name Type Repository Description

------- ---- ---- ---------- -----------

2.5 Required-Script2 Script local1 Description for the

Required-Script2 script PS C:\>Get-InstalledScript -Name "Required-Script2" | Format-List *

Name : Required-Script2

Version : 2.5 Type : Script

Description : Description for the Required-Script2 script

Author : pattif

CompanyName :

LicenseUri : http://required-script2.com/license

ProjectUri : http://required-script2.com/

IconUri : http://required-script2.com/icon

Tags : {Tag1, Tag2, Tag-Required-Script2-2.5, PSScript...}

Includes : {Function, DscResource, Cmdlet, Command} PowerShellGetFormatVersion :

ReleaseNotes : Required-Script2 release notes

Dependencies : {}

RepositorySourceLocation : http://pattif-dev:8765/api/v2/

Repository : local1 PackageManagementProvider : NuGet InstalledLocation : C:\Users\pattif\Documents\WindowsPowerShell\Scripts

The first command finds the script named Required-Script2 from the Local1 repository and displays the results.

The second command finds the Required-Script2 script, and then uses the pipeline operator to pass it to the

Install-Script cmdlet to install it.

The third command uses the Get-Command cmdlet to get Required-Script2, and then displays the results.

The fourth command uses the Get-InstalledScript cmdlet to get Required-Script2 and display the results.

The fifth command gets RequiredScript2 and uses the pipeline operator to pass it to the Format-List cmdlet to

format the output.

Example 2: Install a script with AllUsers scope

PS C:\>Install-Script -Repository "Local1" -Name "Required-Script3" -Scope "AllUsers"

PS C:\> Get-InstalledScript -Name "Required-Script3"

Version Name Type Repository Description

------- ---- ---- ---------- -----------

2.5 Required-Script3 Script local1 Description for the

Required-Script3 script PS C:\>Get-InstalledScript -Name "Required-Script3" | Format-List *

Name : Required-Script3

Version : 2.5 Type : Script

Description : Description for the Required-Script3 script

Author : pattif

CompanyName :

LicenseUri : http://required-script3.com/license

ProjectUri : http://required-script3.com/

IconUri : http://required-script3.com/icon

Tags : {Tag1, Tag2, Tag-Required-Script3-2.5, PSScript...}

Includes : {Function, DscResource, Cmdlet, Command} PowerShellGetFormatVersion :

ReleaseNotes : Required-Script3 release notes

Dependencies : {}

RepositorySourceLocation : http://pattif-dev:8765/api/v2/

Repository : local1 PackageManagementProvider : NuGet InstalledLocation : C:\Program Files\WindowsPowerShell\Scripts

The first command installs the script named Required-Script3 and assigns it AllUsers scope.

The second command gets the installed script Required-Script3 and displays information about it.

The third command gets Required-Script3 and uses the pipeline operator to pass it to the Format-List cmdlet to

format the output.

Example 3: Install a script with its dependent scripts and modules

PS C:\>Find-Script -Repository "Local1" -Name "Script-WithDependencies2" -IncludeDependencies

Version Name Type Repository Description

------- ---- ---- ---------- -----------

2.0 Script-WithDependencies2 Script local1 Description for the

Script-WithDependencies2 script

2.5 RequiredModule1 Module local1 RequiredModule1 module 2.5 RequiredModule2 Module local1 RequiredModule2 module 2.5 RequiredModule3 Module local1 RequiredModule3 module

2.5 Required-Script1 Script local1 Description for the

Required-Script1 script

2.5 Required-Script2 Script local1 Description for the

Required-Script2 script

2.5 Required-Script3 Script local1 Description for the

Required-Script3 script PS C:\>Install-Script -Repository "Local1" -Name "Script-WithDependencies2"

PS C:\> Get-InstalledScript

Version Name Type Repository Description

------- ---- ---- ---------- -----------

2.5 Required-Script1 Script local1 Description for the

Required-Script1 script

2.5 Required-Script2 Script local1 Description for the

Required-Script2 script

2.5 Required-Script3 Script local1 Description for the

Required-Script3 script

2.0 Script-WithDependencies2 Script local1 Description for the

Script-WithDependencies2 script PS C:\>Get-InstalledModule

Version Name Type Repository Description

------- ---- ---- ---------- -----------

2.5 RequiredModule1 Module local1 RequiredModule1 module 2.5 RequiredModule2 Module local1 RequiredModule2 module 2.5 RequiredModule3 Module local1 RequiredModule3 module PS

C:\>Find-Script -Repository "Local1" -Name "Required-Script*"

Version Name Type Repository Description

------- ---- ---- ---------- -----------

2.5 Required-Script1 Script local1 Description for the

Required-Script1 script

2.5 Required-Script2 Script local1 Description for the

Required-Script2 script

2.5 Required-Script3 Script local1 Description for the

Required-Script3 script PS C:\>Install-Script -Repository "Local1" -Name "Required-Script*"

PS C:\> Get-InstalledScript

Version Name Type Repository Description

------- ---- ---- ---------- -----------

2.5 Required-Script1 Script local1 Description for the

Required-Script1 script

2.5 Required-Script2 Script local1 Description for the

Required-Script2 script

2.5 Required-Script3 Script local1 Description for the

Required-Script3 script

The first command finds the script named Script-WithDependencies2 and its dependencies in the Local1 repository

and displays the results.

The second command installs Script-WithDependencies2.

The third command uses the Get-InstalledScript script cmdlet to get installed scripts and display the results.

The fourth command uses the Get-InstalledModule cmdlet to get installed modules and display the results.

The fifth command uses the Find-Script cmdlet to find scripts where the name begins with Required-Script and

display the results.

The sixth command installs the scripts where the name begins with Required-Script in the Local1 repository.

The final command gets installed scripts and displays the results.