Invoke-ShellCommand

Last updated last month

Executes Sitecore Shell command for an item. This command used to be named Execute-ShellCommand - a matching alias added for compatibility with older scripts.

Syntax

Invoke-ShellCommand [-Item] <Item> [-Name] <String> [-Language <String[]>]

Invoke-ShellCommand [-Path] <String> [-Name] <String> [-Language <String[]>]

Invoke-ShellCommand -Id <String> [-Database <String>] [-Name] <String> [-Language <String[]>]

Detailed Description

Executes Sitecore Shell command for an item. e.g. opening dialogs or performing commands that you can find in the Content Editor ribbon or context menu.

© 2010-2017 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions## Aliases

The following abbreviations are aliases for this cmdlet:

  • Execute-ShellCommand

Parameters

-Name <String>

Name of the sitecore command e.g. "item:publishingviewer"

Aliases

Required?

true

Position?

1

Default Value

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Language <String[]>

Language that will be used as source language. If not specified the current user language will be used. Globbing/wildcard supported.

Aliases

Required?

false

Position?

named

Default Value

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Item <Item>

The item to be sent to the command.

Aliases

Required?

true

Position?

1

Default Value

Accept Pipeline Input?

true (ByValue, ByPropertyName)

Accept Wildcard Characters?

false

-Path <String>

Path to the item to be sent to the command - additionally specify Language parameter to fetch different item language than the current user language.

Aliases

Required?

true

Position?

1

Default Value

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Id <String>

Id of the the item to be sent to the command - additionally specify Language parameter to fetch different item language than the current user language.

Aliases

Required?

true

Position?

named

Default Value

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Database <String>

Database containing the item to be sent to the command - can work with Language parameter to narrow the publication scope.

Aliases

Required?

false

Position?

named

Default Value

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • Sitecore.Data.Items.Item

Outputs

The output type is the type of the objects that the cmdlet emits.

  • Sitecore.Data.Items.Item

Notes

Help Author: Adam Najmanowicz, Michael West

Examples

EXAMPLE 1

Launch Publishing Viewer for /sitecore/content/home item.

PS master:\> Get-Item master:\content\home\ | Invoke-ShellCommand "item:publishingviewer"

EXAMPLE 2

Initiate /sitecore/content/home item duplication.

PS master:\> Get-Item master:/content/home | Invoke-ShellCommand "item:duplicate"

EXAMPLE 3

Show properties of the /sitecore/content/home item.

PS master:\> Get-Item master:/content/home | Invoke-ShellCommand "contenteditor:properties"

Related Topics