Advertisements

Get-Help Command: Syntax, Parameters, Examples

-

|

Introduction

Don’t know how to use a PowerShell cmdlet? PowerShell Get-Help cmdlet will give you information about any powerShell command.

In this guide you will learn how to use PowerShell Get-Help cmdlet. Its syntax, parameters and some examples.

Powershell Get-Help Command Syntax

The simplified syntax of Powershell Get-Help is:

Get-Help -Name <cmdlet | function | aliases | workflow | CIM commands | provider |    script> -Parameter <parameter-name> -Examples -Category -Full -Detailed -Online
Some parameters of the Powershell Get-Help cmdlet is not shown above. I only listed parameters you will need for everyday use.
The Get-Help cmdlet can provide PowerShell help information for cmdlets, functions, CIM commands, workflows, providers, aliases and scripts.
Advertisements


Powershell Get-Help Parameters

The table below lists the parameters shown in the last section and what they mean. It also includes examples. For detailed examples, see the Examples later in the guide.

S/NParameter MeaningPowershell Get-Help Example
1NameSpecifies the name of the cmdlet, function, script, workflow, provider or aliasGet-Help -Name Get-Command
2ParameterUsed to specify a parameter of the cmdlet you need to get help forGet-Help -Name Get-Command -Parameter Name
3ExamplesThis parameter does not require an input value. If specified Get-Help will return examples for the cmdletGet-Help -Name Get-Command -Examples
4CategoryDisplays help only for items in the specified category and their aliases. Some accepted values: Alias, Cmdlet, etcGet-Help -Category Alias
5FullDisplays the whole help topic for a cmdlet, including parameters, attributes and examplesGet-Help Get-Command -Full
6DetailedAdds parameter descriptions and examples to the basic help display.Get-Help Get-Command -Detailed
7OnlineOpens the online version of a help topic in the default Internet browserGet-Help Get-Command -Online

Powershell Get-Help Examples

Here are some examples of PowerShell Get-Help cmdlet. In this section I will use Get-Help to get information about the Get-Command cmdlet.

Powershell Get-Help Example 1: Basic Powershell Help

To get the basic help information about the Get-Command cmdlet, run the command below:

Get-Help Get-Command

In this example, the cmdlet is Get-Command. Notice that I did not include the -Name parameter. It doesn’t have to be included. Here is the result of the command in PowerShell.

Get-Help Example 1: Basic Powershell Help:

The command returned SYNOPSIS (description of the cmdlet), its SYNTAX (how to use the cmdlet) and its DESCRIPTION (detailed information about the cmdlet).

Powershell Get-Help Example 2: Detailed and Full Powershell Help

To display more detailed information about a cmdlet, simply include the Detailed parameter. Here is the modified example.

Get-Help Get-Command -Detailed

When you include the Detailed parameter, Get-Help adds parameter descriptions and examples to the basic PowerShell help information.

Get-Help Example 2: Detailed Powershell Help
Most of the information is not shown in the previous image.

Moreover, if you wish to display the full help information about the cmdlet, use the Full parameter.

Here is a sample command:

Get-Help Get-Command -Full

Powershell Get-Help Example 3: Online Powershell Help

If you want Get-Help to open the online help for the cmdlet, use the Online parameter. Get-Help will open the help information for the cmdlet using your default browser.

Here is the command to display the online information for the Get-Command cmdlet.

Get-Help Get-Command -Online

Here is the result. Opened in Chrome (my default browser):

Get-Help Get-Command -Online

Powershell Get-Help Example 4: Category Powershell Help

The Get-Help command has a parameter called Category. You can use this to get help information about any of the following categories:

Alias, Cmdlet, Provider, General, FAQ, Glossary, HelpFile, ScriptCommand, Function, Filter, ExternalScript, All, DefaultHelp, Workflow, DscResource, Class and Configuration

One very useful application of this is to display a full list the Aliases of all PowerShell cmdlets in your computer.

Here is the command:

Get-Help -Category Alias

And the result…

Using cmdlet aliases shortens your script. Next time you are scripting, you can get the aliases of cmdlets using the command above.

In another example, to return ALL the cmdlets in your computer, use the command below:

Get-Help -Category Cmdlet

If you need specific cmdlets, you can use the Where-Object cmdlet to return them.

As an example, to return commands beginning with the words co, use the command below

Get-Help -Category Cmdlet | Where-Object Synopsis -Like "co*"

This will return the cmdlets close to what I want. See the results below:

Get-Help -Category Cmdlet  Where-Object Synopsis -Like

Powershell Get-Help Example 5: Get Examples of a Cmdlet

One of the benefits of the Powershell Get-Help command is that it can give you examples of how to use a cmdlet.

To display examples of how to use Get-Command, use the command below:

Get-Help Get-Command -Examples

The command displays all available examples:

Get-Help Get-Command -Examples

Conclusion

I hope this guide simplified how to use Powershell Get-Help for you. Most importantly, I hope you picked up one or two things you need to write your next PowerShell script.

If you have any question or comment, use the “Leave a Reply” form at the end of this page. You could also share your personal experience with PowerShell.

To learn more about powershell, visit our PowerShell page. You could also search PowerShell to list all our PowerShell guides.

Other Helpful Guides

Additional Resources and References

  • Was this post Helpful?
  • YesNo

LEAVE A REPLY

