< Back
Get-ChocolateyPackage
Post
NAME 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.
PARAMETERS
-Name <String>
Name or part of the name of the Package to search for, whether locally or from source(s).
Required? false
Position? 1
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Version <String>
Version of the package you're looking for.
Required? false
Position? 2
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-LocalOnly [<SwitchParameter>]
Restrict the search to the installed package.
Required? false
Position? named
Default value False
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-IdOnly [<SwitchParameter>]
Id Only - Only return Package Ids in the list results. Available in 0.1-0.6+.
Required? false
Position? named
Default value False
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Prerelease [<SwitchParameter>]
Prerelease - Include Prereleases? Defaults to false
Required? false
Position? named
Default value False
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-ApprovedOnly [<SwitchParameter>]
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+
Required? false
Position? named
Default value False
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-ByIdOnly [<SwitchParameter>]
ByIdOnly - Only return packages where the id contains the search filter.
Available in 0.9.10+.
Required? false
Position? named
Default value False
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-IdStartsWith [<SwitchParameter>]
IdStartsWith - Only return packages where the id starts with the search
filter. Available in 0.9.10+.
Required? false
Position? named
Default value False
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-NoProgress [<SwitchParameter>]
Do Not Show Progress - Do not show download progress percentages.
Required? false
Position? named
Default value False
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Exact [<SwitchParameter>]
Exact - Only return packages with this exact name. Available in 0.9.10+.
Required? false
Position? named
Default value False
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Source <Object>
Source - Source location for install. Can use special 'webpi' or 'windowsfeatures' sources. Defaults to
sources.
Required? false
Position? 3
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Credential <PSCredential>
Credential used with authenticated feeds. Defaults to empty.
Required? false
Position? 4
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-CacheLocation <String>
CacheLocation - Location for download cache, defaults to %TEMP% or value in chocolatey.config file.
Required? false
Position? 5
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
<CommonParameters>
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
https://github.com/chocolatey/choco/wiki/CommandsList
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Get-ChocolateyPackage -LocalOnly chocolatey
RELATED LINKS
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.
PARAMETERS
-Name <String>
Name or part of the name of the Package to search for, whether locally or from source(s).
Required? false
Position? 1
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Version <String>
Version of the package you're looking for.
Required? false
Position? 2
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-LocalOnly [<SwitchParameter>]
Restrict the search to the installed package.
Required? false
Position? named
Default value False
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-IdOnly [<SwitchParameter>]
Id Only - Only return Package Ids in the list results. Available in 0.1-0.6+.
Required? false
Position? named
Default value False
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Prerelease [<SwitchParameter>]
Prerelease - Include Prereleases? Defaults to false
Required? false
Position? named
Default value False
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-ApprovedOnly [<SwitchParameter>]
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+
Required? false
Position? named
Default value False
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-ByIdOnly [<SwitchParameter>]
ByIdOnly - Only return packages where the id contains the search filter.
Available in 0.9.10+.
Required? false
Position? named
Default value False
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-IdStartsWith [<SwitchParameter>]
IdStartsWith - Only return packages where the id starts with the search
filter. Available in 0.9.10+.
Required? false
Position? named
Default value False
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-NoProgress [<SwitchParameter>]
Do Not Show Progress - Do not show download progress percentages.
Required? false
Position? named
Default value False
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Exact [<SwitchParameter>]
Exact - Only return packages with this exact name. Available in 0.9.10+.
Required? false
Position? named
Default value False
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Source <Object>
Source - Source location for install. Can use special 'webpi' or 'windowsfeatures' sources. Defaults to
sources.
Required? false
Position? 3
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Credential <PSCredential>
Credential used with authenticated feeds. Defaults to empty.
Required? false
Position? 4
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-CacheLocation <String>
CacheLocation - Location for download cache, defaults to %TEMP% or value in chocolatey.config file.
Required? false
Position? 5
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
<CommonParameters>
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
https://github.com/chocolatey/choco/wiki/CommandsList
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Get-ChocolateyPackage -LocalOnly chocolatey
RELATED LINKS