PowerShell/docs/new-script.md

76 lines
1.8 KiB
Markdown
Raw Normal View History

2023-07-29 10:34:04 +02:00
*new-script.ps1*
================
2021-11-08 21:36:42 +01:00
2022-02-10 09:01:07 +01:00
This PowerShell script creates a new PowerShell script file (by using template file ../Data/template.ps1).
2021-11-08 21:36:42 +01:00
2023-07-29 10:04:38 +02:00
Parameters
----------
2021-11-08 21:36:42 +01:00
```powershell
2023-07-29 10:15:44 +02:00
PS> ./new-script.ps1 [[-filename] <String>] [<CommonParameters>]
2021-11-08 21:36:42 +01:00
-filename <String>
Specifies the path to the resulting file
Required? false
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
[<CommonParameters>]
This script supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction,
WarningVariable, OutBuffer, PipelineVariable, and OutVariable.
```
2023-07-29 10:04:38 +02:00
Example
-------
2021-11-08 21:36:42 +01:00
```powershell
PS> ./new-script myscript.ps1
✔️ created new PowerShell script: myscript.ps1
```
2023-07-29 10:04:38 +02:00
Notes
-----
2022-11-17 19:46:02 +01:00
Author: Markus Fleschutz | License: CC0
2021-11-08 21:36:42 +01:00
2023-07-29 10:04:38 +02:00
Related Links
-------------
2021-11-08 21:36:42 +01:00
https://github.com/fleschutz/PowerShell
2023-07-29 10:04:38 +02:00
Script Content
--------------
2022-11-17 20:05:34 +01:00
```powershell
2022-11-17 20:02:26 +01:00
<#
.SYNOPSIS
Creates a new PowerShell script file
.DESCRIPTION
This PowerShell script creates a new PowerShell script file (by using template file ../Data/template.ps1).
.PARAMETER filename
Specifies the path to the resulting file
.EXAMPLE
PS> ./new-script myscript.ps1
✔️ created new PowerShell script: myscript.ps1
.LINK
https://github.com/fleschutz/PowerShell
.NOTES
Author: Markus Fleschutz | License: CC0
#>
param([string]$filename = "")
try {
2023-08-06 11:42:46 +02:00
if ($filename -eq "" ) { $filename = Read-Host "Enter the new filename" }
2022-11-17 20:02:26 +01:00
2023-08-06 11:42:46 +02:00
Copy-Item "$PSScriptRoot/../Data/template.ps1" "$filename"
2022-11-17 20:02:26 +01:00
"✔️ created new PowerShell script: $filename"
exit 0 # success
} catch {
"⚠️ Error in line $($_.InvocationInfo.ScriptLineNumber): $($Error[0])"
exit 1
}
2022-11-17 20:05:34 +01:00
```
2022-11-17 20:02:26 +01:00
2023-10-19 08:12:00 +02:00
*(generated by convert-ps2md.ps1 using the comment-based help of new-script.ps1 as of 10/19/2023 08:11:40)*