PackageUpdateInfo on PowerShell module PackageUpdateInfo

Overview

Mon, 01 Jan 0001 00:00:00 +0000

PackageUpdateInfo helps you keep installed PowerShell modules up to date. It compares local module versions with versions from configured online repositories (for example PSGallery) and reports when newer versions are available.

What does PackageUpdateInfo do?

The module can:

Query locally installed modules.
Discover current online versions.
Compare versions with configurable sensitivity (major, minor, build, revision).
Show rich output including repository, release notes, author, and project links.
Export results for later import and fast startup workflows.

Why use PackageUpdateInfo?

Convenience

Quickly identify outdated modules without manually checking each one.
Export and import update information for offline or delayed review.
Run update checks in background jobs.
Use optional toast notifications on Windows.

Automation

Schedule update checks using your profile, scheduled tasks, or startup routines.
Enforce an update-check interval to reduce unnecessary repository queries.
Keep custom rules per module pattern for update sensitivity.
Reuse previously exported data for low-latency shell startup.

Flexibility

Include or exclude module name patterns.
Define rule scope and precedence with default and custom rules.
Works on Windows, Linux, and macOS.
Supports Windows PowerShell 5.1 and PowerShell 7+.

Prerequisites

Windows PowerShell 5.1 or PowerShell 7+.
PowerShellGet access to your target repository (for example PSGallery).
Optional: BurntToast module for toast notifications on Windows.

Installation

Install for all users (requires administrative rights):

Operational best practices

Mon, 01 Jan 0001 00:00:00 +0000

This page describes recommended operating patterns for PackageUpdateInfo in interactive shells, profiles, and automation.

Start with default behavior

Reset settings before introducing custom tuning, especially on shared systems:

Set-PackageUpdateSetting -Reset

Inspect current configuration and rules:

Get-PackageUpdateSetting
Get-PackageUpdateRule -IncludeDefaultRule

Use update intervals to reduce noise

Get-PackageUpdateInfo respects UpdateCheckInterval. If the last effective check is still within the configured interval, the cmdlet returns early.

Set an interval that matches your environment:

Troubleshooting

Mon, 01 Jan 0001 00:00:00 +0000

Use this guide when PackageUpdateInfo does not return expected results, skips checks, or fails to import and export data.

Get actionable diagnostics first

Run with verbose output:

Get-PackageUpdateInfo -Verbose

Validate settings and rules:

Get-PackageUpdateSetting
Get-PackageUpdateRule -IncludeDefaultRule

Check is skipped unexpectedly

Symptom:

You see a warning that update checks are skipped because the check interval is not expired.

Cause:

UpdateCheckInterval and recent LastCheck or LastSuccessfulCheck are preventing a new online check.

Resolution:

Add-PackageUpdateRule

Mon, 22 Jun 2026 00:00:00 +0000

SYNOPSIS

Adds a custom rule that controls how module updates are reported.

SYNTAX

__AllParameterSets

Add-PackageUpdateRule [[-Id] <int>] [[-IncludeModuleForChecking] <string[]>]
 [[-ExcludeModuleFromChecking] <string[]>] [[-ReportChangeOnMajor] <bool>]
 [[-ReportChangeOnMinor] <bool>] [[-ReportChangeOnBuild] <bool>] [[-ReportChangeOnRevision] <bool>]
 [[-SettingObject] <Configuration>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>]

ALIASES

This cmdlet has the following aliases,

Export-PackageUpdateInfo

Mon, 22 Jun 2026 00:00:00 +0000

SYNOPSIS

Exports PackageUpdateInfo objects to an XML, JSON, or CSV file.

SYNTAX

__AllParameterSets

Export-PackageUpdateInfo [[-Path] <string>] -InputObject <Info[]> [-OutputFormat <string>]
 [-Encoding <string>] [-Force] [-Append] [-IncludeTimeStamp] [-PassThru] [-WhatIf] [-Confirm]
 [<CommonParameters>]

ALIASES

This cmdlet has the following aliases,

Get-PackageUpdateInfo

Mon, 22 Jun 2026 00:00:00 +0000

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,

Get-PackageUpdateRule

Mon, 22 Jun 2026 00:00:00 +0000

