https://github.com/mazzy-ax/write-progressex
Write-ProgressEx is a powershell advanced function that extends the Write-Progress cmdlet.
https://github.com/mazzy-ax/write-progressex
powershell progressbar
Last synced: 6 months ago
JSON representation
Write-ProgressEx is a powershell advanced function that extends the Write-Progress cmdlet.
- Host: GitHub
- URL: https://github.com/mazzy-ax/write-progressex
- Owner: mazzy-ax
- License: mit
- Created: 2017-07-21T20:02:37.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2020-04-26T17:37:14.000Z (almost 6 years ago)
- Last Synced: 2025-07-06T02:05:24.352Z (7 months ago)
- Topics: powershell, progressbar
- Language: PowerShell
- Homepage:
- Size: 180 KB
- Stars: 33
- Watchers: 1
- Forks: 2
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Write-ProgressEx – extended write-progress cmdlet
[project]:https://github.com/mazzy-ax/Write-ProgressEx
[license]:https://github.com/mazzy-ax/Write-ProgressEx/blob/master/LICENSE
[ps]:https://www.powershellgallery.com/packages/Write-ProgressEx
[nuget]:https://www.nuget.org/packages/Write-ProgressEx
[appveyor]:https://ci.appveyor.com/project/mazzy-ax/write-progressex
[][appveyor]
[][ps]
[][nuget]
[Write-ProgressEx][project] extends the functionality of the standard powershell cmdlet. Write-ProgressEx is a powershell advanced function that provides a simple way to show ProgressBars with PercentComplete and SecondsRemaining.
The cmdlet:
* works with pipe;
* works with empty activity string;
* completes all inner progresses if no parameters;
* automatically completes with pipe;
* automatically calculates percents, remaining seconds and elapsed time;
* automatically displays current iteration and totals on progress bar;
* automatically displays info with a progress bar and at the console title;
* automatically set parent id for a inner loop;
* stores totals, current values and actual parameters into the module hashtable;
* provides get/set cmdlets to access actual parameters;
* uses script blocks to show messages with date, time, iterations and elapsed time on events:
* first iteration;
* activity changed;
* status changed;
* completed.
* provides a counter functional. See [Write-ProgressEx as a counter](Examples/Write-ProgressEx.counter.ps1);
* uses the caller function name or the caller script file name as the Activity;
* accepts `-ShowProgressBar Auto` parameter to reduce the overhead for redrawing a screen. It recognizes `None` and `Force` values also.
Note: the function is not safe with multi-thread.
## Examples
A pipe and a simple loop:
```powershell
$range1 = 1..20
$range1 | Write-ProgressEx "loop 1" -Total $range1.Count -ShowMessages | ForEach-Object {
# ....
}
$range2 = 1..15
$range2 | ForEach-Object {
# ....
Write-ProgressEx "loop 2" -Total $range2.Count -Increment
}
Write-ProgressEx #close all progress bars
```
Pipes in nested loops:
```powershell
$outer = 1..20
$inner = 1..50
$outer | Write-ProgressEx "pipe nodes" -Status "outer" -Total $outer.Count -ShowMessages | ForEach-Object {
$inner | Write-ProgressEx "pipe names" -id 1 -Status "inner" -Total $inner.Count | ForEach-Object {
# ....
}
}
```
A long time command:
```powershell
$path = $env:homepath
$files = Get-ChildItem $path -Recurse | Write-ProgressEx $path
```
More samples are in the folder [Examples](Examples).
## Installation
Automatic install Write-ProgressEx module from the [PowerShell Gallery][ps]:
```powershell
Install-Module -Name Write-ProgressEx
Import-Module Write-ProgressEx
```
Automatic install Write-ProgressEx module from the [NuGet.org][nuget]:
```powershell
Install-Package -Name Write-ProgressEx
Import-Module Write-ProgressEx
```
or manual:
* Download and unblock the latest .zip file.
* Extract the .zip into your `$PSModulePath`, e.g. `~\Documents\WindowsPowerShell\Modules`.
* Ensure the extracted folder is named `Write-ProgressEx`.
* Set an execution policy to `RemoteSigned` or `Unrestricted` to execute not signed modules `Set-ExecutionPolicy RemoteSigned`.
* Run `Import-Module Write-ProgressEx`.
## Known issues
* Unable to import module on case-sensitive file systems. Thanks @jasonchester for the [workaround](https://github.com/mazzy-ax/Write-ProgressEx/issues/5)
## Changelog
* [CHANGELOG.md](CHANGELOG.md)
* .
## License
This project is released under the [licensed under the MIT License][license].
mazzy@mazzy.ru