Creating a SharePoint 2013 PowerShell Help Document with Examples

Home > Blogs > PowerShell > Creating a SharePoint 2013 PowerShell Help Document with Examples

Creating a SharePoint 2013 PowerShell Help Document with Examples

Like This Blog 0 Spike Xavier
Added by September 9, 2015

All of this was done inside of the SharePoint 2013 Management Shell running as Administrator in my test and development environment. Do Not Try In Production.

(For instructor-led SharePoint 2013 training, see our course schedule)

I first ran the following command in order to get all the SharePoint Commandlets into the variable:

$com

I then typed $com into the shell and it wrote a list of all the SharePoint commandlets to the host screen!

Next I looped through the collection and got the help documentation including examples for each commandlet and wrote it out to a txt file using the –NoClobber (don’t overwrite) and the –Append (add to the file flags to create a text file of all the SharePoint Commandlets including their help documentation and examples using this line:

(I typed it all on one line in the shell)

I then typed:

And there it was in all its glory, my own personal detailed, comprehensive help file!

My help file is almost 800 pages when I pasted it into Microsoft Word 2013!!

I will keep both the .docx as well as the .txt versions, one for readability and one for copy pasting.

I will be working on outing it to html or xml and creating a JQuery site with the results, but that’s another blog post.

Spike Xavier
SharePoint Instructor – Interface Technical Training
Phoenix, AZ

Videos You May Like

Cable Testers and How to Use them in Network Environments

0 645 1

This content is from our CompTIA Network + Video Certification Training Course. Start training today! In this video, CompTIA Network + instructor Rick Trader demonstrates how to use cable testers in network environments. Let’s look at some tools that we can use to test our different cables in our environment. Cable Testers Properly Wired Connectivity … Continue reading Cable Testers and How to Use them in Network Environments

How to Build in a PSMethod to your PowerShell Code

0 65 0

In this video, PowerShell instructor Jason Yoder shows how to add Methods (PSMethod) to your code using free software that’s added into the PSObject. For instructor-led PowerShell courses, see our course schedule. Microsoft Windows PowerShell Training Download the Building Methods PowerShell script</a> used in this video. <# ╔══════════════════════════════════════════════════════════════════════════════╗ ║ ║ ║ Building Methods ║ ╟──────────────────────────────────────────────────────────────────────────────╢ … Continue reading How to Build in a PSMethod to your PowerShell Code

How to use the PowerShell Script Analyzer to Clean Up Your Code

0 1211 2

In this video, PowerShell instructor Jason Yoder demonstrates how you can use the PowerShell Script Analyzer to help you format your code to best-practices. For instructor-led PowerShell training classes, see our course schedule: Microsoft Windows PowerShell Training Download the PowerShell Analyzer scripts used in this video. <# ╔══════════════════════════════════════════════════════════════════════════════╗ ║ ║ ║ PowerShell Script Analyzer ║ … Continue reading How to use the PowerShell Script Analyzer to Clean Up Your Code

Write a Comment

Share your thoughts...

Please fill out the comment form below to post a reply.