Skip to content
Menu
The Lonely Administrator
  • PowerShell Tips & Tricks
  • Books & Training
  • Essential PowerShell Learning Resources
  • Privacy Policy
  • About Me
The Lonely Administrator

Updating PowerShell About Help

Posted on July 17, 2020July 17, 2020

During some recent work, I realized my new Windows PowerShell 5.1 installs are missing the About help topics. Apparently, this is a known issue, although I don't think it gets a lot of attention. Microsoft is working on improving updateable help for PowerShell 7 which I think will also have a beneficial change for Windows PowerShell. Microsoft has in fact been updating the about topics. All of the help files are open source on GitHub at https://github.com/MicrosoftDocs/PowerShell-Docs/tree/staging/reference. I use the about topics often, so I wrote a PowerShell script to download and install the latest About topics from GitHub.

Manage and Report Active Directory, Exchange and Microsoft 365 with
ManageEngine ADManager Plus - Download Free Trial

Exclusive offer on ADManager Plus for US and UK regions. Claim now!

Download-PSAboutHelp.ps1

The script runs cross platform, although I haven't tested it with PowerShell 6.x. It needs to be run from an elevated session on for Windows PowerShell. The script requires the Platyps module which will be installed if it isn't already. The script does not require git or a GitHub account, although it does rely on the GitHub APIs.

The script can be saved from this Github gist.

This is a script file so you run it with the full path. It will detect your PowerShell version and default location. Although you can specify an alternate path if you don't want to overwrite existing help content. The script has comment-based help if you need it.

Running the Script

When you run the script, it will download the version specific about content from Github to a temporary folder. Each file is then reformatted so that the New-ExternalHelp command from the Platyps module can generate the about help topic.

You may need to restart PowerShell to get the new help topics. Also be aware, that some of the source markdown doesn't format to text very well. We're stuck with the limitations of the Platyps module or the source markdown for now. But it should still be readable as help.

The script downloads and saves content to an EN-US folder. In Windows PowerShell, if you don't see about files under $pshome\en-us you'll want to try this script.

I hope you'll let me know what you think.


Behind the PowerShell Pipeline

Share this:

  • Click to share on X (Opens in new window) X
  • Click to share on Facebook (Opens in new window) Facebook
  • Click to share on Mastodon (Opens in new window) Mastodon
  • Click to share on LinkedIn (Opens in new window) LinkedIn
  • Click to share on Pocket (Opens in new window) Pocket
  • Click to share on Reddit (Opens in new window) Reddit
  • Click to print (Opens in new window) Print
  • Click to email a link to a friend (Opens in new window) Email

Like this:

Like Loading...

Related

2 thoughts on “Updating PowerShell About Help”

  1. Pingback: Weekly Newsletter - PowerShell Digest #001 - Ridicurious
  2. Pingback: Weekly Newsletter - PowerShell Digest #001 - Ridicurious

Comments are closed.

reports

Powered by Buttondown.

Join me on Mastodon

The PowerShell Practice Primer
Learn PowerShell in a Month of Lunches Fourth edition


Get More PowerShell Books

Other Online Content

github



PluralSightAuthor

Active Directory ADSI Automation Backup Books CIM CLI conferences console Friday Fun FridayFun Function functions Get-WMIObject GitHub hashtable HTML Hyper-V Iron Scripter ISE Measure-Object module modules MrRoboto new-object objects Out-Gridview Pipeline PowerShell PowerShell ISE Profile prompt Registry Regular Expressions remoting SAPIEN ScriptBlock Scripting Techmentor Training VBScript WMI WPF Write-Host xml

©2025 The Lonely Administrator | Powered by SuperbThemes!
%d