Find-Script

Syntax

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>]

Description

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

Examples

Example 1: Find all available scripts

Find-Script

This command finds all available scripts.

Example 2: Find a script by name

Find-Script -Name "Start-WFContosoServer"

This command find the script named Start-WFContosoServer.

Example 3: Find a script by name, required version, and from a specified repository

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

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

Example 4: Find a script and format the output as a list

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.

Example 5: Find a script in the specified version range

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.

Example 6: Find all versions of a script

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.

Example 7: Find a script and its dependencies

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.

Example 8: Find scripts with the specified tag

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

Example 9: Find scripts with specified command name

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.

Example 10: Find scripts with workflows

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.

Example 11: Find scripts using wildcards

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.

Parameters

-AllowPrerelease

-AllVersions

-Command

-Credential

-Filter

-IncludeDependencies

-Includes

-MaximumVersion

-MinimumVersion

-Name

-Proxy

-ProxyCredential

-Repository

-RequiredVersion

-Tag

Inputs

String[]

String

Uri

PSCredential

Outputs

PSRepositoryItemInfo

Notes

Related Links

• Install-Script
• Publish-Script
• Save-Script
• Uninstall-Script
• Update-Script