Get-PackageUpdateInfo
For AI agents: a documentation index is available at /llms.txt; a markdown version of this page is available at /docs/commands/get-packageupdateinfo/index.md.
SYNOPSIS
Retrieve update information for installed PowerShell modules and identify modules that have newer versions available online.
SYNTAX
DefaultSet1 (Default)
Get-PackageUpdateInfo [-Name <string[]>] [-Repository <string[]>] [-ShowOnlyNeededUpdate]
[-ShowToastNotification] [-Force] [<CommonParameters>]
CurrentUser
Get-PackageUpdateInfo [-Name <string[]>] [-Repository <string[]>] [-ShowOnlyNeededUpdate]
[-ShowToastNotification] [-CurrentUser] [-Force] [<CommonParameters>]
AllUsers
Get-PackageUpdateInfo [-Name <string[]>] [-Repository <string[]>] [-ShowOnlyNeededUpdate]
[-ShowToastNotification] [-AllUsers] [-Force] [<CommonParameters>]
ALIASES
This cmdlet has the following aliases,
DESCRIPTION
Get-PackageUpdateInfo inspects locally installed PowerShell modules, compares their installed versions with the versions available in one or more configured repositories, and returns detailed update information.
The command can filter the results to modules that need updates, restrict the search to current-user or all-users module paths, and optionally display Windows toast notifications when updates are available.
It also honors the module’s update-check rules and the configured update-check interval unless you explicitly force a fresh check.
The checking is done via PowerShellGet v2 or v3, depending on the availability of the Microsoft.PowerShell.PSResourceGet module in the system.
EXAMPLES
EXAMPLE 1
PS C:\> Get-PackageUpdateInfo
Retrieves update information for all modules that are discovered from the configured include rules and available repositories. The output shows the installed version, the latest online version, and whether an update is needed. Output can look like:
Name Repository VersionInstalled VersionOnline NeedUpdate Path
PSReadline PSGallery 1.2 1.2 False C:\Program Files\WindowsPowerShell\Modules\PSReadline Pester PSGallery 4.4.0 4.4.2 True C:\Program Files\WindowsPowerShell\Modules\Pester
EXAMPLE 2
PS C:\> Get-PackageUpdateInfo -ShowOnlyNeededUpdate
Returns only those modules where a newer version is available online, making it easier to focus on modules that actually need attention. This will filter output to show only modules where NeedUpdate is True Output can look like:
Name Repository VersionInstalled VersionOnline NeedUpdate Path
Pester PSGallery 4.4.0 4.4.2 True C:\Program Files\WindowsPowerShell\Modules\Pester
EXAMPLE 3
PS C:\> "Pester", "PSReadline" | Get-PackageUpdateInfo
Accepts module names from the pipeline and returns update information for each requested module. This also works with objects that expose a Name property, such as modules returned by Get-Module.
EXAMPLE 4
PS C:\> Get-PackageUpdateInfo -CurrentUser -ShowOnlyNeededUpdate
Checks only modules installed in the current user profile and displays only those modules that have a newer version available online.
PARAMETERS
-AllUsers
Restricts the search to modules installed in shared all-users or system module locations.
Keep in mind, that admin rights are required to update those modules.
Type: SwitchParameter
DefaultValue: False
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: AllUsers
Position: Named
IsRequired: false
ValueFromPipeline: false
ValueFromPipelineByPropertyName: false
ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''
-CurrentUser
Restricts the search to modules installed in the current user profile location.
This is helpful if you’re running without admin rights, which you should always do as your default work preference.
Type: SwitchParameter
DefaultValue: False
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: CurrentUser
Position: Named
IsRequired: false
ValueFromPipeline: false
ValueFromPipelineByPropertyName: false
ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''
-Force
Bypasses the configured update-check interval and performs a fresh comparison immediately.
Type: SwitchParameter
DefaultValue: False
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
Position: Named
IsRequired: false
ValueFromPipeline: false
ValueFromPipelineByPropertyName: false
ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''
-Name
One or more module names to inspect. When this parameter is omitted, the function uses the configured include rules to determine which modules should be checked.
Type: String[]
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
Position: Named
IsRequired: false
ValueFromPipeline: true
ValueFromPipelineByPropertyName: true
ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''
-Repository
One or more PowerShell repositories to query for available module versions. If omitted, the command uses the repositories available on the local system.
Type: String[]
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
Position: Named
IsRequired: false
ValueFromPipeline: false
ValueFromPipelineByPropertyName: false
ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''
-ShowOnlyNeededUpdate
Suppresses modules that are already up to date from the output and returns only modules where an update is available.
Type: SwitchParameter
DefaultValue: False
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
Position: Named
IsRequired: false
ValueFromPipeline: false
ValueFromPipelineByPropertyName: false
ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''
-ShowToastNotification
Displays Windows toast notifications for modules that have updates available when the system supports this feature.
Type: SwitchParameter
DefaultValue: False
SupportsWildcards: false
Aliases:
- ToastNotification
- Notify
ParameterSets:
- Name: (All)
Position: Named
IsRequired: false
ValueFromPipeline: false
ValueFromPipelineByPropertyName: false
ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''
CommonParameters
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.
INPUTS
System.String[]
OUTPUTS
PackageUpdate.Info
NOTES
Version : 1.2.0.0 Author : Andi Bellstedt Date : 2026-06-21 Keywords : PackageUpdateInfo, Update, Module