Set-PSReadLineOption

Customizes the behavior of command line editing in PSReadLine .

Syntax

Set-PSReadLineOption
   [-EditMode <EditMode>]
   [-ContinuationPrompt <String>]
   [-ContinuationPromptForegroundColor <ConsoleColor>]
   [-ContinuationPromptBackgroundColor <ConsoleColor>]
   [-EmphasisForegroundColor <ConsoleColor>]
   [-EmphasisBackgroundColor <ConsoleColor>]
   [-ErrorForegroundColor <ConsoleColor>]
   [-ErrorBackgroundColor <ConsoleColor>]
   [-HistoryNoDuplicates]
   [-AddToHistoryHandler <Func[string,bool]>]
   [-CommandValidationHandler <Action[CommandAst]>]
   [-HistorySearchCursorMovesToEnd]
   [-MaximumHistoryCount <Int32>]
   [-MaximumKillRingCount <Int32>]
   [-ResetTokenColors]
   [-ShowToolTips]
   [-ExtraPromptLineCount <Int32>]
   [-DingTone <Int32>]
   [-DingDuration <Int32>]
   [-BellStyle <BellStyle>]
   [-CompletionQueryItems <Int32>]
   [-WordDelimiters <String>]
   [-HistorySearchCaseSensitive]
   [-HistorySaveStyle <HistorySaveStyle>]
   [-HistorySavePath <String>]
   [-ViModeIndicator <ViModeStyle>]
   [<CommonParameters>]
Set-PSReadLineOption
   [-TokenKind] <TokenClassification>
   [[-ForegroundColor] <ConsoleColor>]
   [[-BackgroundColor] <ConsoleColor>]
   [<CommonParameters>]

Description

The Set-PSReadLineOption cmdlet customizes the behavior of the PSReadLine module when you're editing the command line. To view the PSReadLine settings, use Get-PSReadLineOption.

Examples

Example 1: Set foreground and background colors

This example sets PSReadLine to display the Comment token with green foreground text on a gray background.

Set-PSReadLineOption -TokenKind Comment -ForegroundColor Green -BackgroundColor Gray

Example 2: Set bell style

In this example, PSReadLine will respond to errors or conditions that require user attention. The BellStyle is set to emit an audible beep at 1221 Hz for 60 ms.

Set-PSReadLineOption -BellStyle Audible -DingTone 1221 -DingDuration 60

Parameters

-AddToHistoryHandler

Specifies a ScriptBlock that controls which commands get added to PSReadLine history.

The ScriptBlock receives the command line as input. If the ScriptBlock returns $True, the command line is added to the history.

Type:Func[String, Boolean]
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-BackgroundColor

Specifies the background color for the token specified by the TokenKind parameter.

The acceptable values for this parameter are as follows:

  • Black
  • DarkBlue
  • DarkGreen
  • DarkCyan
  • DarkRed
  • DarkMagenta
  • DarkYellow
  • Gray
  • DarkGray
  • Blue
  • Green
  • Cyan
  • Red
  • Magenta
  • Yellow
  • White
Type:ConsoleColor
Accepted values:Black, DarkBlue, DarkGreen, DarkCyan, DarkRed, DarkMagenta, DarkYellow, Gray, DarkGray, Blue, Green, Cyan, Red, Magenta, Yellow, White
Position:2
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-BellStyle

Specifies how PSReadLine responds to various error and ambiguous conditions.

The valid values are as follows:

  • Audible: A short beep.
  • Visual: Text flashes briefly.
  • None: No feedback.
Type:BellStyle
Accepted values:None, Visual, Audible
Position:Named
Default value:Audible
Accept pipeline input:False
Accept wildcard characters:False
-CommandValidationHandler

Specifies a ScriptBlock that is called from ValidateAndAcceptLine. If an exception is thrown, validation fails and the error is reported.

Before throwing an exception, the validation handler can place the cursor at the point of the error to make it easier to fix. A validation handler can also change the command line, such as to correct common typographical errors.

ValidateAndAcceptLine is used to avoid cluttering your history with commands that can't work.

Type:Action[CommandAst]
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-CompletionQueryItems

