sitecorepowershell/console

Sitecore PowerShell Extensions

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.

console's Issues

Line and Column caret position indicators don't work after switching to Ace Editor

New-Item should support -Language parameter

I have multi-language environment. I see that New-item command lacks the language parameter. How can I set the language version of the item to be created? -Language parameter would be nice to have.

Tab Completion Generates invalid path

Removing the single quotes corrects the problem

jQuery must be running in no-conflict mode

When the PowerShell console runs, the browser console shows 2 errors. This is caused by jQuery conflicting with Prototype library used in Sitecore.

Run jQuery in no-conflict mode to prevent it, make sure everything still runs - all modules run in plugin mode.

Add Verbose SwitchParameter support to Write-Log

I was testing out a script today and noticed that using Write-Log will log but not output to the console. This could be useful when writing larger scripts and testing in the ISE.

An alternate approach would be to use -Verbose on Write-Log so that you can toggle it on or off in the ISE.

ISE will no longer show error when executing scripts if user name has dot in the name

ISE saves user settings and last script when they execute. It does so under the following path in master:
/sitecore/system/Modules/PowerShell/Settings/ISE

It creates the settings item for user's domain first and then underneath for your user name.
For default admin it will save your settings in:
/sitecore/system/Modules/PowerShell/Settings/ISE/sitecore/admin

If the user name or domain contained one of those characters that sitecore considers not-kosher for item name the save would fail.

Those characters are now escaped.

private static readonly char[] invalidChars = 
    { '\\', '/', ':', '"', '<', '>', '|', '[', ']', '.' };

_Courtesy of report by Michael West_

Missing ISE Tab Completion

The ISE does not tab complete like the console.

Support installation of update packages

Create a commandlet to support importing of .update packages that are used by Sitecore CMS updates, TDS and are created by Courier

_Courtesy of requested and advice by Michael West_

Fix Defunct Content Editor Integration Toggles

Shift+Enter Help doesn't work.

The Shift+Enter shiwing help for the command no longer works after switch to Ace editor. (Firefox&Chrome tested)

Feature - Cmdlet to run Task Schedule

Something like the Scheduled Task Util project on the market place.

Any name is fine...as long as it doesn't conflict with the PowerShell commands.
Start-TaskScheduler -Name DoSomethingTask

cls & Clear-Host not working

Scripts executed without context item that are showing no results window would fail.

Execute command generates "scContent is not defined"

PowerShell ISE > Script > Execute link generates error output in dev console. (Michael West 2.1 beta release)

Abort script?

Is there a way to abort running script?
I accidently run some heavy searching script on root instead of a small branch. I needed to reset the app to stop it.
It would be nice to be able to force the script to stop... and nicer if that would trigger some partial result to be showed.

CoreDB hosted context scripts will show results window by default rather than hide.

Parameters collected from other commands show for all commands even if not applicable.

The IntelliSense picks up parameters from whole script and displays them as options even if not applicable.

Remove Persistent Session Buffer flush functionality - Use Clear-Host within script instead

Pressing tab for $host.UI produces host . UI

Scripts should be able to call other scripts in the library that are run before the script itself

It's not just experimenting any more - I'm building script libraries with common functionalities and functions, so I want to use those without having to paste them before every script I run.
An example would be a function that formats errors with full stack trace adding "Resolve-Error" function I want to be able to call this function in my scripts so I want my "Resolve-Error" script be run before them so I can make use of them. Kind of like "using" in C#.

I need a way of doing it either from the script or from the script configuration.

New-Item should be able to work with Item given as -Parent rather than paths only

In my environment I have items with the same paths. I workarounded item creation by creating child directly in parent item:

$templateId = New-Object "Sitecore.Data.TemplateID" (New-Object "Sitecore.Data.ID" "{XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX}");
$newItem = $item.Add("test-item", $templateId);

In my case a -Parent and -NewItemName parameters to the New-Item command would be more approprieate as using Path would create Item only under one of my items.

Please note that using parent by newly created item can take it's language version. That would simplify running scripts in multilanguage environment.

Template name that is provided to New-Item should be more flexible

It should accept path that starts with /sitecore/ (when copied from Content Editor) as well as allow for a shorter version when even the /templates/ is skipped for Compatibility with Rocks scripts and convenience.

