22external help file : Microsoft.PowerShell.PSReadLine2.dll-Help.xml
33Locale : en-US
44Module Name : PSReadLine
5- ms.date : 01/18 /2026
5+ ms.date : 03/04 /2026
66online version : https://learn.microsoft.com/powershell/module/psreadline/set-psreadlineoption?view=powershell-7.4&WT.mc_id=ps-gethelp
7+ no-loc : [Windows]
78schema : 2.0.0
89title : Set-PSReadLineOption
910---
@@ -278,9 +279,9 @@ Specifies how **PSReadLine** responds to various error and ambiguous conditions.
278279
279280The valid values are as follows :
280281
281- - ** Audible** : A short beep.
282- - ** Visual** : Text flashes briefly.
283- - ** None** : No feedback.
282+ - ` Audible` : A short beep.
283+ - ` Visual` : Text flashes briefly.
284+ - ` None` : No feedback.
284285
285286` ` ` yaml
286287Type: Microsoft.PowerShell.BellStyle
@@ -309,9 +310,9 @@ sequence is `` `e[91m``. You can specify other escape sequences including the fo
309310
310311Two color settings were added to support customization of the `ListView` in PSReadLine 2.2.0 :
311312
312- - ** ListPredictionColor** - set color for the leading `>` character and the trailing source name,
313+ - ` ListPredictionColor` - set color for the leading `>` character and the trailing source name,
313314 such as `[History]`. By default, it uses `DarkYellow` as the foreground color.
314- - ** ListPredictionSelectedColor** - set color for indicating a list item is selected. By default, it
315+ - ` ListPredictionSelectedColor` - set color for indicating a list item is selected. By default, it
315316 uses `DarkBlack` as the background color.
316317
317318- 256 color
@@ -324,24 +325,24 @@ For more information about ANSI color codes, see the Wikipedia article
324325
325326The valid keys include :
326327
327- - ** ContinuationPrompt** : The color of the continuation prompt.
328- - ** Emphasis** : The emphasis color. For example, the matching text when searching history.
329- - ** Error** : The error color. For example, in the prompt.
330- - ** Selection** : The color to highlight the menu selection or selected text.
331- - ** Default** : The default token color.
332- - ** Comment** : The comment token color.
333- - ** Keyword** : The keyword token color.
334- - ** String** : The string token color.
335- - ** Operator** : The operator token color.
336- - ** Variable** : The variable token color.
337- - ** Command** : The command token color.
338- - ** Parameter** : The parameter token color.
339- - ** Type** : The type token color.
340- - ** Number** : The number token color.
341- - ** Member** : The member name token color.
342- - ** InlinePrediction** : The color for the inline view of the predictive suggestion.
343- - ** ListPrediction** : The color for the leading `>` character and prediction source name.
344- - ** ListPredictionSelected** : The color for the selected prediction in list view.
328+ - ` ContinuationPrompt` : The color of the continuation prompt.
329+ - ` Emphasis` : The emphasis color. For example, the matching text when searching history.
330+ - ` Error` : The error color. For example, in the prompt.
331+ - ` Selection` : The color to highlight the menu selection or selected text.
332+ - ` Default` : The default token color.
333+ - ` Comment` : The comment token color.
334+ - ` Keyword` : The keyword token color.
335+ - ` String` : The string token color.
336+ - ` Operator` : The operator token color.
337+ - ` Variable` : The variable token color.
338+ - ` Command` : The command token color.
339+ - ` Parameter` : The parameter token color.
340+ - ` Type` : The type token color.
341+ - ` Number` : The number token color.
342+ - ` Member` : The member name token color.
343+ - ` InlinePrediction` : The color for the inline view of the predictive suggestion.
344+ - ` ListPrediction` : The color for the leading `>` character and prediction source name.
345+ - ` ListPredictionSelected` : The color for the selected prediction in list view.
345346
346347` ` ` yaml
347348Type: System.Collections.Hashtable
@@ -416,7 +417,7 @@ Accept wildcard characters: False
416417
417418# ## -DingDuration
418419
419- Specifies the duration of the beep when **BellStyle** is set to ** Audible** .
420+ Specifies the duration of the beep when **BellStyle** is set to ` Audible` .
420421
421422` ` ` yaml
422423Type: System.Int32
@@ -432,7 +433,7 @@ Accept wildcard characters: False
432433
433434# ## -DingTone
434435
435- Specifies the tone in Hertz (Hz) of the beep when **BellStyle** is set to ** Audible**.
436+ Specifies the tone in Hertz (Hz) of the beep when **BellStyle** is set to ` Audible`
436437
437438` ` ` yaml
438439Type: System.Int32
@@ -453,9 +454,9 @@ Specifies the command line editing mode. Using this parameter resets any key bin
453454
454455The valid values are as follows :
455456
456- - ** Windows** : Key bindings emulate PowerShell, cmd, and Visual Studio. (default on Windows)
457- - ** Emacs** : Key bindings emulate Bash or Emacs. (default on non-Windows platforms)
458- - **Vi** : Key bindings emulate Vi.
457+ - ` Windows` : Key bindings emulate PowerShell, cmd, and Visual Studio. (default on Windows)
458+ - ` Emacs` : Key bindings emulate Bash or Emacs. (default on non-Windows platforms)
459+ - `Vi` : Key bindings emulate Vi.
459460
460461Use `Get-PSReadLineKeyHandler` to see the key bindings for the currently configured **EditMode**.
461462
@@ -671,12 +672,12 @@ Specifies the source for PSReadLine to get predictive suggestions.
671672
672673Valid values are :
673674
674- - ** None** - disable the predictive IntelliSense feature (default).
675- - ** History** - enable the predictive IntelliSense feature and use the PSReadLine history as the
675+ - ` None` - disable the predictive IntelliSense feature (default).
676+ - ` History` - enable the predictive IntelliSense feature and use the PSReadLine history as the
676677 only source.
677- - ** Plugin** - enable the predictive IntelliSense feature and use the plugins (`CommandPrediction`)
678+ - ` Plugin` - enable the predictive IntelliSense feature and use the plugins (`CommandPrediction`)
678679 as the only source. This value was added in PSReadLine 2.2.0
679- - ** HistoryAndPlugin** - enable the predictive IntelliSense feature and use both history and plugin
680+ - ` HistoryAndPlugin` - enable the predictive IntelliSense feature and use both history and plugin
680681 as the sources. This value was added in PSReadLine 2.2.0
681682
682683` ` ` yaml
@@ -693,10 +694,10 @@ Accept wildcard characters: False
693694
694695# ## -PredictionViewStyle
695696
696- Sets the style for the display of the predictive text. The default is ** InlineView** .
697+ Sets the style for the display of the predictive text. The default is ` InlineView` .
697698
698- - ** InlineView** - the style as existing today, similar as in fish shell and zsh. (default)
699- - ** ListView** - suggestions are rendered in a drop down list, and users can select using
699+ - ` InlineView` - the style as existing today, similar as in fish shell and zsh. (default)
700+ - ` ListView` - suggestions are rendered in a drop down list, and users can select using
700701 <kbd>UpArrow</kbd> and <kbd>DownArrow</kbd>.
701702
702703This parameter was added in PSReadLine 2.2.0
@@ -815,15 +816,15 @@ Accept wildcard characters: False
815816
816817# ## -ViModeIndicator
817818
818- This option sets the visual indicator for the current **Vi** mode. Either insert mode or command
819+ This option sets the visual indicator for the current `Vi` mode. Either insert mode or command
819820mode.
820821
821822The valid values are as follows :
822823
823- - ** None** : There's no indicator.
824- - ** Prompt** : The prompt changes color.
825- - ** Cursor** : The cursor changes size.
826- - ** Script** : User-specified text is printed.
824+ - ` None` : There's no indicator.
825+ - ` Prompt` : The prompt changes color.
826+ - ` Cursor` : The cursor changes size.
827+ - ` Script` : User-specified text is printed.
827828
828829` ` ` yaml
829830Type: Microsoft.PowerShell.ViModeStyle
0 commit comments