Specifies the maximum number of completion items that are shown without prompting.

If the number of items to show is greater than this value, PSReadLine prompts yes/no before displaying the completion items.

Type:Int32
Position:Named
Default value:100
Accept pipeline input:False
Accept wildcard characters:False
-ContinuationPrompt

Specifies the string displayed at the beginning of the subsequent lines when multi-line input is entered. The default is double greater-than signs (>>). An empty string is valid.

Type:String
Position:Named
Default value:>>
Accept pipeline input:False
Accept wildcard characters:False
-ContinuationPromptBackgroundColor

Specifies the background color of the continuation prompt.

The acceptable values are the same as the BackgroundColor parameter.

Type:ConsoleColor
Accepted values:Black, DarkBlue, DarkGreen, DarkCyan, DarkRed, DarkMagenta, DarkYellow, Gray, DarkGray, Blue, Green, Cyan, Red, Magenta, Yellow, White
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ContinuationPromptForegroundColor

Specifies the foreground color of the continuation prompt.

The acceptable values are the same as the BackgroundColor parameter.

Type:ConsoleColor
Accepted values:Black, DarkBlue, DarkGreen, DarkCyan, DarkRed, DarkMagenta, DarkYellow, Gray, DarkGray, Blue, Green, Cyan, Red, Magenta, Yellow, White
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-DingDuration

Specifies the duration of the beep when BellStyle is set to Audible.

Type:Int32
Position:Named
Default value:50ms
Accept pipeline input:False
Accept wildcard characters:False
-DingTone

Specifies the tone in Hertz (Hz) of the beep when BellStyle is set to Audible.

Type:Int32
Position:Named
Default value:1221
Accept pipeline input:False
Accept wildcard characters:False
-EditMode

Specifies the command line editing mode. Using this parameter resets any key bindings set by Set-PSReadLineKeyHandler.

The valid values are as follows:

  • Windows: Key bindings emulate PowerShell, cmd, and Visual Studio.
  • Emacs: Key bindings emulate Bash or Emacs.
  • Vi: Key bindings emulate Vi.
Type:EditMode
Accepted values:Windows, Emacs, Vi
Position:Named
Default value:Windows
Accept pipeline input:False
Accept wildcard characters:False
-EmphasisBackgroundColor

Specifies the background color that's used for emphasis, such as to highlight search text.

The acceptable values are the same as the BackgroundColor parameter.

Type:ConsoleColor
Accepted values:Black, DarkBlue, DarkGreen, DarkCyan, DarkRed, DarkMagenta, DarkYellow, Gray, DarkGray, Blue, Green, Cyan, Red, Magenta, Yellow, White
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-EmphasisForegroundColor

Specifies the foreground color that's used for emphasis, such as to highlight search text.

The acceptable values are the same as the BackgroundColor parameter.

Type:ConsoleColor
Accepted values:Black, DarkBlue, DarkGreen, DarkCyan, DarkRed, DarkMagenta, DarkYellow, Gray, DarkGray, Blue, Green, Cyan, Red, Magenta, Yellow, White
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ErrorBackgroundColor

Specifies the background color that's used for errors.

The acceptable values are the same as the BackgroundColor parameter.

Type:ConsoleColor
Accepted values:Black, DarkBlue, DarkGreen, DarkCyan, DarkRed, DarkMagenta, DarkYellow, Gray, DarkGray, Blue, Green, Cyan, Red, Magenta, Yellow, White
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ErrorForegroundColor

Specifies the foreground color that's used for errors.

The acceptable values are the same as the BackgroundColor parameter.

Type:ConsoleColor
Accepted values:Black, DarkBlue, DarkGreen, DarkCyan, DarkRed, DarkMagenta, DarkYellow, Gray, DarkGray, Blue, Green, Cyan, Red, Magenta, Yellow, White
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ExtraPromptLineCount

Specifies the number of extra lines.

If your prompt spans more than one line, specify a value for this parameter. Use this option when you want extra lines to be available when PSReadLine displays the prompt after showing some output. For example, PSReadLine returns a list of completions.

This option is needed less than in previous versions of PSReadLine, but is useful when the InvokePrompt function is used.

