| external help file | PSScriptTools-help.xml |
|---|---|
| Module Name | PSScriptTools |
| online version | |
| schema | 2.0.0 |
Write an ANSI progress bar
Write-ANSIProgress [-PercentComplete] <Double> [-ProgressColor <String>] [-BarSymbol <String>]
[-Position <Coordinates>] [<CommonParameters>]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.
PS C:\> $pct = @(.10, .12, .19, .25, .43, .55, .66, .78, .90, .95,1)
PS C:\> $pct | Write-ANSIProgress -BarSymbol BlockThis will build a progress bar using a block symbol and the default ANSI color escape.
PS C:\> Write-ANSIProgress -PercentComplete .78 -BarSymbol Circle -ProgressColor "$([char]0x1b)[92m"Create a single progress bar for 78% using the Circle symbol and a custom color.
PS C:\scripts> Get-CimInstance win32_operatingsystem |
Select-Object @{Name = "MemGB"; Expression = {$_.TotalVisibleMemorySize/1MB -as [int]}},
FreePhysicalMemory, @{Name = "PctFree"; Expression = { $pct = $([math]::round($_.freephysicalmemory/$_.totalvisiblememorysize, 2));
Write-ANSIProgress -PercentComplete $pct | Select-Object -last 1}}
MemGB FreePhysicalMemory PctFree
----- ------------------ -------
32 16005324 48% ■■■■■■■■■■■■■■■■■■■■■■■■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))" -ForegroundColor Yellow -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 $sbYou are most likely to use this command in a function or script. This example demonstrates using a script block.
Specify what shape to use for the progress bar.
Type: String
Parameter Sets: (All)
Aliases:
Accepted values: Box, Block, Circle
Required: False
Position: Named
Default value: Box
Accept pipeline input: False
Accept wildcard characters: FalseEnter a percentage in decimal value like .25 up to 1.
Type: Double
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: FalseSpecify the cursor position or where you want to place the progress bar.
Type: Coordinates
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: Current position
Accept pipeline input: False
Accept wildcard characters: FalseSpecify an ANSI escape sequence for the progress bar color.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
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/