Get-ChocolateyPackage

SYNOPSIS

List the packages from a source or installed on the local machine.

SYNTAX

Get-ChocolateyPackage [[-Name] <String>] [[-Version] <String>] [-LocalOnly] [-IdOnly] [-Prerelease]
 [-ApprovedOnly] [-ByIdOnly] [-IdStartsWith] [-NoProgress] [-Exact] [[-Source] <Object>]
 [[-Credential] <PSCredential>] [[-CacheLocation] <String>] [<CommonParameters>]

DESCRIPTION

This command can list the packages available on the configured source or a specified one. You can also retrieve the list of package installed locally. Finally, you can also use this command to search for a specific package, and specific version.

EXAMPLES

EXAMPLE 1

Get-ChocolateyPackage -LocalOnly chocolatey

PARAMETERS

-Name

Name or part of the name of the Package to search for, whether locally or from source(s).

Type: System.String
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Version

Version of the package you're looking for.

Type: System.String
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-LocalOnly

Restrict the search to the installed package.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-IdOnly

Id Only - Only return Package Ids in the list results. Available in 0.1-0.6+.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Prerelease

Prerelease - Include Prereleases? Defaults to false

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-ApprovedOnly

ApprovedOnly - Only return approved packages - this option will filter out results not from the community repository (https://chocolatey.org/packages). Available in 0.9.10+

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-ByIdOnly

ByIdOnly - Only return packages where the id contains the search filter. Available in 0.9.10+.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-IdStartsWith

IdStartsWith - Only return packages where the id starts with the search filter. Available in 0.9.10+.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-NoProgress

Do Not Show Progress - Do not show download progress percentages.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Exact

Exact - Only return packages with this exact name. Available in 0.9.10+.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Source

Source - Source location for install. Can use special 'webpi' or 'windowsfeatures' sources. Defaults to sources.

Type: System.Object
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Credential

Credential used with authenticated feeds. Defaults to empty.

Type: System.Management.Automation.PSCredential
Parameter Sets: (All)
Aliases:

Required: False
Position: 4
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-CacheLocation

CacheLocation - Location for download cache, defaults to %TEMP% or value in chocolatey.config file.

Type: System.String
Parameter Sets: (All)
Aliases:

Required: False
Position: 5
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

CommonParameters

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

INPUTS

OUTPUTS

NOTES

https://github.com/chocolatey/choco/wiki/CommandsList

RELATED LINKS