Get-CatProjectTemplate
Lists the project templates New-CatProject can create a project from — the ones shipped with CAT, or the ones on the CAT server.
Synopsis
Get-CatProjectTemplate [-Online] [-LoggingLevel <string>]
Parameters
| Parameter | Type | Position | Default | Meaning |
|---|---|---|---|---|
-Online |
switch | named | off | List the templates on the CAT server instead of the local ones. |
-LoggingLevel |
string | named | Error |
Used only when this cmdlet has to create the session. |
What it does
Without -Online, returns the templates available locally — the two shipped with CAT (default, getStartedWindows) and any downloaded earlier. With -Online, asks the CAT server for its list, which may hold more templates and newer versions; nothing is downloaded by listing. Checks the license key (or reuses the session) like every project cmdlet.
Output
One list object of ProjectTemplate items (assign it to work with the items): TemplateCode — what New-CatProject -Template takes, TemplateName, Description, Version.
Errors
Refusals from the license key and plan check are terminating errors with the CatPortal.* ids listed on the Introduction page.
Examples
(Get-CatProjectTemplate) | Format-Table TemplateCode, TemplateName, Version
(Get-CatProjectTemplate -Online) | Format-Table TemplateCode, Version
Related
- Introduction — session model, logging, errors, plans and the license key.
New-CatProject— use a template.