BudiBadu Logo
Samplebadu

PowerShell by Example: Help System Updates

PowerShell 7

Maintaining up-to-date documentation with Update-Help and managing offline help content using Save-Help with this code example for disconnected environments.

Code

# Update all help files (requires Admin)
Update-Help -Force -ErrorAction SilentlyContinue

# Update help for a specific module
Update-Help -Module "Az.Compute" -Verbose

# Save help files for offline use (Air-gapped systems)
$networkShare = "\\Server01\Share\PSHelp"
Save-Help -DestinationPath $networkShare -Module "Microsoft.PowerShell.*"

# Install help from a local source
Update-Help -SourcePath $networkShare

# View online version of help
Get-Help Get-Process -Online

Explanation

PowerShell's help system is designed to be updatable, ensuring that documentation remains accurate as modules evolve and bugs are fixed. Unlike traditional man pages, PowerShell help is not static; the Update-Help cmdlet downloads the latest XML-based help files from the internet and installs them locally. It is best practice to run this cmdlet regularly, often via a scheduled task, to ensure you have access to the most current parameter descriptions and examples. Since help files are stored in system directories, Update-Help typically requires Administrator privileges to execute successfully.

For environments with restricted internet access or air-gapped systems, the Save-Help cmdlet provides a critical bridge. It allows you to download help content on an internet-connected machine and save it to a file share or portable storage device. Administrators can then use Update-Help with the -SourcePath parameter on the disconnected machines to install the documentation from this local repository. This ensures that security restrictions do not compromise the availability of essential documentation for operations teams.

In addition to local help, PowerShell offers direct access to the most current web-based documentation via the -Online parameter of the Get-Help cmdlet. This command launches the default web browser to the official Microsoft Learn page for the specified cmdlet. This is often the most reliable source of truth, as it is updated more frequently than the downloadable help packages and contains community feedback and deeper technical context. Mastering these three cmdlets ensures that you are never left guessing about syntax or parameter usage, regardless of your network environment.

  • Run Update-Help regularly to keep documentation current
  • Use Save-Help for offline or air-gapped environments
  • Access the latest docs instantly with Get-Help -Online
  • Target specific modules to reduce update time and bandwidth

Code Breakdown

2
Update-Help -Force refreshes local help files, overwriting existing content.
5
-Module limits the update to specific modules to save bandwidth and time.
9
Save-Help downloads help files to a specified folder for offline distribution.
15
Get-Help -Online opens the official documentation in the default web browser.