Sitecore PowerShell Extensions
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.github
Cognifide.PowerShell.Package
Cognifide.PowerShell.Sitecore7
Cognifide.PowerShell.Sitecore8
Cognifide.PowerShell
Data/packages
Documentation
Libraries
Modules
UserConfiguration/App_Config/Include
.gitattributes
.gitignore
Cognifide.PowerShell.sln
Cognifide.PowerShell.sln.DotSettings
Deploy_Functions.ps1
NuGet.config
Post_Build.ps1
README.md
Release process.md
Setup-Module.ps1
deploy.json
deploy.targets
deploy.user.json.sample
license.md
readme-console-ise.png
readme-ise.gif

README.md

Sitecore PowerShell Extensions: a CLI and scripting tool

Sitecore PowerShell Extensions

- If you are using version 4.2 or older in your environments, please update them to 4.3 ASAP
- Please be mindful that we recommend that you DO NOT install it 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)

License

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

Sitecore PowerShell Extensions

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 | % { $_.Text += "<p>Updated with SPE</p>"  }
  • Find the oldest page on your site:
gci master:\content\home -Recurse | select Name,Id,"__Updated" | sort "__Updated"
  • Remove a file from the Data directory:
gci $SitecoreDataFolder\packages -Filter "readme.txt" | ri
  • Rename items in the Media Library:
gci "master:\media library\Images" | % { rni $_.ItemPath -NewName ($_.Name + "-old") }

Note: Aliases and positional parameters were used in the above examples. Use Get-Alias to see them all.

  • gci = Get-ChildItem
  • ri = Remove-Item
  • rni = Rename-Item

If you can answer yes to any of those (and more), you will certainly find this module a powerful and necessary tool.

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 Mike Reynolds
Adam Najmanowicz Michael West Mike Reynolds
Founder, Architect & Lead Developer Developer & Documentation Lead SPE Evangelist

Resources

Download the module from the Sitecore Marketplace.

Read the SPE user guide.

See a whole variety of links to SPE material.

Watch some quick start training videos.

A big "Thank you!" to Cognifide for letting Adam spend some of his working time working on the module!