Generally - remove uncertainty of when the template path will be accepted

ISE - New Script Button

Button to clear the text similar to generating and Untitled1.ps1 script.

Package manipulation commandlets have their FileName parameter name changed to Path

Changed to be consistent with other commandlets and PowerShell

Make Sitecore session exposed to scripts in Windows Powershell

As requested on the Marketplace Console Page
http://marketplace.sitecore.net/en/Modules/Sitecore_PowerShell_console.aspx

SHING CHEN
08:07 PM on Jul 1, 2013

Hi Adam,

The sitecore powershell is very nice. Is it possible to use the features in the standard powershell console? In other words, can i register any of your libraries to import them to the standard powershell console and use them there?

Thanks,
Shing

Get-Command Clear-Host Output

Cls fails in ISE

Same issue as the console, just in the ISE.

Replace jQuery with the last 1.x version

Bring jQuery up to the most current pre-2.0 version.

PowerShell Console showing %((% in places where [ should be in the results - no more

Result for

PS >get-help install-updatepackage

was showing:

    Install-UpdatePackage %((%%((%-RollbackPackagePath%))% <string>%))% 
        -UpgradeAction <UpgradeAction> {Preview | Upgrade} 
        -InstallMode <InstallMode> {Install | Update}  
        %((%<CommonParameters>%))%

where it should be

    Install-UpdatePackage [[-RollbackPackagePath] <string>]
        -UpgradeAction <UpgradeAction> {Preview | Upgrade} 
        -InstallMode <InstallMode> {Install | Update}  
        [<CommonParameters>]

Initially broken in 2.0

_Courtesy of report by Michael West_

Console Adjustments

Not sure how best to title this. Basically I would like to have the region for the cursor to be increased. Currently you have to click about 1 cm from the prompt PS Master:> before the cursor will be placed there.

Also, would like to have the ESC key clear the entire line, like it does in the Windows PowerShell console.

Splitter move does not cause more lines show in the Ace editor.

Add ability to turn off Context Script and Context Terminal for Content Editor in Ise and Conetent Editor (View Tab)

Add Close-Window commandlet to close the Results window from a script

Fix autocomplete and autosuggest for PowerShell 3.0

This has been broken for me since I installed PowerShell 3.0 on my server for some reason.

Extra parentheses in Get-PSDrive description

There is an unnecessary parentheses in the description.
Name Root Description

---

core core: Sitecore database: 'core')

Module Name missing from Get-Command

Michael West 2.1 Beta

Shift+Space autosuggest removed - it causes more problems than it's worth. Shift+Ctrl provides enough context help.

Get-ChildItem and Get-Item should be able to work with ambiguous paths

I have items with the same path in the system (it is not forbidden and sometime it happens). I've noticed that command get-childitem -recurse returns only only first item of those who have the same path.
I'm trying to use Powershell to repair such items so I would expect commands to return the additonal items in some way.

I'll find the items using object properties so there is no problem with it. But the queestion is: it this a feature of commands to treat the item path as unique? If yes and that will be left for better performance I would be happy if there would be some switch to turn that assumption off for example "-nonUniquePaths" param.

Path completion is broken

type:
C:\(Hit Ctrl+Space)
The paths will not get auto-completed in Ace editor.

Shift+Enter Help should find the last command in the line it was launched instead of showing error if not executed after command.

Allow Download-File to skip the dialog that's showing user the download to be started

Default Path for Get-Item

Get-Item should by default return like
Get-Item -Path .

Allow Download-File commandlet to download files from Media Library

Get-Command Blank Line

Add Template name to default Item properties

Make Context Menu scripts in Content Editor - Show/Hide depending on a place in the tree menu is shown.

I need to add the ability to show and hide scripts in the context menu in Content Editor based on the template of the item that is right clicked or the position in the tree.
I'm building a fairly large menu here and all the scripts clutter the context menu.

I need not show them everywhere, but rather only in places in the tree where they make sense.

Integrate with Advanced System Reporter

It should be possible to write Advanced System Reported reports in PowerShell.

Console needs to be able to display progress info

Write-Progress needs to be enabled in ISE and Results popup window.

Get-File renamed to Download-File

Enable scripts to be exposed in Control Panel

The scripts once saved in the proper place in the script library should be available in Sitecore Control Panel