-
-
Notifications
You must be signed in to change notification settings - Fork 4
Tutorial Show Help
This tutorial will show you how to get the different kind of help content available for every command in the fscps.tools module.
- PowerShell 5.1
- fscps.tools module installed
Please visit the Install as a Administrator or the Install as a Administrator tutorials to learn how to install the tools.
Locate the PowerShell icon, if you don't have it on your desktop or in the task pane, we can locate it in the Windows Start Menu. Search for it or type PowerShell.
You need to import / load the fscps.tools module into the current PowerShell console. Type the following command:
Import-Module -Name fscps.tools
For us to have something to work with, we need to get the list of available functions in the module. Type the following command:
Get-Command -Module fscps.tools
If you want to know more about a specific command, you can pass the name of the desired command to Get-Help
. Type the following command:
Get-Help Get-FSCPSNuget
The help content for every function contains a high level explanation for each available parameter and examples. Type the following command:
Get-Help Get-FSCPSNuget -Full
The help content for every function contains at least 1 example on how run the function. Type the following command:
Get-Help Get-FSCPSNuget -Examples
In this tutorial we showed you how to list help content for a specific command, including the detailed parameter explanation and the examples.