SYNOPSIS

Retrieve one or more package update rules used to control module update checks and reporting.

SYNTAX

ShowAll (Default)

Get-PackageUpdateRule [-IncludeModuleForChecking <string>] [-ExcludeModuleFromChecking <string>]
 [-IncludeDefaultRule] [-SettingObject <Configuration>] [<CommonParameters>]

ById

Get-PackageUpdateRule -Id <int[]> [-SettingObject <Configuration>] [<CommonParameters>]

ALIASES

This cmdlet has the following aliases,

Get-PackageUpdateSetting

Mon, 22 Jun 2026 00:00:00 +0000

SYNOPSIS

Retrieves the PackageUpdateInfo configuration from the module settings file.

SYNTAX

__AllParameterSets

Get-PackageUpdateSetting [[-Path] <string>] [<CommonParameters>]

ALIASES

This cmdlet has the following aliases,

DESCRIPTION

Reads the PackageUpdateInfo configuration file and returns the current module behavior settings as a PackageUpdate.Configuration object. The returned object includes the default and custom update rules, the update check interval, and the timestamps of the last and last successful checks.

Import-PackageUpdateInfo

Mon, 22 Jun 2026 00:00:00 +0000

SYNOPSIS

Imports package update information from a previously exported data file.

SYNTAX

__AllParameterSets

Import-PackageUpdateInfo [[-Path] <string>] [-ShowToastNotification] [-InputFormat <string>]
 [-Encoding <string>] [-WhatIf] [-Confirm] [<CommonParameters>]

ALIASES

This cmdlet has the following aliases,

Release notes v1.2.7.0

Mon, 22 Jun 2026 00:00:00 +0000

Added

Make the module aware of the new PowerShellGet v3.0.0 and use the new command Find-PSResource for online information retrieval, if available. This should speed up the online information retrieval significantly, because Find-PSResource can handle multiple module names in one call, while Find-Module only accept one module name per call.
Add german (de-DE) localization for about_PackageUpdateInfo.help file.
Add spanish (es-ES) localization for about_PackageUpdateInfo.help file.
Add french (fr-FR) localization for about_PackageUpdateInfo.help file.
Add polish (pl-PL) localization for about_PackageUpdateInfo.help file.

Changed

Fix Removed unintended dependency to PSFramework module in the PackageUpdateInfo.psm1 file. This was a leftover from refactoring a while ago. This module is explicitly intended to run without PSFramework. (even I very appreciate PSFramework and use it in many of my projects)
Some code refactoring in the functions of the module (no functional changes, just code style and readability improvements)
Refactoring of the comment-based help in the functions of the module (no functional changes, just code style and readability improvements)
Refactoring about_PackageUpdateInfo.help file with more userfriendly guidance and information about the module and the usage

Remove-PackageUpdateRule

Mon, 22 Jun 2026 00:00:00 +0000

SYNOPSIS

Removes one or more custom update-handling rules from the package update configuration.

SYNTAX

ById (Default)

Remove-PackageUpdateRule -Id <int[]> [-Force] [-PassThru] [-SettingObject <Configuration>] [-WhatIf]
 [-Confirm] [<CommonParameters>]

ByInputObject

Remove-PackageUpdateRule -InputObject <ModuleRule[]> [-Force] [-PassThru]
 [-SettingObject <Configuration>] [-WhatIf] [-Confirm] [<CommonParameters>]

ALIASES

This cmdlet has the following aliases,

Set-PackageUpdateRule

Mon, 22 Jun 2026 00:00:00 +0000

SYNOPSIS

Updates an existing PackageUpdateInfo rule that controls how module version changes are reported.

SYNTAX

ById (Default)

Set-PackageUpdateRule -Id <int> [-IncludeModuleForChecking <string[]>]
 [-ExcludeModuleFromChecking <string[]>] [-ReportChangeOnMajor <bool>] [-ReportChangeOnMinor <bool>]
 [-ReportChangeOnBuild <bool>] [-ReportChangeOnRevision <bool>] [-SettingObject <Configuration>]
 [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>]

ByInputObject

