PowerShell/docs/new-zipfile.md
2024-01-25 13:58:49 +01:00

77 lines
1.9 KiB
Markdown

Script: *new-zipfile.ps1*
========================
This PowerShell script creates a new .ZIP file from a folder (including subfolders).
Parameters
----------
```powershell
PS> ./new-zipfile.ps1 [[-folder] <String>] [<CommonParameters>]
-folder <String>
Specifies the path to the folder
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.
```
Example
-------
```powershell
PS> ./new-zipfile.ps1 C:\Windows
```
Notes
-----
Author: Markus Fleschutz | License: CC0
Related Links
-------------
https://github.com/fleschutz/PowerShell
Script Content
--------------
```powershell
<#
.SYNOPSIS
Creates a new .ZIP file from a folder (including subfolders)
.DESCRIPTION
This PowerShell script creates a new .ZIP file from a folder (including subfolders).
.PARAMETER folder
Specifies the path to the folder
.EXAMPLE
PS> ./new-zipfile.ps1 C:\Windows
.LINK
https://github.com/fleschutz/PowerShell
.NOTES
Author: Markus Fleschutz | License: CC0
#>
param([string]$folder = "")
try {
if ($folder -eq "" ) { $folder = read-host "Enter the path to the folder to zip" }
$StopWatch = [system.diagnostics.stopwatch]::startNew()
$folder = resolve-path $folder
compress-archive -path $folder -destinationPath $folder.zip
[int]$Elapsed = $StopWatch.Elapsed.TotalSeconds
"✔️ created zip file $($folder).zip in $Elapsed sec"
exit 0 # success
} catch {
"⚠️ Error in line $($_.InvocationInfo.ScriptLineNumber): $($Error[0])"
exit 1
}
```
*(generated by convert-ps2md.ps1 using the comment-based help of new-zipfile.ps1 as of 01/25/2024 13:58:40)*