November 9th, 2013

PowerTip: Use PowerShell to Display Syntax for a Cmdlet

Doctor Scripto
Scripter

Summary: Use Windows PowerShell to display the syntax of a Windows PowerShell cmdlet.

Hey, Scripting Guy! Question How can I use Windows PowerShell to look at the syntax of a cmdlet without the distraction of a lot of additional information?

Hey, Scripting Guy! Answer Use the Get-Help cmdlet, and choose only the Syntax property. 
          (The following example uses the Get-Process cmdlet):

PS C:> (get-help get-process).syntax

 

Get-Process [[-Name] <String[]>] [-ComputerName <String[]>] [-FileVersionInfo]

[-Module] [<CommonParameters>]

Get-Process [-ComputerName <String[]>] [-FileVersionInfo] [-Module] -InputObject

<Process[]> [<CommonParameters>]

Get-Process [-ComputerName <String[]>] [-FileVersionInfo] [-Module] -Id <Int32[]>

[<CommonParameters>]

Get-Process -Id <Int32[]> -IncludeUserName [<CommonParameters>]

Get-Process -IncludeUserName -InputObject <Process[]> [<CommonParameters>]

Get-Process [[-Name] <String[]>] -IncludeUserName [<CommonParameters>] 

Author

The "Scripting Guys" is a historical title passed from scripter to scripter. The current revision has morphed into our good friend Doctor Scripto who has been with us since the very beginning.

0 comments

Discussion are closed.