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

Agile Methodology in Project Management

0 171 0

In this video, you will gain an understanding of Agile and Scrum Master Certification terminologies and concepts to help you make better decisions in your Project Management capabilities. Whether you’re a developer looking to obtain an Agile or Scrum Master Certification, or you’re a Project Manager/Product Owner who is attempting to get your product or … Continue reading Agile Methodology in Project Management

Creating Users and Managing Passwords in Microsoft Office 365

0 739 4

In this Office 365 training video, instructor Spike Xavier demonstrates how to create users and manage passwords in Office 365.   For instructor-led Office 365 training classes, see our course schedulle: Spike Xavier SharePoint Instructor – Interface Technical Training Phoenix, AZ 20347: Enabling and Managing Office 365    

Windows 10 Managing, Deploying and Configuring – December 2, 2015

0 452 1

In this recorded Windows 10 training webinar from December 2, 2015, Windows Server instructor Rick Trader presents the deployment and management of Windows 10 Enterprise and the new Provisioning capability in Windows 10. Learn how to manage Windows 10 deployments using System Center Configuration Manager, Mobile Device Management and Intune. Also included in his presentation … Continue reading Windows 10 Managing, Deploying and Configuring – December 2, 2015

Write a Comment

Share your thoughts...

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