Set-PackageUpdateRule -InputObject <ModuleRule[]> [-IncludeModuleForChecking <string[]>]
 [-ExcludeModuleFromChecking <string[]>] [-ReportChangeOnMajor <bool>] [-ReportChangeOnMinor <bool>]
 [-ReportChangeOnBuild <bool>] [-ReportChangeOnRevision <bool>] [-SettingObject <Configuration>]
 [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>]

ALIASES

This cmdlet has the following aliases,

Set-PackageUpdateSetting

Mon, 22 Jun 2026 00:00:00 +0000

SYNOPSIS

Configures update-check behavior and reporting preferences for PackageUpdateInfo.

SYNTAX

SetBehaviour

Set-PackageUpdateSetting [-ExcludeModuleFromChecking <string[]>]
 [-IncludeModuleForChecking <string[]>] [-ReportChangeOnMajor <bool>] [-ReportChangeOnMinor <bool>]
 [-ReportChangeOnBuild <bool>] [-ReportChangeOnRevision <bool>] [-UpdateCheckInterval <timespan>]
 [-LastCheck <datetime>] [-LastSuccessfulCheck <datetime>] [-InputObject <Configuration>]
 [-Path <string>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>]

ResetBehaviour

Set-PackageUpdateSetting [-Reset] [-Path <string>] [-PassThru] [-WhatIf] [-Confirm]
 [<CommonParameters>]

ALIASES

This cmdlet has the following aliases,

Show-PackageUpdateReleaseNote

Mon, 22 Jun 2026 00:00:00 +0000

SYNOPSIS

Displays release notes for one or more PowerShell modules.

SYNTAX

ByPackageUpdeInfoObject

Show-PackageUpdateReleaseNote [[-InputObject] <Info[]>] [-WhatIf] [-Confirm] [<CommonParameters>]

ByModuleObject

Show-PackageUpdateReleaseNote [[-Module] <psmoduleinfo[]>] [-WhatIf] [-Confirm] [<CommonParameters>]

ALIASES

This cmdlet has the following aliases,

Legal Notice

Sun, 18 Jan 2026 00:00:00 +0000

Information pursuant to Section 5 of the German Telemedia Act (TMG)

Legal notice

Andreas Bellstedt
Brunnenstr. 38
75387 Neubulach
Germany

Contact

Email: blog@andibellstedt.com

Legal form / business status

This website is operated by a private individual / sole proprietor.

Responsible for content pursuant to Section 55(2) of the German Interstate Broadcasting Treaty (RStV)

Andreas Bellstedt
(Address above)

Liability for content

As a service provider, we are responsible for our own content on these pages in accordance with Section 7(1) TMG under general law. Pursuant to Sections 8–10 TMG, however, we are not obligated to monitor transmitted or stored third‑party information or to investigate circumstances that indicate illegal activity.

Privacy Policy

Sun, 18 Jan 2026 00:00:00 +0000

Privacy Policy

1. Privacy at a Glance

General Notes

The following notes provide a simple overview of what happens to your personal data when you visit this website. Personal data are all data with which you can be personally identified. Detailed information on the topic of data protection can be found in our privacy policy listed below this text.

Data Collection on this Website

Who is responsible for data collection on this website?

The data processing on this website is carried out by the website operator. Their contact details can be found in the section “Notice on the Data Controller” in this privacy policy.

Release notes v1.2.6.0

Sun, 14 Dec 2025 00:00:00 +0000

Fixed

Update Invoke-WebRequest to use basic parsing (KB5074596)

Release notes v1.2.5.0

Fri, 29 Sep 2023 00:00:00 +0000

Fixed

Issue Issue #33 — Get-PackageUpdateInfo ignores ExcludeModuleFromChecking
- Optimize filtering for module checking against galleries

Updated

Command Get-PackageUpdateInfo — Optimize filtering to fit requirement on issue #33
Command Set-PackageUpdateSetting — Add examples in the documentation
- Please read the examples before putting anything on the exclusion list

Release notes v1.2.4.0

Tue, 26 Sep 2023 00:00:00 +0000

Fixed

Issue #24 — Module version number 1.9 is higher than 1.10
- The online gallery probably delivers version information not as a ‘version’ type, but as a string.

Release notes v1.2.3.0

Thu, 29 Sep 2022 00:00:00 +0000

