PowerShell/docs/new-script.md

78 lines
2.0 KiB
Markdown
Raw Normal View History

2024-01-25 13:37:12 +01:00
Script: *new-script.ps1*
========================
2021-11-08 21:36:42 +01:00
2023-12-07 20:24:45 +01:00
This PowerShell script creates a new PowerShell script file by using the 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>
2023-12-07 20:24:45 +01:00
Specifies the path and filename to the new script
2021-11-08 21:36:42 +01:00
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
2023-12-07 20:24:45 +01:00
✔️ Created the new 'myscript.ps1' PowerShell script in 1 sec
2021-11-08 21:36:42 +01:00
```
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
2023-12-07 20:24:45 +01:00
Creates a new PowerShell script
2022-11-17 20:02:26 +01:00
.DESCRIPTION
2023-12-07 20:24:45 +01:00
This PowerShell script creates a new PowerShell script file by using the template file ../data/template.ps1.
2022-11-17 20:02:26 +01:00
.PARAMETER filename
2023-12-07 20:24:45 +01:00
Specifies the path and filename to the new script
2022-11-17 20:02:26 +01:00
.EXAMPLE
PS> ./new-script myscript.ps1
2023-12-07 20:24:45 +01:00
✔️ Created the new 'myscript.ps1' PowerShell script in 1 sec
2022-11-17 20:02:26 +01:00
.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" }
2023-12-07 20:24:45 +01:00
$stopWatch = [system.diagnostics.stopwatch]::startNew()
2022-11-17 20:02:26 +01:00
2023-12-07 20:24:45 +01:00
Copy-Item "$PSScriptRoot/../data/template.ps1" "$filename"
2022-11-17 20:02:26 +01:00
2023-12-07 20:24:45 +01:00
[int]$elapsed = $stopWatch.Elapsed.TotalSeconds
"✔️ Created the new '$filename' PowerShell script in $elapsed sec"
2022-11-17 20:02:26 +01:00
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
2024-03-27 17:36:59 +01:00
*(generated by convert-ps2md.ps1 using the comment-based help of new-script.ps1 as of 03/27/2024 17:36:29)*