Type:Int32
Position:Named
Default value:0
Accept pipeline input:False
Accept wildcard characters:False
-ForegroundColor

Specifies the foreground color for the token that's specified by the TokenKind parameter.

The acceptable values are the same as the BackgroundColor parameter.

Type:ConsoleColor
Accepted values:Black, DarkBlue, DarkGreen, DarkCyan, DarkRed, DarkMagenta, DarkYellow, Gray, DarkGray, Blue, Green, Cyan, Red, Magenta, Yellow, White
Position:1
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-HistoryNoDuplicates

This option controls the recall behavior. Duplicate commands are still added to the history file. When this option is set, only the most recent invocation appears when recalling commands.

Repeated commands are added to history to preserve ordering during recall. However, you typically don't want to see the command multiple times when recalling or searching the history.

Type:SwitchParameter
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False
-HistorySavePath

Specifies the path to the file where history is saved. The file name is stored in a variable $($host.Name)_history.txt, for example ConsoleHost_history.txt.

If you don't use this parameter, the default path is as follows:

$env:APPDATA\Microsoft\Windows\PowerShell\PSReadLine\$($host.Name)_history.txt

Type:String
Position:Named
Default value:$env:APPDATA\Microsoft\Windows\PowerShell\PSReadLine\$($host.Name)_history.txt
Accept pipeline input:False
Accept wildcard characters:False
-HistorySaveStyle

Specifies how PSReadLine saves history.

Valid values are as follows:

  • SaveIncrementally: Save history after each command is executed and share across multiple instances of PowerShell.
  • SaveAtExit: Append history file when PowerShell exits.
  • SaveNothing: Don't use a history file.
Type:HistorySaveStyle
Accepted values:SaveIncrementally, SaveAtExit, SaveNothing
Position:Named
Default value:SaveIncrementally
Accept pipeline input:False
Accept wildcard characters:False
-HistorySearchCaseSensitive

Specifies that history searching is case-sensitive in functions like ReverseSearchHistory or HistorySearchBackward.

Type:SwitchParameter
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False
-HistorySearchCursorMovesToEnd

Indicates that the cursor moves to the end of commands that you load from history by using a search. When this parameter is set to $False, the cursor remains at the position it was when you pressed the up or down arrows.

To turn off this option, you can run either of the following commands:

Set-PSReadLineOption -HistorySearchCursorMovesToEnd:$False

(Get-PSReadLineOption).HistorySearchCursorMovesToEnd = $False

Type:SwitchParameter
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False
-MaximumHistoryCount

Specifies the maximum number of commands to save in PSReadLine history.

PSReadLine history is separate from PowerShell history.

Type:Int32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-MaximumKillRingCount

Specifies the maximum number of items stored in the kill ring.

Type:Int32
Position:Named
Default value:10
Accept pipeline input:False
Accept wildcard characters:False
-ResetTokenColors

Indicates that this cmdlet restores token colors to default settings.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ShowToolTips

When displaying possible completions, tooltips are shown in the list of completions.

This option is enabled by default. This option wasn't enabled by default in prior versions of PSReadLine. To disable, set this option to $False.

Type:SwitchParameter
Position:Named
Default value:True
Accept pipeline input:False
Accept wildcard characters:False
-TokenKind

Specifies the token when you set token color options with the ForegroundColor and BackgroundColor parameters.

The acceptable values for this parameter are as follows:

  • None
  • Comment
  • Keyword
  • String
  • Operator
  • Variable
  • Command
  • Parameter
  • Type
  • Number
  • Member
Type:TokenClassification
Accepted values:None, Comment, Keyword, String, Operator, Variable, Command, Parameter, Type, Number, Member
Position:0
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-WordDelimiters

Specifies the characters that delimit words for functions like ForwardWord or KillWord.

Type:String
Position:Named
Default value:;:,.[]{}()/\|^&*-=+'"-—―
Accept pipeline input:False
Accept wildcard characters:False

Inputs

None

You can't send objects down the pipeline to Set-PSReadLineOption.

Outputs

None

Set-PSReadLineOption doesn't generate output.