Fix: Issure #26 - Problem on running PSEdition core & desktop in parallel
- Export/Import commands now writes version specific files by default (e.g. PackageUpdateInfo_Desktop_5.xml)
Fix: Issue #25 - Export-PackageUpdateInfo -PassThru
- fix output issue and date conversion bug
Upd: Add-PackageUpdateRule
- Parameter PassThru now actually works as intended.
Fix: Fixing some typos
Fix: Remove files and command depend on PSFramework
Upd: Add plattform and statistic information to readme file

Release notes v1.2.1.0

Sun, 05 Jan 2020 00:00:00 +0000

Fixed

Ugly error messages if no configuration file exists due to fresh system installation
- Implemented check and warning messages on this behavior
- Add init routine in module loading if no default config file is present

Updated

Try to suppress verbose messages on module up-to-dateness checking in Get-PackageUpdateInfo

Release notes v1.2.0.0

Sun, 29 Dec 2019 00:00:00 +0000

Added

Enabling CORE and cross-platform compatibility
- Code refactoring to bring PackageUpdateInfo into PowerShell version 6 & 7 (CORE)
- Module now also runs on Linux systems
Command Show-PackageUpdateReleaseNote — Possibility to get release notes from websites and display it on the console
Command Get-PackageUpdateSetting — Query the basic settings for check and report on up-to-dateness information on installed modules
Command Set-PackageUpdateSetting — Configure basic settings for check and report on up-to-dateness
Command Add-PackageUpdateRule — Declare how a module is handled in reporting
Command Get-PackageUpdateRule — Get existing custom rules
Command Set-PackageUpdateRule — Edit existing rules on how a module is handled in reporting
Command Remove-PackageUpdateRule — Remove existing custom rules

Updated

Remove dependency on module BurntToast
- For now, BurntToast is an optional module in PackageUpdateInfo
- Toast notifications are available on Windows 10 in ‘Windows PowerShell’ and ‘PowerShell’ (Core)

Features

Get-PackageUpdateSetting introduces:
- UpdateCheckInterval — how often Get-PackageUpdateInfo seeks out for query updates on modules (default: once per hour)
- DefaultRule — general checking on which module to include/exclude and which part of the version number triggers an update report

Release notes v1.1.1.0

Tue, 12 Feb 2019 00:00:00 +0000

Fixed

Command Get-PackageUpdateInfo
- Fix Issue #11 — error on command when more than 63 modules are installed. The command Find-Module only accepts a maximum number of 63 strings in the Name parameter. Workaround with a for-each loop around this one.

Release notes v1.1.0.0

Sat, 09 Feb 2019 00:00:00 +0000

Added

Command Get-PackageUpdateInfo
- Possibility to push ToastNotification for update infos with BurntToast module by specifying -ShowToastNotification switch
New dependency to module BurntToast

Updated

Add Description info on PackageUpdate.Info objects

Fixed

Command Get-PackageUpdateInfo
- In 1.0.2.0 ReleaseNotes and PublishDate of all modules were put into every PackageUpdate.Info. Used wrong variable. Fixed.
- Minor change in debug output on version comparison

Release notes v1.0.2.0

Sun, 13 Jan 2019 00:00:00 +0000

New: Add changelog ;-)
Upd: Command Get-PackageUpdateInfo
- add properties on output object
  - ProjectUri
  - IconUri
  - ReleaseNotes
  - Author
  - PublishedDate
Upd: Reformat code to meet codestyle OTBS - K&R(One True Brace Style variant)

Release notes v1.0.1.0 (Initial release)

Sat, 10 Nov 2018 00:00:00 +0000

Initial release

Added

Get-PackageUpdateInfo — Query all installed modules and display update status
Export-PackageUpdateInfo — Export update information to file
Import-PackageUpdateInfo — Import previously exported update information

About the Author

Mon, 01 Jan 0001 00:00:00 +0000

Hello to the World!

I’m Andreas Bellstedt — an IT professional with more than 20 years of experience across enterprise environments. Usually I am called Andi. I’m passionate about technology, but even more about applying it in a way that improves reliability, security, and operational efficiency.

Search Results

Mon, 01 Jan 0001 00:00:00 +0000