Invoke-Plaster

NAME Invoke-Plaster



SYNOPSIS

Invokes the specified Plaster template which will scaffold out a file or a set of files and directories.





SYNTAX

Invoke-Plaster [-TemplatePath] <String> [-DestinationPath] <String> [-Confirm] [-Force] [-NoLogo] [-PassThru]

[-WhatIf] [<CommonParameters>]





DESCRIPTION

Invokes the specified Plaster template which will scaffold out a file or a set of files and directories.





PARAMETERS

-Confirm [<SwitchParameter>]

Prompts you for confirmation before running the cmdlet.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-DestinationPath <String>

Specifies the path to directory in which the template will use as a root directory when generating files. If

the directory does not exist, it will be created.



Required? true

Position? 1

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Force [<SwitchParameter>]

Specify Force to override user prompts for conflicting handling. This will override the confirmation prompt

and allow the template to overwrite existing files.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-NoLogo [<SwitchParameter>]

Suppresses the display of the Plaster logo.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-PassThru [<SwitchParameter>]

Returns an InvokePlasterInfo object with the following fields:



* TemplatePath



* DestinationPath



* Success



* CreatedFiles



* UpdatedFiles



* MissingModules



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-TemplatePath <String>

Specifies the path to the template directory.



Required? true

Position? 0

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]

Shows what would happen if the cmdlet runs. The cmdlet is not run.



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



OUTPUTS



NOTES









-------------------------- EXAMPLE 1 --------------------------



Invoke-Plaster -TemplatePath . -Destination ~\\GitHub\\NewModule



This will invoke the Plaster template in the current directory. The template will generate any files and

directories in the ~\\GitHub\\NewModule directory.

-------------------------- EXAMPLE 2 --------------------------



Invoke-Plaster -TemplatePath . -Destination ~\\GitHub\\NewModule -ModuleName Foo -Version 1.0.0



This will invoke the Plaster template in the current directory using dynamic parameters ModuleName and Version

extracted from the parameters section of the manifest file. The template will generate any files and directories

in the ~\\GitHub\\NewModule directory.



RELATED LINKS

Online Version: https://github.com/PowerShell/Plaster/b ... Plaster.md

New-PlasterManifest https://github.com/PowerShell/Plaster/b ... anifest.md

Test-PlasterManifest https://github.com/PowerShell/Plaster/b ... anifest.md