Write-ANSIProgress
SYNOPSIS
Display an ANSI progress bar.
SYNTAX
Write-ANSIProgress [-PercentComplete] <Double> [-ProgressColor <String>] [-BarSymbol <String>]
[-Position <Coordinates>] [<CommonParameters>]
DESCRIPTION
You can use this command to write an ANSI colored progress bar to the console. The output will be an array of strings. The item may be a blank line. See examples.
NOTE: If you are using the Windows Terminal and are at the bottom of the screen, you may get improperly formatted results. Clear the host and try again.
EXAMPLES
Example 1
PS C:\> $pct = @(.10, .12, .19, .25, .43, .55, .66, .78, .90, .95,1)
PS C:\> $pct | Write-ANSIProgress -BarSymbol Block
This will build a progress bar using a block symbol and the default ANSI color escape.
Example 2
PS C:\> $params = @{
PercentComplete = .78
BarSymbol = "Circle"
"ProgressColor" = "$([char]0x1b)[92m"
}
PS C:\> Write-ANSIProgress @params
Create a single progress bar for 78% using the Circle symbol and a custom color.
Example 3
PS C:\> Get-CimInstance -ClassName win32_operatingsystem |
Select-Object -property @{N="Computername";E={$_.CSName}},
@{N="TotalMemGB";E={Format-Value $_.TotalVisibleMemorySize -unit MB}},
@{N="FreeMemGB";E={Format-Value $_.FreePhysicalMemory -unit MB}},
@{N="PctFree"; E={
$pct=Format-Percent $_.freephysicalmemory $_.totalVisiblememorySize
Write-ANSIProgress -PercentComplete ($pct/100) | Select-Last 1
}}
Computername TotalMemGB FreeMemGB PctFree
------------ ---------- --------- -------
BOVINE320 32 12 37.87% ■■■■■■■■■■■■■■■■■■■
Note that this example is using abbreviations in the Select-Object hashtables.
Example 4
PS C:\> $sb = {
Clear-Host
$top = Get-ChildItem c:\scripts -Directory
$i = 0
$out=@()
$pos = $host.ui.RawUI.CursorPosition
Foreach ($item in $top) {
$i++
$pct = [math]::round($i/$top.count,2)
Write-ANSIProgress -PercentComplete $pct -position $pos
Write-Host " Processing $(($item.fullname).padright(80))" -NoNewline
$out+= Get-ChildItem -path $item -Recurse -file |
Measure-Object -property length -sum |
Select-Object @{Name="Path";Expression={$item.fullname}},Count,
@{Name="Size";Expression={$_.Sum}}
}
Write-Host ""
$out | Sort-object -property Size -Descending
}
PS C:\> Invoke-Command -scriptblock $sb
You are most likely to use this command in a function or script. This example demonstrates using a script block.
PARAMETERS
-BarSymbol
Specify what shape to use for the progress bar.
Type: System.String
Parameter Sets: (All)
Aliases:
Accepted values: Box, Block, Circle
Required: False
Position: Named
Default value: Box
Accept pipeline input: False
Accept wildcard characters: False
-PercentComplete
Enter a percentage in decimal value like .25 up to 1.
Type: System.Double
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-Position
Specify the cursor position or where you want to place the progress bar.
Type: System.Management.Automation.Host.Coordinates
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: Current position
Accept pipeline input: False
Accept wildcard characters: False
-ProgressColor
Specify an ANSI escape sequence for the progress bar color.
Type: System.String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
INPUTS
System.Double
OUTPUTS
System.String
NOTES
This command will not work in the PowerShell ISE. The verbose output should only be used when troubleshooting a display problem.
Learn more about PowerShell: http://jdhitsolutions.com/blog/essential-powershell-resources/