Set-PSReadLineOption
Personnalise le comportement de la modification de ligne de commande dans 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>]
[<CommonParameters>] Set-PSReadLineOption
[-TokenKind] <TokenClassification>
[[-ForegroundColor] <ConsoleColor>]
[[-BackgroundColor] <ConsoleColor>]
[<CommonParameters>] Description
L’applet Set-PSReadLineOption de commande personnalise le comportement du module PSReadLine lorsque vous modifiez la ligne de commande. Pour afficher les paramètres PSReadLine , utilisez Get-PSReadLineOption.
Exemples
Exemple 1 : Définir les couleurs de premier plan et d’arrière-plan
Cet exemple montre comment définir PSReadLine pour qu’il affiche le jeton Comment avec du texte de premier plan vert sur un arrière-plan gris.
Set-PSReadLineOption -TokenKind Comment -ForegroundColor Green -BackgroundColor GrayExemple 2 : Définir le style de cloche
Dans cet exemple, PSReadLine répond aux erreurs ou aux conditions qui nécessitent l’attention de l’utilisateur. Le BellStyle est configuré pour émettre un bip audible à 1221 Hz pendant 60 ms.
Set-PSReadLineOption -BellStyle Audible -DingTone 1221 -DingDuration 60Paramètres
-AddToHistoryHandler
Spécifie un ScriptBlock qui contrôle les commandes ajoutées à l’historique PSReadLine .
ScriptBlock reçoit la ligne de commande en tant qu’entrée. Si le ScriptBlock retourne $True, la ligne de commande est ajoutée à l’historique.
| Type: | Func[String, Boolean] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-BackgroundColor
Spécifie la couleur d’arrière-plan du jeton spécifié par le paramètre TokenKind .
Les valeurs acceptables pour ce paramètre sont les suivantes :
- Noir
- DarkBlue
- DarkGreen
- DarkCyan
- DarkRed
- DarkMagenta
- DarkYellow
- Gris
- DarkGray
- Blue
- Vert
- Cyan
- Rouge
- Magenta
- Jaune
- 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 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-BellStyle
Spécifie la façon dont PSReadLine répond à diverses erreurs et conditions ambiguës.
Les valeurs valides sont les suivantes :
- Audible : un bip court.
- Visuel : le texte clignote brièvement.
- Aucun : aucun commentaire.
| Type: | BellStyle |
| Accepted values: | None, Visual, Audible |
| Position: | Named |
| Default value: | Audible |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-CommandValidationHandler
Spécifie un ScriptBlock appelé à partir de ValidateAndAcceptLine. Si une exception est levée, la validation échoue et l’erreur est signalée.
Avant de lever une exception, le gestionnaire de validation peut placer le curseur au point de l’erreur pour faciliter la correction. Un gestionnaire de validation peut également modifier la ligne de commande, par exemple pour corriger les erreurs typographiques courantes.
ValidateAndAcceptLine est utilisé pour éviter d’encombrer votre historique avec des commandes qui ne peuvent pas fonctionner.
| Type: | Action[CommandAst] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-CompletionQueryItems
Spécifie le nombre maximal d’éléments d’achèvement affichés sans invite.
Si le nombre d’éléments à afficher est supérieur à cette valeur, PSReadLine invite oui/non avant d’afficher les éléments d’achèvement.
| Type: | Int32 |
| Position: | Named |
| Default value: | 100 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ContinuationPrompt
Spécifie la chaîne affichée au début des lignes suivantes lorsque l’entrée multiligne est entrée. La valeur par défaut est double supérieur à des signes (>>). Une chaîne vide est valide.
| Type: | String |
| Position: | Named |
| Default value: | >> |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ContinuationPromptBackgroundColor
Spécifie la couleur d’arrière-plan de l’invite de continuation.
Les valeurs acceptables sont les mêmes que le paramètre BackgroundColor .
| 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 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ContinuationPromptForegroundColor
Spécifie la couleur de premier plan de l’invite de continuation.
Les valeurs acceptables sont les mêmes que le paramètre BackgroundColor .
| 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 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DingDuration
Spécifie la durée du bip lorsque BellStyle est défini sur Audible.
| Type: | Int32 |
| Position: | Named |
| Default value: | 50ms |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DingTone
Spécifie la tonalité en Hertz (Hz) du bip lorsque BellStyle est défini sur Audible.
| Type: | Int32 |
| Position: | Named |
| Default value: | 1221 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-EditMode
Spécifie le mode d’édition de ligne de commande. L’utilisation de ce paramètre réinitialise toutes les liaisons de clé définies par Set-PSReadLineKeyHandler.
Les valeurs valides sont les suivantes :
- Windows : les liaisons de clés émulent PowerShell, cmd et Visual Studio.
- Emacs : les liaisons de clés émulent Bash ou Emacs.
- Vi : les liaisons de clés émulent Vi.
| Type: | EditMode |
| Accepted values: | Windows, Emacs, Vi |
| Position: | Named |
| Default value: | Windows |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-EmphasisBackgroundColor
Spécifie la couleur d’arrière-plan utilisée pour l’accentuation, par exemple pour mettre en surbrillance le texte de recherche.
Les valeurs acceptables sont les mêmes que le paramètre BackgroundColor .
| 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 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-EmphasisForegroundColor
Spécifie la couleur de premier plan utilisée pour l’accentuation, par exemple pour mettre en surbrillance le texte de recherche.
Les valeurs acceptables sont les mêmes que le paramètre BackgroundColor .
| 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 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ErrorBackgroundColor
Spécifie la couleur d’arrière-plan utilisée pour les erreurs.
Les valeurs acceptables sont les mêmes que le paramètre BackgroundColor .
| 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 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ErrorForegroundColor
Spécifie la couleur de premier plan utilisée pour les erreurs.
Les valeurs acceptables sont les mêmes que le paramètre BackgroundColor .
| 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 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ExtraPromptLineCount
Spécifie le nombre de lignes supplémentaires.
Si votre invite s’étend sur plusieurs lignes, spécifiez une valeur pour ce paramètre. Utilisez cette option lorsque vous souhaitez que des lignes supplémentaires soient disponibles lorsque PSReadLine affiche l’invite après avoir affiché une sortie. Par exemple, PSReadLine retourne une liste d’achèvements.
Cette option est moins nécessaire que dans les versions précédentes de PSReadLine, mais elle est utile lorsque la InvokePrompt fonction est utilisée.
| Type: | Int32 |
| Position: | Named |
| Default value: | 0 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ForegroundColor
Spécifie la couleur de premier plan du jeton spécifié par le paramètre TokenKind .
Les valeurs acceptables sont les mêmes que le paramètre BackgroundColor .
| 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 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-HistoryNoDuplicates
Cette option contrôle le comportement de rappel. Les commandes en double sont toujours ajoutées au fichier d’historique. Lorsque cette option est définie, seul l’appel le plus récent s’affiche lors du rappel des commandes.
Des commandes répétées sont ajoutées à l’historique pour préserver l’ordre pendant le rappel. Toutefois, vous ne souhaitez généralement pas voir la commande plusieurs fois lors du rappel ou de la recherche dans l’historique.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-HistorySavePath
Spécifie le chemin d’accès au fichier dans lequel l’historique est enregistré. Le nom de fichier est stocké dans une variable $($host.Name)_history.txt, par exemple ConsoleHost_history.txt.
Si vous n’utilisez pas ce paramètre, le chemin par défaut est le suivant :
$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 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-HistorySaveStyle
Spécifie la façon dont PSReadLine enregistre l’historique.
Les valeurs valides sont les suivantes :
- SaveIncrementally : enregistrez l’historique après l’exécution de chaque commande et partagez-le entre plusieurs instances de PowerShell.
- SaveAtExit : ajouter un fichier d’historique lorsque PowerShell se ferme.
- SaveNothing : n’utilisez pas de fichier d’historique.
| Type: | HistorySaveStyle |
| Accepted values: | SaveIncrementally, SaveAtExit, SaveNothing |
| Position: | Named |
| Default value: | SaveIncrementally |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-HistorySearchCaseSensitive
Spécifie que la recherche d’historique respecte la casse dans des fonctions telles que ReverseSearchHistory ou HistorySearchBackward.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-HistorySearchCursorMovesToEnd
Indique que le curseur se déplace à la fin des commandes que vous chargez à partir de l’historique à l’aide d’une recherche.
Lorsque ce paramètre est défini sur $False, le curseur reste à la position qu’il était lorsque vous avez appuyé sur les flèches haut ou bas.
Pour désactiver cette option, vous pouvez exécuter l’une des commandes suivantes :
Set-PSReadLineOption -HistorySearchCursorMovesToEnd:$False
(Get-PSReadLineOption).HistorySearchCursorMovesToEnd = $False
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-MaximumHistoryCount
Spécifie le nombre maximal de commandes à enregistrer dans l’historique PSReadLine .
L’historique PSReadLine est distinct de l’historique PowerShell.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-MaximumKillRingCount
Spécifie le nombre maximal d’éléments stockés dans l’anneau d’arrêt.
| Type: | Int32 |
| Position: | Named |
| Default value: | 10 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ResetTokenColors
Indique que cette applet de commande restaure les couleurs des jetons aux paramètres par défaut.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ShowToolTips
Lors de l’affichage des complétions possibles, les info-bulles sont affichées dans la liste des complétions.
Cette option est activée par défaut. Cette option n’était pas activée par défaut dans les versions antérieures de PSReadLine. Pour désactiver, définissez cette option sur $False.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | True |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-TokenKind
Spécifie le jeton lorsque vous définissez des options de couleur de jeton avec les paramètres ForegroundColor et BackgroundColor .
Les valeurs acceptables pour ce paramètre sont les suivantes :
- None
- Commentaire
- Mot clé
- String
- Opérateur
- Variable
- Commande
- Paramètre
- Type
- Number
- Membre
| Type: | TokenClassification |
| Accepted values: | None, Comment, Keyword, String, Operator, Variable, Command, Parameter, Type, Number, Member |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WordDelimiters
Spécifie les caractères qui délimitent les mots pour des fonctions telles que ForwardWord ou KillWord.
| Type: | String |
| Position: | Named |
| Default value: | ;:,.[]{}()/\|^&*-=+-—― |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Entrées
None
Vous ne pouvez pas envoyer d’objets dans le pipeline à Set-PSReadLineOption.
Sorties
None
Set-PSReadLineOption ne génère pas de sortie.