Sitecore PowerShell Extensions

A command line and scripting tool built for the Sitecore platform.

Notice

• If you are using version 4.2 or older in your environments we recommend you update them to 5.0+ ASAP
• We recommend that you DO NOT install SPE on Content Delivery servers or run it in setups that face the Internet in an unprotected connections (e.g. outside of a VPN protected environment)

• Sitecore versions 7.x and below are no longer supported with the release of SPE 5.0

The Sitecore PowerShell Extensions module (SPE) provides a robust environment for automating tasks within Sitecore.

Consider some of the following examples to see how SPE can improve your quality of life as a Sitecore developer/administrator:

• Make changes to a large number of pages:

  Get-ChildItem -Path master:\content\home -Recurse | 
  ForEach-Object { $_.Text += "<p>Updated with SPE</p>"  }

• Find the oldest page on your site:

  Get-ChildItem -Path master:\content\home -Recurse | 
  Select-Object -Property Name,Id,"__Updated" | 
  Sort-Object -Property "__Updated"

• Remove a file from the Data directory:

  Get-ChildItem -Path $SitecoreDataFolder\packages -Filter "readme.txt" | Remove-Item

• Rename items in the Media Library:

  Get-ChildItem -Path "master:\media library\Images" | 
  ForEach-Object { Rename-Item -Path $_.ItemPath -NewName ($_.Name + "-old") }

The idea behind the project is to create a scripting environment to work within Sitecore on a granular level to allow you to apply complex modifications and manipulate not just sites, but files and pages on a large scale or perform statistical analysis of your content using a familiar and well documented query language Windows PowerShell.

If you have any questions, comments, or suggegstions with the SPE module, please report them in the Issue Tracker. We'll also gladly respond to any of your questions on Sitecore Shared Source Modules Forum or in the Project Discussion Pages.

Enjoy!

Adam Najmanowicz	Michael West
Founder, Architect & Lead Developer	Developer & Documentation Lead

Resources

• Download from the Releases page. Note that the Marketplace site is no longer maintained, and should not be used.
• Read the SPE user guide.
• See a whole variety of links to SPE material.
• Watch some quick start training videos.