@antonytm/mcp-sitecore-server 1.0.0 → 1.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (165) hide show
  1. package/README.md +3 -0
  2. package/dist/bundle.js +106 -12
  3. package/dist/register.js +7 -0
  4. package/dist/register.js.map +1 -1
  5. package/dist/tools/powershell/documentation/add-basetemplate.md +137 -0
  6. package/dist/tools/powershell/documentation/add-itemacl.md +254 -0
  7. package/dist/tools/powershell/documentation/add-itemversion.md +231 -0
  8. package/dist/tools/powershell/documentation/add-placeholdersetting.md +410 -0
  9. package/dist/tools/powershell/documentation/add-rendering.md +217 -0
  10. package/dist/tools/powershell/documentation/add-rolemember.md +88 -0
  11. package/dist/tools/powershell/documentation/clear-itemacl.md +131 -0
  12. package/dist/tools/powershell/documentation/close-window.md +32 -0
  13. package/dist/tools/powershell/documentation/commands-list.md +134 -0
  14. package/dist/tools/powershell/documentation/convertfrom-clixml.md +67 -0
  15. package/dist/tools/powershell/documentation/convertfrom-itemclone.md +118 -0
  16. package/dist/tools/powershell/documentation/convertto-clixml.md +66 -0
  17. package/dist/tools/powershell/documentation/disable-user.md +89 -0
  18. package/dist/tools/powershell/documentation/enable-user.md +89 -0
  19. package/dist/tools/powershell/documentation/expand-token.md +144 -0
  20. package/dist/tools/powershell/documentation/export-item.md +165 -0
  21. package/dist/tools/powershell/documentation/export-package.md +129 -0
  22. package/dist/tools/powershell/documentation/export-role.md +150 -0
  23. package/dist/tools/powershell/documentation/export-updatepackage.md +111 -0
  24. package/dist/tools/powershell/documentation/export-user.md +147 -0
  25. package/dist/tools/powershell/documentation/find-item.md +718 -0
  26. package/dist/tools/powershell/documentation/get-archive.md +73 -0
  27. package/dist/tools/powershell/documentation/get-archiveitem.md +138 -0
  28. package/dist/tools/powershell/documentation/get-cache.md +62 -0
  29. package/dist/tools/powershell/documentation/get-database.md +96 -0
  30. package/dist/tools/powershell/documentation/get-domain.md +75 -0
  31. package/dist/tools/powershell/documentation/get-item.md +186 -0
  32. package/dist/tools/powershell/documentation/get-itemacl.md +168 -0
  33. package/dist/tools/powershell/documentation/get-itemclone.md +100 -0
  34. package/dist/tools/powershell/documentation/get-itemclonenotification.md +95 -0
  35. package/dist/tools/powershell/documentation/get-itemfield.md +182 -0
  36. package/dist/tools/powershell/documentation/get-itemreference.md +152 -0
  37. package/dist/tools/powershell/documentation/get-itemreferrer.md +154 -0
  38. package/dist/tools/powershell/documentation/get-itemtemplate.md +152 -0
  39. package/dist/tools/powershell/documentation/get-itemworkflowevent.md +133 -0
  40. package/dist/tools/powershell/documentation/get-layout.md +142 -0
  41. package/dist/tools/powershell/documentation/get-layoutdevice.md +97 -0
  42. package/dist/tools/powershell/documentation/get-package.md +63 -0
  43. package/dist/tools/powershell/documentation/get-placeholdersetting.md +477 -0
  44. package/dist/tools/powershell/documentation/get-preset.md +70 -0
  45. package/dist/tools/powershell/documentation/get-rendering.md +248 -0
  46. package/dist/tools/powershell/documentation/get-renderingparameter.md +84 -0
  47. package/dist/tools/powershell/documentation/get-role.md +134 -0
  48. package/dist/tools/powershell/documentation/get-rolemember.md +131 -0
  49. package/dist/tools/powershell/documentation/get-scriptsession.md +128 -0
  50. package/dist/tools/powershell/documentation/get-searchindex.md +92 -0
  51. package/dist/tools/powershell/documentation/get-session.md +107 -0
  52. package/dist/tools/powershell/documentation/get-sitecorejob.md +102 -0
  53. package/dist/tools/powershell/documentation/get-spemodule.md +134 -0
  54. package/dist/tools/powershell/documentation/get-spemodulefeatureroot.md +113 -0
  55. package/dist/tools/powershell/documentation/get-taskschedule.md +136 -0
  56. package/dist/tools/powershell/documentation/get-updatepackagediff.md +110 -0
  57. package/dist/tools/powershell/documentation/get-user.md +193 -0
  58. package/dist/tools/powershell/documentation/get-useragent.md +38 -0
  59. package/dist/tools/powershell/documentation/import-function.md +83 -0
  60. package/dist/tools/powershell/documentation/import-item-1.md +180 -0
  61. package/dist/tools/powershell/documentation/import-item.md +180 -0
  62. package/dist/tools/powershell/documentation/import-role.md +137 -0
  63. package/dist/tools/powershell/documentation/import-user.md +137 -0
  64. package/dist/tools/powershell/documentation/initialize-item.md +87 -0
  65. package/dist/tools/powershell/documentation/initialize-searchindex.md +116 -0
  66. package/dist/tools/powershell/documentation/initialize-searchindexitem.md +85 -0
  67. package/dist/tools/powershell/documentation/install-package.md +95 -0
  68. package/dist/tools/powershell/documentation/install-updatepackage.md +90 -0
  69. package/dist/tools/powershell/documentation/invoke-javascript.md +22 -0
  70. package/dist/tools/powershell/documentation/invoke-script.md +111 -0
  71. package/dist/tools/powershell/documentation/invoke-shellcommand.md +144 -0
  72. package/dist/tools/powershell/documentation/invoke-workflow.md +142 -0
  73. package/dist/tools/powershell/documentation/lock-item.md +157 -0
  74. package/dist/tools/powershell/documentation/login-user.md +56 -0
  75. package/dist/tools/powershell/documentation/logout-user.md +30 -0
  76. package/dist/tools/powershell/documentation/merge-layout.md +102 -0
  77. package/dist/tools/powershell/documentation/new-domain.md +72 -0
  78. package/dist/tools/powershell/documentation/new-explicitfilesource.md +104 -0
  79. package/dist/tools/powershell/documentation/new-explicititemsource.md +146 -0
  80. package/dist/tools/powershell/documentation/new-filesource.md +128 -0
  81. package/dist/tools/powershell/documentation/new-itemacl.md +175 -0
  82. package/dist/tools/powershell/documentation/new-itemclone.md +139 -0
  83. package/dist/tools/powershell/documentation/new-itemsource.md +171 -0
  84. package/dist/tools/powershell/documentation/new-itemworkflowevent.md +140 -0
  85. package/dist/tools/powershell/documentation/new-package.md +81 -0
  86. package/dist/tools/powershell/documentation/new-placeholdersetting.md +255 -0
  87. package/dist/tools/powershell/documentation/new-rendering.md +243 -0
  88. package/dist/tools/powershell/documentation/new-role.md +56 -0
  89. package/dist/tools/powershell/documentation/new-securitysource.md +176 -0
  90. package/dist/tools/powershell/documentation/new-user.md +161 -0
  91. package/dist/tools/powershell/documentation/new-usingblock.md +95 -0
  92. package/dist/tools/powershell/documentation/out-download.md +123 -0
  93. package/dist/tools/powershell/documentation/protect-item.md +120 -0
  94. package/dist/tools/powershell/documentation/publish-item.md +224 -0
  95. package/dist/tools/powershell/documentation/read-variable.md +252 -0
  96. package/dist/tools/powershell/documentation/receive-file.md +244 -0
  97. package/dist/tools/powershell/documentation/receive-itemclonenotification.md +116 -0
  98. package/dist/tools/powershell/documentation/receive-scriptsession.md +108 -0
  99. package/dist/tools/powershell/documentation/remove-archiveitem.md +125 -0
  100. package/dist/tools/powershell/documentation/remove-basetemplate.md +137 -0
  101. package/dist/tools/powershell/documentation/remove-domain.md +70 -0
  102. package/dist/tools/powershell/documentation/remove-itemversion.md +209 -0
  103. package/dist/tools/powershell/documentation/remove-layout.md +151 -0
  104. package/dist/tools/powershell/documentation/remove-placeholdersetting.md +478 -0
  105. package/dist/tools/powershell/documentation/remove-rendering.md +253 -0
  106. package/dist/tools/powershell/documentation/remove-renderingparameter.md +83 -0
  107. package/dist/tools/powershell/documentation/remove-role.md +70 -0
  108. package/dist/tools/powershell/documentation/remove-rolemember.md +79 -0
  109. package/dist/tools/powershell/documentation/remove-scriptsession.md +72 -0
  110. package/dist/tools/powershell/documentation/remove-searchindexitem.md +79 -0
  111. package/dist/tools/powershell/documentation/remove-session.md +77 -0
  112. package/dist/tools/powershell/documentation/remove-user.md +97 -0
  113. package/dist/tools/powershell/documentation/reset-itemfield.md +149 -0
  114. package/dist/tools/powershell/documentation/reset-layout.md +130 -0
  115. package/dist/tools/powershell/documentation/restart-application.md +30 -0
  116. package/dist/tools/powershell/documentation/restore-archiveitem.md +126 -0
  117. package/dist/tools/powershell/documentation/resume-searchindex.md +84 -0
  118. package/dist/tools/powershell/documentation/send-file.md +160 -0
  119. package/dist/tools/powershell/documentation/send-sheermessage.md +66 -0
  120. package/dist/tools/powershell/documentation/set-hostproperty.md +90 -0
  121. package/dist/tools/powershell/documentation/set-itemacl.md +158 -0
  122. package/dist/tools/powershell/documentation/set-itemtemplate.md +156 -0
  123. package/dist/tools/powershell/documentation/set-layout.md +166 -0
  124. package/dist/tools/powershell/documentation/set-rendering.md +213 -0
  125. package/dist/tools/powershell/documentation/set-renderingparameter.md +97 -0
  126. package/dist/tools/powershell/documentation/set-user.md +221 -0
  127. package/dist/tools/powershell/documentation/set-userpassword.md +109 -0
  128. package/dist/tools/powershell/documentation/show-alert.md +53 -0
  129. package/dist/tools/powershell/documentation/show-application.md +150 -0
  130. package/dist/tools/powershell/documentation/show-confirm.md +61 -0
  131. package/dist/tools/powershell/documentation/show-fieldeditor.md +231 -0
  132. package/dist/tools/powershell/documentation/show-input.md +129 -0
  133. package/dist/tools/powershell/documentation/show-listview.md +276 -0
  134. package/dist/tools/powershell/documentation/show-modaldialog.md +137 -0
  135. package/dist/tools/powershell/documentation/show-result.md +158 -0
  136. package/dist/tools/powershell/documentation/show-yesnocancel.md +92 -0
  137. package/dist/tools/powershell/documentation/start-scriptsession.md +230 -0
  138. package/dist/tools/powershell/documentation/start-taskschedule.md +124 -0
  139. package/dist/tools/powershell/documentation/stop-scriptsession.md +78 -0
  140. package/dist/tools/powershell/documentation/stop-searchindex.md +84 -0
  141. package/dist/tools/powershell/documentation/suspend-searchindex.md +84 -0
  142. package/dist/tools/powershell/documentation/switch-rendering.md +248 -0
  143. package/dist/tools/powershell/documentation/test-account.md +74 -0
  144. package/dist/tools/powershell/documentation/test-basetemplate.md +97 -0
  145. package/dist/tools/powershell/documentation/test-itemacl.md +182 -0
  146. package/dist/tools/powershell/documentation/test-rule.md +111 -0
  147. package/dist/tools/powershell/documentation/unlock-item.md +124 -0
  148. package/dist/tools/powershell/documentation/unlock-user.md +84 -0
  149. package/dist/tools/powershell/documentation/unprotect-item.md +124 -0
  150. package/dist/tools/powershell/documentation/update-itemreferrer.md +234 -0
  151. package/dist/tools/powershell/documentation/update-listview.md +139 -0
  152. package/dist/tools/powershell/documentation/update-searchindexitem.md +79 -0
  153. package/dist/tools/powershell/documentation/wait-scriptsession.md +100 -0
  154. package/dist/tools/powershell/documentation/write-log.md +82 -0
  155. package/dist/tools/powershell/get-powershell-documentation.d.ts +2 -0
  156. package/dist/tools/powershell/get-powershell-documentation.js +47 -0
  157. package/dist/tools/powershell/get-powershell-documentation.js.map +1 -0
  158. package/dist/tools/powershell/run-powershell-script.d.ts +3 -0
  159. package/dist/tools/powershell/run-powershell-script.js +13 -0
  160. package/dist/tools/powershell/run-powershell-script.js.map +1 -0
  161. package/dist/tools/sitecore-cli/get-sitecore-cli-documentation.d.ts +3 -0
  162. package/dist/tools/sitecore-cli/get-sitecore-cli-documentation.js +24 -0
  163. package/dist/tools/sitecore-cli/get-sitecore-cli-documentation.js.map +1 -0
  164. package/dist/tools/sitecore-cli/sitecore-cli-documentation.md +70 -0
  165. package/package.json +8 -8
@@ -0,0 +1,104 @@
1
+ # New-ExplicitFileSource
2
+
3
+ Creates new File source that can be added to a Sitecore package.
4
+
5
+ ## Syntax
6
+
7
+ New-ExplicitFileSource \[-Name\] <String> \[-File <FileSystemInfo>\] \[-InstallMode <String>\]
8
+
9
+ ## Detailed Description
10
+
11
+ Creates new File source that can be added to a Sitecore package. Folder provided as Root will be added as well as all of its content provided it matches the filters.
12
+
13
+ © 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
14
+
15
+ ## Parameters
16
+
17
+ ### -Name <String>
18
+
19
+ Name of the file source.
20
+
21
+ | Aliases | |
22
+ | :--- | :--- |
23
+ | Required? | true |
24
+ | Position? | 1 |
25
+ | Default Value | |
26
+ | Accept Pipeline Input? | false |
27
+ | Accept Wildcard Characters? | false |
28
+
29
+ ### -File <FileSystemInfo>
30
+
31
+ Path to the file to be included. this can be automatically discovered if a stream of files is piped to the command.
32
+
33
+ | Aliases | |
34
+ | :--- | :--- |
35
+ | Required? | false |
36
+ | Position? | named |
37
+ | Default Value | |
38
+ | Accept Pipeline Input? | true \(ByValue\) |
39
+ | Accept Wildcard Characters? | false |
40
+
41
+ ### -InstallMode <String>
42
+
43
+ | Aliases | |
44
+ | :--- | :--- |
45
+ | Required? | false |
46
+ | Position? | named |
47
+ | Default Value | |
48
+ | Accept Pipeline Input? | false |
49
+ | Accept Wildcard Characters? | false |
50
+
51
+ ## Outputs
52
+
53
+ The output type is the type of the objects that the cmdlet emits.
54
+
55
+ * Sitecore.Install.Files.ExplicitFileSource
56
+
57
+ ## Notes
58
+
59
+ Help Author: Adam Najmanowicz, Michael West
60
+
61
+ ## Examples
62
+
63
+ ### EXAMPLE
64
+
65
+ Following example creates a new package, adds content of the Console folder \(except the source files\) under the site folder saves it in the Sitecore Package folder + gives you an option to download the saved package.
66
+
67
+ ```powershell
68
+ # Create package
69
+ $package = New-Package "Packing in Powerful Ways";
70
+
71
+ # Set package metadata
72
+ $package.Sources.Clear();
73
+
74
+ $package.Metadata.Author = "Adam Najmanowicz, Michael West";
75
+ $package.Metadata.Publisher = "Powerful Ways";
76
+ $package.Metadata.Version = "1.0";
77
+ $package.Metadata.Readme = 'This text will be visible to people installing your package'
78
+
79
+ # Add content of the Console folder (except the source files) located in the site folder to the package
80
+ $source = Get-ChildItem -exclude *.cs -Path "$AppPath\Console" -Recurse -File | New-ExplicitFileSource -Name "Console Assets"
81
+ $package.Sources.Add($source);
82
+
83
+ # Save package
84
+ Export-Package -Project $package -Path "$($package.Name)-$($package.Metadata.Version).zip" -Zip
85
+
86
+ # Offer the user to download the package
87
+ Download-File "$SitecorePackageFolder\$($package.Name)-$($package.Metadata.Version).zip"
88
+ ```
89
+
90
+ ## Related Topics
91
+
92
+ * [Export-Package](export-package.md)
93
+ * [Get-Package](get-package.md)
94
+ * Import-Package
95
+ * [Install-UpdatePackage](install-updatepackage.md)
96
+ * [New-ExplicitItemSource](new-explicititemsource.md)
97
+ * [New-FileSource](new-filesource.md)
98
+ * [New-ItemSource](new-itemsource.md)
99
+ * [New-Package](new-package.md)
100
+ * [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/)
101
+ * [https://blog.najmanowicz.com/2011/12/19/continuous-deployment-in-sitecore-with-powershell/](https://blog.najmanowicz.com/2011/12/19/continuous-deployment-in-sitecore-with-powershell/)
102
+ * [https://gist.github.com/AdamNaj/f4251cb2645a1bfcddae](https://gist.github.com/AdamNaj/f4251cb2645a1bfcddae)
103
+ * [https://www.youtube.com/watch?v=60BGRDNONo0&list=PLph7ZchYd\_nCypVZSNkudGwPFRqf1na0b&index=7](https://www.youtube.com/watch?v=60BGRDNONo0&list=PLph7ZchYd_nCypVZSNkudGwPFRqf1na0b&index=7)
104
+
@@ -0,0 +1,146 @@
1
+ # New-ExplicitItemSource
2
+
3
+ Creates new Explicit Item Source that can be added to a Sitecore package.
4
+
5
+ ## Syntax
6
+
7
+ New-ExplicitItemSource \[-Item <Item>\] \[-Name\] <String> \[\[-SkipVersions\]\] \[-InstallMode <Undefined \| Overwrite \| Merge \| Skip \| SideBySide>\] \[-MergeMode <Undefined \| Clear \| Append \| Merge>\]
8
+
9
+ ## Detailed Description
10
+
11
+ Creates new Item source that can be added to a Sitecore package. This source only includes items explicitly added to it and not their children.
12
+
13
+ © 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
14
+
15
+ ## Parameters
16
+
17
+ ### -Item <Item>
18
+
19
+ The item to be added to the source. If used in pipeline after e.g. Get-Item the source is created once all items are piped into it.
20
+
21
+ | Aliases | |
22
+ | :--- | :--- |
23
+ | Required? | false |
24
+ | Position? | named |
25
+ | Default Value | |
26
+ | Accept Pipeline Input? | true \(ByValue, ByPropertyName\) |
27
+ | Accept Wildcard Characters? | false |
28
+
29
+ ### -Name <String>
30
+
31
+ Name of the item source.
32
+
33
+ | Aliases | |
34
+ | :--- | :--- |
35
+ | Required? | true |
36
+ | Position? | 1 |
37
+ | Default Value | |
38
+ | Accept Pipeline Input? | false |
39
+ | Accept Wildcard Characters? | false |
40
+
41
+ ### -SkipVersions <SwitchParameter>
42
+
43
+ Add this parameter if you want to skip versions of the item from being included in the source and only include the version provided.
44
+
45
+ | Aliases | |
46
+ | :--- | :--- |
47
+ | Required? | false |
48
+ | Position? | 2 |
49
+ | Default Value | |
50
+ | Accept Pipeline Input? | false |
51
+ | Accept Wildcard Characters? | false |
52
+
53
+ ### -InstallMode <InstallMode>
54
+
55
+ Specifies what installer should do if the item already exists. Possible values:
56
+
57
+ * Undefined - User will have to choose one of the below. But they probably don't really know what should be done so not a preferable option.
58
+ * Overwrite - All versions of the old item are removed and replaced with all versions of the new item. This option basically replaces the old item with new one.
59
+ * Merge - merge with existing item. How the item will be merged is defined with MergeMode parameter
60
+ * Skip - All versions remains unchanged. Other languages remains unchanged. All children remains unchanged.
61
+ * SideBySide - all new item will be created.
62
+
63
+ | Aliases | |
64
+ | :--- | :--- |
65
+ | Required? | false |
66
+ | Position? | named |
67
+ | Default Value | |
68
+ | Accept Pipeline Input? | false |
69
+ | Accept Wildcard Characters? | false |
70
+
71
+ ### -MergeMode <MergeMode>
72
+
73
+ Specifies what installer should do if the item already exists and InstallMode is specified as Merge. Possible values:
74
+
75
+ * Undefined - User will have to choose one of the below. But they probably don't really know what should be done so not a preferable option.
76
+ * Clear - All versions of the old item are removed and replaced with all versions of the new item. This option basically replaces the old item with new one. Other language versions \(those which are not in the package\) are removed but only for items which are in the package. All child items which are not in the package keep other language versions. All child items which are in the package are changed.
77
+ * Append - All versions of the new item are added on top of versions of the previous item. This option allows for further manual merge because all history is preserved, so user can see what was changed. Other languages remains unchanged. All child items which are not in the package keep other language versions. All child items which are in the package are changed.
78
+ * Merge - All versions with the same number in both packages are replaced with versions from installed package. All versions which are in the package but not in the target are added. All versions which are not in the package but are in the target remains unchanged. This option also preserves history, however it might overwrite some of the changes. Other languages remains unchanged. All child items which are in the package are changed.
79
+
80
+ | Aliases | |
81
+ | :--- | :--- |
82
+ | Required? | false |
83
+ | Position? | named |
84
+ | Default Value | |
85
+ | Accept Pipeline Input? | false |
86
+ | Accept Wildcard Characters? | false |
87
+
88
+ ## Inputs
89
+
90
+ The input type is the type of the objects that you can pipe to the cmdlet.
91
+
92
+ * Sitecore.Data.Items.Item
93
+
94
+ ## Outputs
95
+
96
+ The output type is the type of the objects that the cmdlet emits.
97
+
98
+ * Sitecore.Install.Items.ExplicitItemSource
99
+
100
+ ## Notes
101
+
102
+ Help Author: Adam Najmanowicz, Michael West
103
+
104
+ ## Examples
105
+
106
+ ### EXAMPLE
107
+
108
+ Following example creates a new package, adds content/home item and all of its children to it and saves it in the Sitecore Package folder + gives you an option to download the saved package.
109
+
110
+ ```powershell
111
+ $package = New-Package "Packing in Powerful Ways";
112
+
113
+ # Set package metadata
114
+ $package.Sources.Clear();
115
+
116
+ $package.Metadata.Author = "Adam Najmanowicz, Michael West";
117
+ $package.Metadata.Publisher = "Powerful Ways";
118
+ $package.Metadata.Version = "1.0";
119
+ $package.Metadata.Readme = 'This text will be visible to people installing your package'
120
+
121
+ # Add content/home and all of its children to the package
122
+ $source = Get-Item 'master:\content\home\*' | New-ExplicitItemSource -Name 'Home Page' -InstallMode Overwrite
123
+ $package.Sources.Add($source);
124
+
125
+ # Save package
126
+ Export-Package -Project $package -Path "$($package.Name)-$($package.Metadata.Version).zip" -Zip
127
+
128
+ # Offer the user to download the package
129
+ Download-File "$SitecorePackageFolder\$($package.Name)-$($package.Metadata.Version).zip"
130
+ ```
131
+
132
+ ## Related Topics
133
+
134
+ * [Export-Package](export-package.md)
135
+ * [Get-Package](get-package.md)
136
+ * Import-Package
137
+ * [Install-UpdatePackage](install-updatepackage.md)
138
+ * [New-ExplicitFileSource](new-explicitfilesource.md)
139
+ * [New-FileSource](new-filesource.md)
140
+ * [New-ItemSource](new-itemsource.md)
141
+ * [New-Package](new-package.md)
142
+ * [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/)
143
+ * [https://blog.najmanowicz.com/2011/12/19/continuous-deployment-in-sitecore-with-powershell/](https://blog.najmanowicz.com/2011/12/19/continuous-deployment-in-sitecore-with-powershell/)
144
+ * [https://gist.github.com/AdamNaj/f4251cb2645a1bfcddae](https://gist.github.com/AdamNaj/f4251cb2645a1bfcddae)
145
+ * [https://www.youtube.com/watch?v=60BGRDNONo0&list=PLph7ZchYd\_nCypVZSNkudGwPFRqf1na0b&index=7](https://www.youtube.com/watch?v=60BGRDNONo0&list=PLph7ZchYd_nCypVZSNkudGwPFRqf1na0b&index=7)
146
+
@@ -0,0 +1,128 @@
1
+ # New-FileSource
2
+
3
+ Creates new File source that can be added to a Sitecore package.
4
+
5
+ ## Syntax
6
+
7
+ New-FileSource \[-Name\] <String> \[-Root\] <DirectoryInfo> \[\[-IncludeFilter\] <String>\] \[\[-ExcludeFilter\] <String>\] \[-InstallMode <String>\]
8
+
9
+ ## Detailed Description
10
+
11
+ Creates new File source that can be added to a Sitecore package. Folder provided as Root will be added as well as all of its content provided it matches the filters.
12
+
13
+ © 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
14
+
15
+ ## Parameters
16
+
17
+ ### -Name <String>
18
+
19
+ Name of the file source.
20
+
21
+ | Aliases | |
22
+ | :--- | :--- |
23
+ | Required? | true |
24
+ | Position? | 1 |
25
+ | Default Value | |
26
+ | Accept Pipeline Input? | false |
27
+ | Accept Wildcard Characters? | false |
28
+
29
+ ### -Root <DirectoryInfo>
30
+
31
+ Root folder to include in the package
32
+
33
+ | Aliases | |
34
+ | :--- | :--- |
35
+ | Required? | true |
36
+ | Position? | 2 |
37
+ | Default Value | |
38
+ | Accept Pipeline Input? | true \(ByValue\) |
39
+ | Accept Wildcard Characters? | false |
40
+
41
+ ### -IncludeFilter <String>
42
+
43
+ Filter that defines which files will be included.
44
+
45
+ | Aliases | |
46
+ | :--- | :--- |
47
+ | Required? | false |
48
+ | Position? | 3 |
49
+ | Default Value | |
50
+ | Accept Pipeline Input? | false |
51
+ | Accept Wildcard Characters? | false |
52
+
53
+ ### -ExcludeFilter <String>
54
+
55
+ Filter that defines which files will NOT be included.
56
+
57
+ | Aliases | |
58
+ | :--- | :--- |
59
+ | Required? | false |
60
+ | Position? | 4 |
61
+ | Default Value | |
62
+ | Accept Pipeline Input? | false |
63
+ | Accept Wildcard Characters? | false |
64
+
65
+ ### -InstallMode <String>
66
+
67
+ | Aliases | |
68
+ | :--- | :--- |
69
+ | Required? | false |
70
+ | Position? | named |
71
+ | Default Value | |
72
+ | Accept Pipeline Input? | false |
73
+ | Accept Wildcard Characters? | false |
74
+
75
+ ## Outputs
76
+
77
+ The output type is the type of the objects that the cmdlet emits.
78
+
79
+ * Sitecore.Install.Files.FileSource
80
+
81
+ ## Notes
82
+
83
+ Help Author: Adam Najmanowicz, Michael West
84
+
85
+ ## Examples
86
+
87
+ ### EXAMPLE
88
+
89
+ Following example creates a new package, adds content of the Console folder under the site folder saves it in the Sitecore Package folder + gives you an option to download the saved package.
90
+
91
+ ```powershell
92
+ # Create package
93
+ $package = New-Package "Packing in Powerful Ways";
94
+
95
+ # Set package metadata
96
+ $package.Sources.Clear();
97
+
98
+ $package.Metadata.Author = "Adam Najmanowicz, Michael West";
99
+ $package.Metadata.Publisher = "Powerful Ways";
100
+ $package.Metadata.Version = "1.0";
101
+ $package.Metadata.Readme = 'This text will be visible to people installing your package'
102
+
103
+ # Add content of the Console folder in the site folder to the package
104
+ $source = New-FileSource -Name "Console Assets" -Root "$AppPath\Console"
105
+ $package.Sources.Add($source);
106
+
107
+ # Save package
108
+ Export-Package -Project $package -Path "$($package.Name)-$($package.Metadata.Version).zip" -Zip
109
+
110
+ # Offer the user to download the package
111
+ Download-File "$SitecorePackageFolder\$($package.Name)-$($package.Metadata.Version).zip"
112
+ ```
113
+
114
+ ## Related Topics
115
+
116
+ * [Export-Package](export-package.md)
117
+ * [Get-Package](get-package.md)
118
+ * Import-Package
119
+ * [Install-UpdatePackage](install-updatepackage.md)
120
+ * [New-ExplicitFileSource](new-explicitfilesource.md)
121
+ * [New-ExplicitItemSource](new-explicititemsource.md)
122
+ * [New-ItemSource](new-itemsource.md)
123
+ * [New-Package](new-package.md)
124
+ * [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/)
125
+ * [https://blog.najmanowicz.com/2011/12/19/continuous-deployment-in-sitecore-with-powershell/](https://blog.najmanowicz.com/2011/12/19/continuous-deployment-in-sitecore-with-powershell/)
126
+ * [https://gist.github.com/AdamNaj/f4251cb2645a1bfcddae](https://gist.github.com/AdamNaj/f4251cb2645a1bfcddae)
127
+ * [https://www.youtube.com/watch?v=60BGRDNONo0&list=PLph7ZchYd\_nCypVZSNkudGwPFRqf1na0b&index=7](https://www.youtube.com/watch?v=60BGRDNONo0&list=PLph7ZchYd_nCypVZSNkudGwPFRqf1na0b&index=7)
128
+
@@ -0,0 +1,175 @@
1
+ # New-ItemAcl
2
+
3
+ Creates a new access rule for use with Set-ItemAcl and Add-ItemAcl cmdlets.
4
+
5
+ ## Syntax
6
+
7
+ New-ItemAcl \[-Identity\] <AccountIdentity> \[-AccessRight\] <String> \[-PropagationType\] <Unknown \| Descendants \| Entity \| Any> \[-SecurityPermission\] <NotSet \| AllowAccess \| DenyAccess \| AllowInheritance \| DenyInheritance>
8
+
9
+ ## Detailed Description
10
+
11
+ Creates a new access rule for use with Set-ItemAcl and Add-ItemAcl cmdlets.
12
+
13
+ © 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
14
+
15
+ ## Parameters
16
+
17
+ ### -Identity <AccountIdentity>
18
+
19
+ User name including domain for which the access rule is being created. If no domain is specified - 'sitecore' will be used as the default domain.
20
+
21
+ Specifies the Sitecore user by providing one of the following values.
22
+
23
+ ```powershell
24
+ Local Name
25
+ Example: adam
26
+ Fully Qualified Name
27
+ Example: sitecore\adam
28
+ ```
29
+
30
+ | Aliases | |
31
+ | :--- | :--- |
32
+ | Required? | true |
33
+ | Position? | 1 |
34
+ | Default Value | |
35
+ | Accept Pipeline Input? | false |
36
+ | Accept Wildcard Characters? | false |
37
+
38
+ ### -AccessRight <String>
39
+
40
+ The access right to grand or deny. Well known rights are:
41
+
42
+ * field:read - "Field Read" - controls whether an account can read a specific field on an item..
43
+ * field:write - "Field Write" - controls whether an account can update a specific field on an item.
44
+ * item:read - "Read" - controls whether an account can see an item in the content tree and/or on the published Web site, including all of its properties and field values.
45
+ * item:write - "Write" - controls whether an account can update field values. The write access right requires the read access right and field read and field write access rights for individual fields \(field read and field write are allowed by default\).
46
+ * item:rename - "Rename" - controls whether an account can change the name of an item. The rename access right requires the read access right.
47
+ * item:create - "Create" - controls whether an account can create child items. The create access right requires the read access right.
48
+ * item:delete - "Delete" - Delete right for items. controls whether an account can delete an item. The delete access right requires the read access right
49
+
50
+ Important!
51
+
52
+ The Delete command also deletes all child items, even if the account has been denied Delete
53
+
54
+ rights for one or more of the subitems.
55
+
56
+ * item:admin - "Administer" - controls whether an account can configure access rights on an item. The administer access right requires the read and write access rights.
57
+ * language:read - "Language Read" - controls whether a user can read a specific language version of items.
58
+ * language:write - "Language Write" - controls whether a user can update a specific language version of items.
59
+ * site:enter - controls whether a user can access a specific site.
60
+ * insert:show - "Show in Insert" - Determines if the user can see the insert option
61
+ * workflowState:delete - "Workflow State Delete" - controls whether a user can delete items which are currently associated with a specific workflow state.
62
+ * workflowState:write - "Workflow State Write" - controls whether a user can update items which are currently associated with a specific workflow state.
63
+ * workflowCommand:execute - "Workflow Command Execute" - — controls whether a user is shown specific workflow commands.
64
+ * profile:customize - "Customize Profile Key Values" - The right to input out of range values of profile keys, that belong to this profile.
65
+ * bucket:makebucket - "Create Bucket" - convert item to bucket.
66
+ * bucket:unmake - "Revert Bucket" - convert item back from bucket.
67
+ * remote:fieldread - "Field Remote Read" - Field Read right for remoted clients.
68
+
69
+ | Aliases | |
70
+ | :--- | :--- |
71
+ | Required? | true |
72
+ | Position? | 2 |
73
+ | Default Value | |
74
+ | Accept Pipeline Input? | false |
75
+ | Accept Wildcard Characters? | false |
76
+
77
+ ### -PropagationType <PropagationType>
78
+
79
+ The PropagationType enumeration determines which items will be granted the access right.
80
+
81
+ * Any - the item and all items inheriting
82
+ * Descendants - applies rights to inheriting children only
83
+ * Entity - applies right to the item only
84
+
85
+ | Aliases | |
86
+ | :--- | :--- |
87
+ | Required? | true |
88
+ | Position? | 3 |
89
+ | Default Value | |
90
+ | Accept Pipeline Input? | false |
91
+ | Accept Wildcard Characters? | false |
92
+
93
+ ### -SecurityPermission <SecurityPermission>
94
+
95
+ The SecurityPermission determines whether to grant \(allow\) or deny the access right, and deny or allow inheritance of the right.
96
+
97
+ * AllowAccess -
98
+ * DenyAccess -
99
+ * AllowInheritance -
100
+ * DenyInheritance -
101
+
102
+ | Aliases | |
103
+ | :--- | :--- |
104
+ | Required? | true |
105
+ | Position? | 4 |
106
+ | Default Value | |
107
+ | Accept Pipeline Input? | false |
108
+ | Accept Wildcard Characters? | false |
109
+
110
+ ## Outputs
111
+
112
+ The output type is the type of the objects that the cmdlet emits.
113
+
114
+ * Sitecore.Security.AccessControl.AccessRule
115
+
116
+ ## Notes
117
+
118
+ Help Author: Adam Najmanowicz, Michael West
119
+
120
+ ## Examples
121
+
122
+ ### EXAMPLE 1
123
+
124
+ Creates an access rule that allows the "sitecore\adam" user to delete the item to which it will be applied and all of its childre
125
+
126
+ ```powershell
127
+ PS master:\> New-ItemAcl -AccessRight item:delete -PropagationType Any -SecurityPermission AllowAccess -Identity "sitecore\adam"
128
+
129
+ Account AccessRight PermissionType PropagationType SecurityPermission
130
+ ------- ----------- -------------- --------------- ------------------
131
+ sitecore\admin item:delete Access Any AllowAccess
132
+ ```
133
+
134
+ ### EXAMPLE 2
135
+
136
+ Allows the "sitecore\adam" user to delete the Home item and all of its children. Denies the "sitecore\mikey" user reading the descendants of the Home item. ;P The security info is created prior to adding it to the item. The item is delivered to the Add-ItemAcl from the pipeline and returned to the pipeline after processing due to the -PassThru parameter. The security information is added to the previously existing security qualifiers.
137
+
138
+ ```powershell
139
+ $acl1 = New-ItemAcl -AccessRight item:delete -PropagationType Any -SecurityPermission AllowAccess -Identity "sitecore\adam"
140
+ $acl2 = New-ItemAcl -AccessRight item:read -PropagationType Descendants -SecurityPermission DenyAccess -Identity "sitecore\mikey"
141
+ Get-Item -Path master:\content\home | Add-ItemAcl -AccessRules $acl1, $acl2 -PassThru
142
+
143
+ Name Children Languages Id TemplateName
144
+ ---- -------- --------- -- ------------
145
+ Home False {en, ja-JP, de-DE, da} {110D559F-DEA5-42EA-9C1C-8A5DF7E70EF9} Sample Item
146
+ ```
147
+
148
+ ### EXAMPLE 3
149
+
150
+ Allows the "sitecore\adam" user to delete the Home item and all of its children. Denies the "sitecore\mikey" user reading the descendants of the Home item. ;P The security info is created prior to setting it to the item. The item is delivered to the Set-ItemAcl from the pipeline and returned to the pipeline after processing due to the -PassThru parameter. Any previuous security information on the item is removed.
151
+
152
+ ```powershell
153
+ $acl1 = New-ItemAcl -AccessRight item:delete -PropagationType Any -SecurityPermission AllowAccess -Identity "sitecore\adam"
154
+ $acl2 = New-ItemAcl -AccessRight item:read -PropagationType Descendants -SecurityPermission DenyAccess -Identity "sitecore\mikey"
155
+ Get-Item -Path master:\content\home | Set-ItemAcl -AccessRules $acl1, $acl2 -PassThru
156
+
157
+ Name Children Languages Id TemplateName
158
+ ---- -------- --------- -- ------------
159
+ Home False {en, ja-JP, de-DE, da} {110D559F-DEA5-42EA-9C1C-8A5DF7E70EF9} Sample Item
160
+ ```
161
+
162
+ ## Related Topics
163
+
164
+ * [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/)
165
+ * [Add-ItemAcl](add-itemacl.md)
166
+ * [Clear-ItemAcl](clear-itemacl.md)
167
+ * [Get-ItemAcl](get-itemacl.md)
168
+ * [Set-ItemAcl](set-itemacl.md)
169
+ * [Test-ItemAcl](test-itemacl.md)
170
+ * [https://sdn.sitecore.net/upload/sitecore6/security\_administrators\_cookbook\_a4.pdf](https://sdn.sitecore.net/upload/sitecore6/security_administrators_cookbook_a4.pdf)
171
+ * [https://sdn.sitecore.net/upload/sitecore6/61/security\_reference-a4.pdf](https://sdn.sitecore.net/upload/sitecore6/61/security_reference-a4.pdf)
172
+ * [https://sdn.sitecore.net/upload/sitecore6/64/content\_api\_cookbook\_sc64\_and\_later-a4.pdf](https://sdn.sitecore.net/upload/sitecore6/64/content_api_cookbook_sc64_and_later-a4.pdf)
173
+ * [https://www.sitecore.net/learn/blogs/technical-blogs/john-west-sitecore-blog/posts/2013/01/sitecore-security-access-rights.aspx](https://www.sitecore.net/learn/blogs/technical-blogs/john-west-sitecore-blog/posts/2013/01/sitecore-security-access-rights.aspx)
174
+ * [https://briancaos.wordpress.com/2009/10/02/assigning-security-to-items-in-sitecore-6-programatically/](https://briancaos.wordpress.com/2009/10/02/assigning-security-to-items-in-sitecore-6-programatically/)
175
+
@@ -0,0 +1,139 @@
1
+ # New-ItemClone
2
+
3
+ Creates a new item clone based on the item provided.
4
+
5
+ ## Syntax
6
+
7
+ New-ItemClone \[-Item\] <Item> -Destination <Item> \[-Name <String>\] \[-Recurse\]
8
+
9
+ New-ItemClone \[-Path\] <String> -Destination <Item> \[-Name <String>\] \[-Recurse\]
10
+
11
+ New-ItemClone -Id <String> \[-Database <String>\] -Destination <Item> \[-Name <String>\] \[-Recurse\]
12
+
13
+ ## Detailed Description
14
+
15
+ Creates a new item clone based on the item provided.
16
+
17
+ © 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
18
+
19
+ ## Parameters
20
+
21
+ ### -Destination <Item>
22
+
23
+ Parent item under which the clone should be created.
24
+
25
+ | Aliases | |
26
+ | :--- | :--- |
27
+ | Required? | true |
28
+ | Position? | named |
29
+ | Default Value | |
30
+ | Accept Pipeline Input? | false |
31
+ | Accept Wildcard Characters? | false |
32
+
33
+ ### -Name <String>
34
+
35
+ Name of the item clone.
36
+
37
+ | Aliases | |
38
+ | :--- | :--- |
39
+ | Required? | false |
40
+ | Position? | named |
41
+ | Default Value | |
42
+ | Accept Pipeline Input? | false |
43
+ | Accept Wildcard Characters? | false |
44
+
45
+ ### -Recurse <SwitchParameter>
46
+
47
+ Add the parameter to clone thw whole branch rather than a single item.
48
+
49
+ | Aliases | |
50
+ | :--- | :--- |
51
+ | Required? | false |
52
+ | Position? | named |
53
+ | Default Value | |
54
+ | Accept Pipeline Input? | false |
55
+ | Accept Wildcard Characters? | false |
56
+
57
+ ### -Item <Item>
58
+
59
+ The item to be cloned.
60
+
61
+ | Aliases | |
62
+ | :--- | :--- |
63
+ | Required? | true |
64
+ | Position? | 1 |
65
+ | Default Value | |
66
+ | Accept Pipeline Input? | true \(ByValue, ByPropertyName\) |
67
+ | Accept Wildcard Characters? | false |
68
+
69
+ ### -Path <String>
70
+
71
+ Path to the item to be cloned.
72
+
73
+ | Aliases | |
74
+ | :--- | :--- |
75
+ | Required? | true |
76
+ | Position? | 1 |
77
+ | Default Value | |
78
+ | Accept Pipeline Input? | false |
79
+ | Accept Wildcard Characters? | false |
80
+
81
+ ### -Id <String>
82
+
83
+ Id of the item to be cloned
84
+
85
+ | Aliases | |
86
+ | :--- | :--- |
87
+ | Required? | true |
88
+ | Position? | named |
89
+ | Default Value | |
90
+ | Accept Pipeline Input? | false |
91
+ | Accept Wildcard Characters? | false |
92
+
93
+ ### -Database <String>
94
+
95
+ Database of the item to be cloned if item is specified through its ID.
96
+
97
+ | Aliases | |
98
+ | :--- | :--- |
99
+ | Required? | false |
100
+ | Position? | named |
101
+ | Default Value | |
102
+ | Accept Pipeline Input? | false |
103
+ | Accept Wildcard Characters? | false |
104
+
105
+ ## Inputs
106
+
107
+ The input type is the type of the objects that you can pipe to the cmdlet.
108
+
109
+ * Sitecore.Data.Items.Item
110
+
111
+ ## Outputs
112
+
113
+ The output type is the type of the objects that the cmdlet emits.
114
+
115
+ * Sitecore.Data.Items.Item
116
+
117
+ ## Notes
118
+
119
+ Help Author: Adam Najmanowicz, Michael West
120
+
121
+ ## Examples
122
+
123
+ ### EXAMPLE
124
+
125
+ Clone /sitecore/content/home/ under /sitecore/content/new-target/ with the "New Home" name.
126
+
127
+ ```powershell
128
+ PS master:\> $newTarget = Get-Item master:\content\new-target\
129
+ PS master:\> New-ItemClone -Path master:\content\home -Destination $newTarget -Name "New Home"
130
+ ```
131
+
132
+ ## Related Topics
133
+
134
+ * [Get-ItemClone](get-itemclone.md)
135
+ * [ConvertFrom-ItemClone](convertfrom-itemclone.md)
136
+ * New-Item
137
+ * [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/)
138
+ * [https://github.com/SitecorePowerShell/Console/issues/218](https://github.com/SitecorePowerShell/Console/issues/218)
139
+