| external help file | Module Name | online version | schema |
|---|---|---|---|
PSScriptTools-help.xml |
PSScriptTools |
2.0.0 |
Display ANSI escape sequences.
Show-ANSISequence [-Basic] [-AsString] [<CommonParameters>]Show-ANSISequence [-Foreground] [-Background] [-Type <String>] [-AsString]
[<CommonParameters>]Show-ANSISequence [-RGB <Int32[]>] [-AsString] [<CommonParameters>]This script is designed to make it easy to see ANSI escape sequences and how they will display in your PowerShell session. Use the -AsString parameter to write simple strings to the pipeline which makes it easier to copy items to the clipboard.
The escape character will depend on whether you are running Windows PowerShell or PowerShell 7.x. For best results, you need to run this command in a PowerShell session and host that supports ANSI escape sequences.
PS C:\> Show-ANSISequence
*******************
* Basic Sequences *
*******************
`e[9mCrossedOut`e[0m
`e[7mReverse`e[0m
`e[6mRapidBlink`e[0m
`e[5mSlowBlink`e[0m
`e[4mUnderline`e[0m
`e[3mItalic`e[0m
`e[2mFaint`e[0m
`e[1mBold`e[0mThe output will be formatted using the corresponding ANSI escape sequence as seen in PowerShell 7.x.
PS C:\> Show-ANSISequence -Foreground -Type simple
**************
* Foreground *
**************
`e[30mHello`e[0m `e[31mHello`e[0m `e[32mHello`e[0m
`e[34mHello`e[0m `e[35mHello`e[0m `e[36mHello`e[0m
`e[90mHello`e[0m `e[91mHello`e[0m `e[92mHello`e[0m
`e[94mHello`e[0m `e[95mHello`e[0m `e[96mHello`e[0m
PS C:\> Show-ANSISequence -RGB 225,100,50
`e[38;2;225;100;50m256 Color (R:225)(G:100)(B:50)`e[0mShow an RGB ANSI sequence. The output will be formatted using the sequence.
PS C:\> Show-ANSISequence -RGB 225,100,50 -AsString | Set-ClipboardRepeat the previous example but write the output as a plain string and copy it to the clipboard.
Display basic ANSI settings. This is the default output.
Type: SwitchParameter
Parameter Sets: basic
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseDisplay foreground ANSI format settings. If you use -Type without specifying -Foreground or -Background, -Foreground will be used by default.
Type: SwitchParameter
Parameter Sets: foreback
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseDisplay background ANSI format settings.
Type: SwitchParameter
Parameter Sets: foreback
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseYou can display simple ANSI, 8-bit, or all sequences. Valid values are All,Simple and 8bit.
Type: String
Parameter Sets: foreback
Aliases:
Required: False
Position: Named
Default value: All
Accept pipeline input: False
Accept wildcard characters: FalseDisplay an RGB ANSI sequence. You must pass an array of values for Red,Blue, and Green. Each value must be between 0 and 255.
Type: Int32[]
Parameter Sets: RGB
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseShow the value as an unformatted string.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
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.
Learn more about ANSI sequences at https://en.wikipedia.org/wiki/ANSI_escape_code
Learn more about PowerShell: http://jdhitsolutions.com/blog/essential-powershell-resources/