Please enter your comment!
Please enter your name here

FEATURED POSTS

How to Print Facebook Messages

How to Print Facebook Messages (Directly or from Microsoft Word)

This Itechguide teaches you how to print Facebook messages. You can print Facebook messages directly from Facebook. Or...
How to Embed YouTube Video on Facebook

How to Embed YouTube Video on Facebook

This Itechguide teaches you how to embed YouTube video on Facebook. There are 2 high-level steps discussed in this guide:
How to Cancel Amazon Music Unlimited

How to Cancel Amazon Music Unlimited (PC or Amazon Apps)

This Itechguide teaches you how to cancel Amazon music unlimited. It offers steps to cancel Amazon music unlimited from a PC, Amazon...
How to Change Default Font in Google Docs

How to Change Default Font in Google Docs

This Itechguide teaches you how to change default font in Google Docs. Here are the high-level steps to change default font in...
How to Print Google Slides with Notes

How to Print Google Slides with Notes

This Itechguide teaches you how to print Google Slides with notes.

ADVERTISEMENTS

TRENDING POSTS

Remote Desktop Connection

Remote Desktop Connection an Internal Error Has Occurred [Fixed]

Introduction I recently received the error message "Remote Desktop Connection an Internal Error Has Occurred". It was strange because...

Find My Samsung: Register and Use Samsung Find my Mobile

Introduction Ever wondered how you could find your Samsung phone if you lost it? Find my Samsung or Samsung...
What is the Difference Between PowerShell and CMD?

Windows Powershell vs CMD: Differences and Similarities

Introduction This short guide compares Windows PowerShell vs CMD (Windows command prompt). I will cover the history and nature...
Spotify No Longer Supports this Version of Microsoft Edge

Spotify No Longer Supports this Version of Microsoft Edge [Fixed]

Introduction When you open Spotify web player on Microsoft Edge, you may receive the error message "Spotify No Longer...
Windows 10 Won't Boot

Windows 10 Won’t Boot With Black Screen? 3 Ways to Fix It

Why Won't Windows 10 Boot Up? If your Windows 10 stops with a black screen, the first question in...

BEST OF ITECHGUIDES

C:\G-Drive\Work Tools\Products Portal\1. New Business\2. Content Sites\1. iTechGuides.com\Posts\1. HOW TO\Google

How to Make a Histogram in Google Sheets (from a PC or the App)

Introduction This is a demo on how to make a histogram in Google Sheets. The guide has two sections:...
How to PM on Facebook

How to PM on Facebook (Send a Private Message on Facebook)

Introduction If you are looking to send a friend a private message (PM) on Facebook, you are in the...
How to Burn Windows Server 2019 ISO to USB

How to Burn Windows Server 2019 ISO to USB

Introduction This guide demos how to burn ISO to USB. Specifically, the guide demos how to burn Windows Server...
How to Set Print Area in Google Sheets

How to Set Print Area in Google Sheets

This Itechguide teaches you how to set print area in Google Sheets. This is helpful if you want to print specific cells...
Walmart Baby Registry

Walmart Baby Registry: Your Definitive Guide

Introduction Walmart Baby Registry gives expectant mothers a place to create a list of items they need for their...

ADVERTISEMENTS

RECENT POSTS

Best Spanish Movies on Netflix

Top 10 Best Spanish Movies on Netflix

Firstly, our review is to give you top-notch Spanish movies on Netflix that will captivate you. As a result...

Our 10 Best French Movies on Netflix

Craving to know the best French movies available on Netflix? You are in the right place. We have a...
Best Kids Movies on Netflix

The 10 Best Kids Movies Now on Netflix

Do you want know the best kids movies on Netflix? We have put together a top collection of amazing movies on Netflix.
How to Add Thumbnail to YouTube Video

How to Add Thumbnail to YouTube Video (New or Existing Video)

This Itechguide teaches you how to add thumbnail to YouTube video. The guide offers steps to add thumbnail to YouTube video for...
Best Sci-Fi Movies on Netflix

The 10 Best Sci-Fi Movies to Watch on Netflix

Want the very best of Sci-Fi movies on Netflix? We have a list that will thrill you. The films...

MUST READ

Hotmail email (outlook.live.com)

Hotmail Email (Outlook.com Email): Your Definitive Guide

Introduction I suppose the first question on your mind is, "what happened to Hotmail email?" This is because when...
Best Bollywood on Netflix

Our 10 Best Bollywood to Watch on Netflix

The Bollywood movies experience on Netflix is amazing. This depends on the nature of the Bollywood movies you watch.

GPUPDATE (Group Policy Update Command): Syntax, Parameters, Examples

GPUPDATE Meaning (and What It Does) GPUPDATE means Group Policy Update Command. It is a Windows command line tool...
DISM error 50: dism doesn't support servicing windows PE with the /online option

How to Fix DISM Error 50 in Windows 10 and Windows Server 2016

Introduction Dis you received DISM error 50: "DISM doesn't support servicing windows PE with the /online option"? This is...
add local user windows 10

How to Add a Local User in Windows 10 (3 Methods)

Introduction This guide demos 3 methods to add a local user in Windows 10. Back...

LATEST DEALS

Exclusive Student Offer_Save 10% on selected Surface devices

By using this website you agree to accept our Privacy Policy and Terms & Conditions