Find-Script

Finds a script.
Find-Script [[-Name] [<String[]>]] [-AllVersions] [-Command [<String[]>]] [-Filter [<String>]][-IncludeDependencies] [-Includes {Function | Workflow}] [-MaximumVersion [<Version>]] [-MinimumVersion[<Version>]] [-Repository [<String[]>]] [-RequiredVersion [<Version>]] [-Tag [<String[]>]] [<CommonParameters>]

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

Parameters
-AllVersions [<SwitchParameter>]

Indicates that this operation finds all script versions.

-Command [<String[]>]

Specifies an array of commands to find in scripts. A command can be a function or workflow.

-Filter [<String>]

Finds scripts based on the PackageManagement provider-specific search syntax.

-IncludeDependencies [<SwitchParameter>]

Indicates that this operation gets all scripts that are dependent upon the script specified in the Name parameter.

-Includes [<String[]>]

Specifies type of script to get. The acceptable values for this parameter are: Function, Workflow.

-MaximumVersion [<Version>]

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

-MinimumVersion [<Version>]

Specifies the minimum version of the script to find. The MinimumVersion and RequiredVersion parameters are mutually exclusive; you cannot use both parameters in the same command.

-Name [<String[]>]

Specifies an array of names of scripts to find.

-Repository [<String[]>]

Specifies the friendly name of a repository that has been registered by running Register-PSRepository.

-RequiredVersion [<Version>]

Specifies the exact version number of the script to find.

-Tag [<String[]>]

Specifies an array of tags.

<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,ErrorAction, ErrorVariable, WarningAction, WarningVariable,OutBuffer, PipelineVariable, and OutVariable.

Outputs

PSRepositoryItemInfo

Examples
  1. Find all available scripts:
    PS C:> Find-Script
    
       Version    Name                                Type       Repository           Description
       -------    ----                                ----       ----------           -----------
       2.5        Fabrkiam-ClientScript               Script     LocalRepo1           Description for the 
       Fabrkiam-ClientScript script
       2.5        Fabrkiam-Script                     Script     LocalRepo1           Description for the Fabrkiam-Script 
       script
       2.5        Fabrkiam-ServerScript               Script     LocalRepo1           Description for the 
       Fabrkiam-ServerScript script
       2.5        Required-Script1                    Script     LocalRepo1           Description for the 
       Required-Script1 script
       2.5        Required-Script2                    Script     LocalRepo1           Description for the 
       Required-Script2 script
       2.5        Required-Script3                    Script     LocalRepo1           Description for the 
       Required-Script3 script
       2.0        Script-WithDependencies1            Script     LocalRepo1           Description for the 
       Script-WithDependencies1 script
       2.0        Script-WithDependencies2            Script     LocalRepo1           Description for the 
       Script-WithDependencies2 script
       2.0        Start-WFContosoServer               Script     LocalRepo1           Start-WFContosoServer Script example
       2.1        Test-Script1                        Script     LocalRepo1           Test-Script1 Script example
       2.0        Test-Script2                        Script     LocalRepo1           Test-Script2 Script example
       1.0        TestRunbook                         Script     LocalRepo1           Contoso Script example

    This command finds all available scripts.

  2. Find a script by name:
    PS C:> Find-Script -Name "Start-WFContosoServer"
    
       Version    Name                                Type       Repository           Description
       -------    ----                                ----       ----------           -----------
       2.0        Start-WFContosoServer               Script     LocalRepo1           Start-WFContosoServer Script example

    This command find the script named Start-WFContosoServer.

  3. Find a script by name, required version, and from a specified repository:
    PS C:> Find-Script -Name "Required-Script2" -RequiredVersion 2.0 -Repository "LocalRepo01"
    

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

  4. Find a script and format the output as a list:
    PS C:> Find-Script -Name "Required-Script2" -RequiredVersion 2.0 -Repository "LocalRepo1" | Format-List * -Force
    Name                       : Required-Script2
    Version                    : 2.0
    Type                       : Script
    Description                : Description for the Required-Script2 script
    Author                     : pattif
    CompanyName                : Microsoft Corporation
    Copyright                  : c 2015 Microsoft Corporation. All rights reserved. PublishedDate              : 8/14/2015 2:37:01 PM
    LicenseUri                 : http://required-script2.com/license
    ProjectUri                 : http://required-script2.com/
    IconUri                    : http://required-script2.com/icon
    Tags                       : {, Tag1, Tag2, Tag-Required-Script2-2.0...} Includes                   : {Function, DscResource, Cmdlet, Command}
    PowerShellGetFormatVersion : ReleaseNotes               : Required-Script2 release notes
    Dependencies               : {}
    RepositorySourceLocation   : C:MyLocalRepo
    Repository                 : LocalRepo01
    PackageManagementProvider  : NuGet
    

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

  5. Find a script in the specified version range:
    PS C:> 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.

  6. Find all versions of a script:
    PS C:> 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.

  7. Find a script and its dependent modules and scripts:
    PS C:> 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 it dependencies.

  8. Find scripts with the specified tag:
    PS C:> Find-Script -Tag "Tag1" -Repository "LocalRepo1"
    
       Version    Name                                Type       Repository           Description
       -------    ----                                ----       ----------           -----------
       1.0        Fabrkiam-ClientScript               Script     LocalRepo1           Description for the 
       Fabrkiam-ClientScript script

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

  9. Find scripts with specified command name:
    PS C:> 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.

  10. Find scripts with workflows:
    PS C:> Find-Script -Includes "Workflow" -Repository "LocalRepo1"
    
       Version    Name                                Type       Repository           Description
       -------    ----                                ----       ----------           -----------
       2.5        Fabrkiam-ClientScript               Script     LocalRepo1           Description for the 
       Fabrkiam-ClientScript script
       1.0        Fabrkiam-Script                     Script     LocalRepo1           Description for the Fabrkiam-Script 
       script

    This command finds workflow scripts in the LocalRepo1 repository.

  11. Find scripts using wildcards:
    PS C:> 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.

Related Links

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