liveBook · Manning

Get-Help

As explained in Learn PowerShell in a Month of Lunches: Fourth Edition, Covers Windows, Linux, and macOS

Help is a PowerShell command that displays help content for commands and other PowerShell elements.

Get-Help displays documentation for PowerShell commands and other help topics. Its main jobs are finding commands for a task and showing how to use them. Help is a function wrapper around Get-Help, while Get-Help is the native cmdlet. section 3.3

Give the topic name directly, or search broadly with wildcards. The positional -Name parameter means these forms are equivalent: Help *event* and Get-Help -Name *event*. Broad searches can reveal commands from installed modules, even when those modules are not loaded. section 3.4

Use focused queries when you know what kind of guidance you need:

  • Run Help Register-ObjectEvent for the complete help topic for a command. section 3.4
  • Run Help Get-Item -Example to display built-in usage examples without reading the full topic. section 3.5.5
  • Run Help Get-Item -Full to inspect detailed syntax, parameters, and positional-parameter notation. section 3.5.3
  • Run Get-Help about_* to list conceptual topics such as common parameters and updateable help. section 3.6

Finding an event command

Suppose you need to work with events but do not know the command name. Run Help *event* or Help *object*. Review the returned names, then run Help Register-ObjectEvent to study one candidate. If the output is paged on macOS or Linux, press q to leave less. section 3.4 section 3.3

Help *event*
Help *object*

Compare broad wildcard searches for event-related and object-related help topics before opening a specific command. section 3.4

How Learn PowerShell in a Month of Lunches: Fourth Edition, Covers Windows, Linux, and macOS covers it

How deep it goes
Explains topic lookup, wildcards, examples, full syntax, positional parameters, about topics, and platform paging without covering command implementation.
Examples
Uses Help *event*, Help Register-ObjectEvent, Help Get-Item -Example, Help Get-Item -Full, and Get-Help about_*.
What it assumes
Assumes a PowerShell shell and basic command awareness while teaching command discovery and help reading from practical searches.
What you can do after
Evaluate commands, locate relevant topics, interpret syntax, inspect examples, and continue learning without relying first on external searches.
How it connects
Connects Get-Help with the Help function, help system, about topics, parameters, modules, Get-Command, and less.

Related concepts

This explainer was generated by Manning's knowledge graph from the text of Learn PowerShell in a Month of Lunches: Fourth Edition, Covers Windows, Linux, and macOS. The section links point to the parts of the book it draws on.