Find-Script

Module:

PowerShellGet Module

Finds a script.

Find-Script
 [[-Name] <String[]>]
 [-MinimumVersion <String>]
 [-MaximumVersion <String>]
 [-RequiredVersion <String>]
 [-AllVersions]
 [-IncludeDependencies]
 [-Filter <String>]
 [-Tag <String[]>]
 [-Includes <String[]>]
 [-Command <String[]>]
 [-Proxy <Uri>]
 [-ProxyCredential <PSCredential>]
 [-Repository <String[]>]
 [-Credential <PSCredential>]
 [-AllowPrerelease]
 [<CommonParameters>]

The Find-Script cmdlet finds a specified script in registered repositories.

Find-Script

This command finds all available scripts.

Find-Script -Name "Start-WFContosoServer"

This command find the script named Start-WFContosoServer.

Find-Script -Name "Required-Script2" -RequiredVersion 2.0 -Repository "LocalRepo01"

This command finds a script by name and required version in the LocalRepo01 repository.

Find-Script -Name "Required-Script2" -RequiredVersion 2.0 -Repository "LocalRepo1" | Format-List * -Force

This command finds Required-Script2 in the LocalRepo1 repository, and then passes the resulting PSRepositoryItemInfo object to the Format-List cmdlet.

Find-Script -Name "Required-Script2" -MinimumVersion 2.1 -MaximumVersion 2.5 -Repository "LocalRepo1"
Version Name Type Repository Description
------- ---- ---- ---------- -----------
2.5 Required-Script2 Script LocalRepo1 Description for the Required-Script2 script

This command finds all versions of RequiredScript2 between versions 2.1 and 2.5 in the LocalRepo1 respository.

Find-Script -Name "Required-Script02" -AllVersions

Version Name Type Repository Description
------- ---- ---- ---------- -----------
1.0 Required-Script2 Script LocalRepo1 Description for the Required-Script2 script
1.5 Required-Script2 Script LocalRepo1 Description for the Required-Script2 script
2.0 Required-Script2 Script LocalRepo1 Description for the Required-Script2 script
2.5 Required-Script2 Script LocalRepo1 Description for the Required-Script2 script

This command finds all versions of Required-Script02.

Find-Script -Name "Script-WithDependencies1" -IncludeDependencies -Repository "LocalRepo1"

Version Name Type Repository Description
------- ---- ---- ---------- -----------
1.0 Script-WithDependencies1 Script LocalRepo1 Description for the Script-WithDependencies1 script
2.0 RequiredModule3 Script LocalRepo1 RequiredModule3 module
2.5 Required-Script1 Script LocalRepo1 Description for the Required-Script1 script
2.5 Required-Script2 Script LocalRepo1 Description for the Required-Script2 script

This command finds a script and its dependencies.

Find-Script -Tag "Tag1" -Repository "LocalRepo1"

Version Name Type Repository Description
------- ---- ---- ---------- -----------
1.0 Fabrikam-ClientScript Script LocalRepo1 Description for the Fabrikam-ClientScript script

This command finds scripts that have the tag Tag1 in the LocalRepo1 repository

Find-Script -Command Test-FunctionFromScript_Required-Script3 -Repository "LocalRepo1"

Version Name Type Repository Description
------- ---- ---- ---------- -----------
2.5 Required-Script3 Script LocalRepo1 Description for the Required-Script3 script

This command finds a script that contains the specified command name.

Find-Script -Includes "Workflow" -Repository "LocalRepo1"

Version Name Type Repository Description
------- ---- ---- ---------- -----------
2.5 Fabrikam-ClientScript Script LocalRepo1 Description for the Fabrikam-ClientScript script
1.0 Fabrikam-Script Script LocalRepo1 Description for the Fabrikam-Script script

This command finds workflow scripts in the LocalRepo1 repository.

Find-Script -Name "Required-Script*" -Repository "LocalRepo1"
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

This command uses the wildcard character (*) to find scripts that begin with Required-Script.

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.