HOWTO: Add custom cmdlets to PowerGUI

PowerGUI works great with cmdlets from Microsoft, VMware, Quest and other vendors, but what if it does not seem to “see” the ones which you created on your own?

Fear not, the issue is most likely very straight-forward and easy to resolve. Most likely you either don’t have the your PowerShell snapin selected in PowerGUI’s File/PowerShell Libraries, or you forgot to supply a help file for your cmdlets.

So here are the steps to take to make sure your cmdlets show up in PowerGUI admin console and editor as first-class citizens:

1. Make sure your cmdlets have help (creating a help file in PowerShell is very straight-forward with this utility). To check that the help is working open a PowerShell prompt and type:

Get-Help your_cmdlet_name

2. Make sure PowerGUI is using your cmdlets by going to the File/PowerShell Libraries and selecting your PowerShell snapin.

That’s it. Now if you add a node in the PowerGUI admin console all your get-* cmdlets should be there. In the editor, your cmdlets should get tooltips, intellisense, and F1 help. Your snapin is now as good as everybody’s else!🙂

Tags: , , ,

2 Responses to “HOWTO: Add custom cmdlets to PowerGUI”


  1. 1 Marco Shaw April 11, 2008 at 12:47 pm

    This is a more recent posting from Microsoft:
    http://blogs.msdn.com/powershell/archive/2007/09/01/new-and-improved-cmdlet-help-editor-tool.aspx

    Although, I think both posts point to the same downloadable file.

    Marco

  2. 2 dmitrysotnikov April 11, 2008 at 12:59 pm

    Thanks Marco! I’ve updated the post so it references the more recent help-tool description.


Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s




My Recent Tweets

Legal

The posts on this blog are provided “as is” with no warranties and confer no rights. The opinions expressed on this site are mine and mine alone, and do not necessarily represent those of my employer - WSO2 or anyone else for that matter. All trademarks acknowledged.

© 2007-2014 Dmitry Sotnikov

April 2008
M T W T F S S
« Mar   May »
 123456
78910111213
14151617181920
21222324252627
282930  

%d bloggers like this: