< Back
Get-PlasterTemplate
Post
NAME Get-PlasterTemplate
SYNOPSIS
Retrieves a list of available Plaster templates that can be used with the Invoke-Plaster cmdlet.
SYNTAX
Get-PlasterTemplate [-IncludeInstalledModules] [<CommonParameters>]
Get-PlasterTemplate [[-Path] <String>] [-Recurse] [<CommonParameters>]
DESCRIPTION
Retrieves a list of available Plaster templates from the specified path or from the set of templates that are
shipped with Plaster. Specifying no arguments will cause only the built-in Plaster templates to be returned.
Using the -IncludeInstalledModules switch will also search the PSModulePath for PowerShell modules that advertise
Plaster templates that they include.
The objects returned from this cmdlet will provide details about each individual template that was retrieved. Use
the TemplatePath property of a template object as the input to Invoke-Plaster's -TemplatePath parameter.
PARAMETERS
-IncludeInstalledModules [<SwitchParameter>]
Initiates a search for Plaster templates inside of installed modules.
Required? true
Position? 0
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Path <String>
Specifies a path to a folder containing a Plaster template or multiple template folders. Can also be a path to
plasterManifest.xml.
Required? false
Position? 0
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Recurse [<SwitchParameter>]
Indicates that this cmdlet gets the items in the specified locations and in all child items of the locations.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
System.String
The first positional parameter is a filesystem path under which templates might be found. The -Recurse switch
will cause this path to be searched recursively.
OUTPUTS
System.Object
This output object provides the following properties:
- Title: The title of the template
- Author: The author of the template
- Version: The version of the template
- Description: Text describing the template and what it creates
- Tags: A list of tag strings which categorize the template
- TemplatePath: The template's folder path in the filesystem
NOTES
Example 1
PS C:\\> $templates = Get-PlasterTemplate
PS C:\\> Invoke-Plaster -TemplatePath $templates[0].TemplatePath -DestinationPath ~\\GitHub\\NewModule
This will get the list of built-in Plaster templates. The first template returned is then used to create a new
module at the specifed path.
Example 2
PS C:\\> $templates = Get-PlasterTemplate -IncludeInstalledModules
PS C:\\> Invoke-Plaster -TemplatePath $templates[0].TemplatePath -DestinationPath ~\\GitHub\\NewModule
This will get a list of Plaster templates, both built-in and included with installed modules. The first template
returned is then used to create a new module at the specifed path.
Example 3
PS C:\\> $templates = Get-PlasterTemplate -Path c:\\MyPlasterTemplates -Recurse
PS C:\\> Invoke-Plaster -TemplatePath $templates[0].TemplatePath -DestinationPath ~\\GitHub\\NewModule
This will get a list of Plaster templates found recursively under c:\\MyPlasterTemplates The first template
returned is then used to create a new module at the specifed path.
RELATED LINKS
Online Version: https://github.com/PowerShell/Plaster/b ... emplate.md
Invoke-Plaster https://github.com/PowerShell/Plaster/b ... Plaster.md
SYNOPSIS
Retrieves a list of available Plaster templates that can be used with the Invoke-Plaster cmdlet.
SYNTAX
Get-PlasterTemplate [-IncludeInstalledModules] [<CommonParameters>]
Get-PlasterTemplate [[-Path] <String>] [-Recurse] [<CommonParameters>]
DESCRIPTION
Retrieves a list of available Plaster templates from the specified path or from the set of templates that are
shipped with Plaster. Specifying no arguments will cause only the built-in Plaster templates to be returned.
Using the -IncludeInstalledModules switch will also search the PSModulePath for PowerShell modules that advertise
Plaster templates that they include.
The objects returned from this cmdlet will provide details about each individual template that was retrieved. Use
the TemplatePath property of a template object as the input to Invoke-Plaster's -TemplatePath parameter.
PARAMETERS
-IncludeInstalledModules [<SwitchParameter>]
Initiates a search for Plaster templates inside of installed modules.
Required? true
Position? 0
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Path <String>
Specifies a path to a folder containing a Plaster template or multiple template folders. Can also be a path to
plasterManifest.xml.
Required? false
Position? 0
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Recurse [<SwitchParameter>]
Indicates that this cmdlet gets the items in the specified locations and in all child items of the locations.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
System.String
The first positional parameter is a filesystem path under which templates might be found. The -Recurse switch
will cause this path to be searched recursively.
OUTPUTS
System.Object
This output object provides the following properties:
- Title: The title of the template
- Author: The author of the template
- Version: The version of the template
- Description: Text describing the template and what it creates
- Tags: A list of tag strings which categorize the template
- TemplatePath: The template's folder path in the filesystem
NOTES
Example 1
PS C:\\> $templates = Get-PlasterTemplate
PS C:\\> Invoke-Plaster -TemplatePath $templates[0].TemplatePath -DestinationPath ~\\GitHub\\NewModule
This will get the list of built-in Plaster templates. The first template returned is then used to create a new
module at the specifed path.
Example 2
PS C:\\> $templates = Get-PlasterTemplate -IncludeInstalledModules
PS C:\\> Invoke-Plaster -TemplatePath $templates[0].TemplatePath -DestinationPath ~\\GitHub\\NewModule
This will get a list of Plaster templates, both built-in and included with installed modules. The first template
returned is then used to create a new module at the specifed path.
Example 3
PS C:\\> $templates = Get-PlasterTemplate -Path c:\\MyPlasterTemplates -Recurse
PS C:\\> Invoke-Plaster -TemplatePath $templates[0].TemplatePath -DestinationPath ~\\GitHub\\NewModule
This will get a list of Plaster templates found recursively under c:\\MyPlasterTemplates The first template
returned is then used to create a new module at the specifed path.
RELATED LINKS
Online Version: https://github.com/PowerShell/Plaster/b ... emplate.md
Invoke-Plaster https://github.com/PowerShell/Plaster/b ... Plaster.md