Cmdlet Help Editor tool

Cmdlet Help Editor tool

  • Comments 27

Intoducing the Cmdlet Help Editor V1.0

 

Cmdlet Help Editor enables you to create help topics for Windows PowerShell cmdlets in the XML format that Windows PowerShell reads. Help text created in Cmdlet Help Editor can be displayed immediately by a Windows PowerShell get-help command without any additional transforms or formatting.

 

By reflecting on a Windows PowerShell snap-in (PsSnapin) assembly, Cmdlet Help Editor creates a customized documentation interface that includes the cmdlets in the snap-ins, their parameters, and parameter attributes.

 

Cmdlet Help Editor was designed for Windows PowerShell cmdlet developers to make it easy to create excellent cmdlet help. This tool is made available free of charge, but it is not warranted or supported by Microsoft.

You can download the tool from http://www.wassimfayed.com/PowerShell/CmdletHelpEditor.zip

System Requirements

 

Cmdlet Help Editor V1.0 requires that the following operating systems and programs be installed on the computer:

 

  • Windows XP or Windows Server 2003, or a later version of Windows
  • Windows PowerShell 1.0
  • Microsoft .NET 2.0 (for Windows PowerShell 1.0)
  • Microsoft .NET 3.0 (for Cmdlet Help Editor)

 

You can download Windows PowerShell 1.0, and Microsoft .NET 2.0 and .NET 3.0 from the Microsoft Download Center.

 

For additional information and to report bugs/issues with the tool, please contact Wfayed@Microsoft.com

 

Enjoy the tool,

Wassim [MSFT]

Leave a Comment
  • Please add 6 and 3 and type the answer here:
  • Post
  • I can't wait to try this out.  Creating cmdlet help was one of the most painful tasks I've ever had to do.  We all know how important documentation is and anything that makes it easier to generate will be a great boon.

  • EXCELLENT WORK. Just created a help file for the SAPIEN Extensions (www.primalscript.com/freetools) in a few minutes. This is a great tool and the effort is GREATLY appreciated.

  • We loved the tool, I was able to create help and tutorial for our internal users to get to the point sort of thing on our build environment. Does the Help editor tool will be part of the final release? Also any chance to have command line interface that will east many steps.

    -Wael

  • This thing is FANTASTIC!  Thank you!

  • Hi Wassim, great tool! I do have another problem however. I have thousands of lines of PowerShell code that I want to get documented in a consistant way. There are utility libraries and there is a whole bunch of code utilizing these libraries (.ps1 files).

    Any ideas on how to get this documented etc.?

    Thanks, Serge

  • Great tool (but I was expecting it;) - do I have to save the xml file for the whole Snapin or can I save the xml file for each individual Cmdlet?

    Peter

  • Very nice tool and slick UI.  BTW I notice on parameters there are two check boxes for "Globbing" and "Original Globbing" the latter of which is disabled.  So what's that all about?  Are there globbing changes for the next version of PowerShell?

  • Sorry for the delay in responding. I was out of office and now catching up:

    Thank you all for trying the tool.

    Serge, we should have a way for you in our V2 version of PowerShell. Please stay tuned.

    Peter, you can save the file for each individual cmdlet using the Export XML button. later you can merge them all through a simple script. Please refer to the documentation that was released with the tool.

    Keith, The Original Globbing loads the value you have in the loaded help file. Please refer to the documentation file for more info.

    Wassim [MSFT]

  • If you're using Cmdlet Help Editor ( [link] ), please reply here and let us know how it's working for

  • This should be tagged with DOCUMENTATION and TOOL, if not more. It was hard to find this now after I remember seeing it sometime back.

  • Hi,

    The latest version of the Cmdlet Help Editor has been posted on the same link. It contains a few fixes. I recommend you all upgrade to this version:

    http://www.wassimfayed.com/PowerShell/CmdletHelpEditor.zip

    Please let me know if you have any specific questions.

  • The latest version of the Cmdlet Help Editor has been posted on the same link. It contains a few fixes.

  • The latest version of the Cmdlet Help Editor has been posted on the same link. It contains a few fixes

  • I installed the latest version of CmdletHelpEditor. On the first use it crashes.

    Here is the error:

    HelpEditor.exe has encountered a problem and needs to close.

    We are sorry for the inconvenience.

    If you were in the middle of something, the information you were working

    on might be lost.

    When I click the debug button, Visual Studio Just-In-Time Debugger shows this:

    An unhandled exception ('System.Windows.Markup.XamlParseException') occurred in HelpEditor.exe [2172].

    Anyone?

    Shay

    http://scriptolog.blogspot.com

  • Hi,

    I have worked with Shay over the weekend and the issue he had is that he did not have .Net 3.0 installed on his machine. After he installed the Framework, the app worked for him.

Page 1 of 2 (27 items) 12