Set-PSReadLineOption

Syntaxe

Default (Par défaut)

Set-PSReadLineOption
    [-EditMode <EditMode>]
    [-ContinuationPrompt <string>]
    [-HistoryNoDuplicates]
    [-AddToHistoryHandler <Func[string,Object]>]
    [-CommandValidationHandler <Action[CommandAst]>]
    [-HistorySearchCursorMovesToEnd]
    [-MaximumHistoryCount <int>]
    [-MaximumKillRingCount <int>]
    [-ShowToolTips]
    [-ExtraPromptLineCount <int>]
    [-DingTone <int>]
    [-DingDuration <int>]
    [-BellStyle <BellStyle>]
    [-CompletionQueryItems <int>]
    [-WordDelimiters <string>]
    [-HistorySearchCaseSensitive]
    [-HistorySaveStyle <HistorySaveStyle>]
    [-HistorySavePath <string>]
    [-AnsiEscapeTimeout <int>]
    [-PromptText <string[]>]
    [-ViModeIndicator <ViModeStyle>]
    [-ViModeChangeHandler <scriptblock>]
    [-PredictionSource <PredictionSource>]
    [-PredictionViewStyle <PredictionViewStyle>]
    [-Colors <hashtable>]
    [-TerminateOrphanedConsoleApps]
    [<CommonParameters>]

Description

Exemples

Exemple 1 : Définir les couleurs de premier plan et d’arrière-plan

Set-PSReadLineOption -Colors @{ "Comment"="`e[32;47m" }

Exemple 2 : Définir le style de cloche

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

Exemple 3 : Définir plusieurs options

$PSReadLineOptions = @{
    EditMode = "Emacs"
    HistoryNoDuplicates = $true
    HistorySearchCursorMovesToEnd = $true
    Colors = @{
        "Command" = "#8181f7"
    }
}
Set-PSReadLineOption @PSReadLineOptions

Exemple 4 : Définir plusieurs options de couleur

Set-PSReadLineOption -Colors @{
  Command            = 'Magenta'
  Number             = 'DarkGray'
  Member             = 'DarkGray'
  Operator           = 'DarkGray'
  Type               = 'DarkGray'
  Variable           = 'DarkGreen'
  Parameter          = 'DarkGreen'
  ContinuationPrompt = 'DarkGray'
  Default            = 'DarkGray'
}

Exemple 5 : Définir des valeurs de couleur pour plusieurs types

Set-PSReadLineOption -Colors @{
 # Use a ConsoleColor enum
 "Error" = [ConsoleColor]::DarkRed

 # 24 bit color escape sequence
 "String" = "$([char]0x1b)[38;5;100m"

 # RGB value
 "Command" = "#8181f7"
}

Exemple 6 : Utiliser ViModeChangeHandler pour afficher les modifications du mode Vi

function OnViModeChange {
    if ($args[0] -eq 'Command') {
        # Set the cursor to a blinking block.
        Write-Host -NoNewline "`e[1 q"
    } else {
        # Set the cursor to a blinking line.
        Write-Host -NoNewline "`e[5 q"
    }
}
Set-PSReadLineOption -ViModeIndicator Script -ViModeChangeHandler $Function:OnViModeChange

Exemple 7 : Utiliser HistoryHandler pour filtrer les commandes ajoutées à l’historique

$ScriptBlock = {
    param ([string]$Line)

    if ($Line -match "^git") {
        return $false
    } else {
        return $true
    }
}

Set-PSReadLineOption -AddToHistoryHandler $ScriptBlock

Exemple 8 : Utiliser CommandValidationHandler pour valider une commande avant son exécution

# Load the namespace so you can use the [CommandAst] object type
using namespace System.Management.Automation.Language

Set-PSReadLineOption -CommandValidationHandler {
    param([CommandAst]$CommandAst)

    switch ($CommandAst.GetCommandName()) {
        'git' {
            $gitCmd = $CommandAst.CommandElements[1].Extent
            switch ($gitCmd.Text) {
                'cmt' {
                    [Microsoft.PowerShell.PSConsoleReadLine]::Replace(
                        $gitCmd.StartOffset, $gitCmd.EndOffset - $gitCmd.StartOffset, 'commit')
                }
            }
        }
    }
}
# This checks the validation script when you hit enter
Set-PSReadLineKeyHandler -Chord Enter -Function ValidateAndAcceptLine

Exemple 9 : Utilisation du paramètre PromptText

function prompt { "PS $PWD> " }`
Set-PSReadLineOption -PromptText '> ' # change the '>' character red
Set-PSReadLineOption -PromptText '> ', 'X ' # replace the '>' character with a red 'X'

Paramètres

-AddToHistoryHandler

Spécifie un ScriptBlock qui contrôle la façon dont les commandes sont ajoutées à l’historique PSReadLine .

Le ScriptBlock reçoit la ligne de commande en entrée.

ScripBlock doit retourner un membre de l’énumération AddToHistoryOption, le nom de chaîne de l’un de ces membres ou une valeur booléenne. La liste ci-dessous décrit les valeurs possibles et leurs effets.

• MemoryAndFile - Ajoutez la commande au fichier d’historique et à la session active.
• MemoryOnly - Ajoutez la commande à l’historique de la session active uniquement.
• SkipAdding - N’ajoutez pas la commande au fichier d’historique de la session active.
• $false - Identique à si la valeur était SkipAdding.
• $true - Identique à si la valeur était MemoryAndFile.

Propriétés du paramètre

Jeux de paramètres

-AnsiEscapeTimeout

Cette option est spécifique à Windows lorsque l’entrée est redirigée, par exemple, lors de l’exécution sous tmux ou screen.

Avec l’entrée redirigée sous Windows, de nombreuses touches sont envoyées sous la forme d’une séquence de caractères commençant par le caractère d’échappement. Il est impossible de faire la distinction entre un seul caractère d’échappement suivi d’autres caractères et une séquence d’échappement valide.

L’hypothèse est que le terminal peut envoyer les caractères plus rapidement qu’un utilisateur ne le tape. PSReadLine attend ce délai d’expiration avant de conclure qu’il a reçu une séquence d’échappement complète.

Si vous voyez des caractères aléatoires ou inattendus lorsque vous tapez, vous pouvez ajuster ce délai.

Propriétés du paramètre

Jeux de paramètres

-BellStyle

Spécifie comment PSReadLine réagit à diverses erreurs et conditions ambiguës.

Les valeurs valides sont les suivantes :

• Audible : Un bip court.
• Visuel : Le texte clignote brièvement.
• Aucun : Aucun retour.

Propriétés du paramètre

Jeux de paramètres

-Colors

Le paramètre Couleurs spécifie les différentes couleurs utilisées par PSReadLine.

L’argument est une table de hachage où les clés spécifient les éléments et les valeurs spécifient la couleur. Pour plus d’informations, consultez about_Hash_Tables.

Les couleurs peuvent être une valeur de ConsoleColor, par exemple [ConsoleColor]::Red, ou une séquence d’échappement ANSI valide. Les séquences d’échappement valides dépendent de votre terminal. Dans PowerShell 5.0, un exemple de séquence d’échappement pour le texte rouge est $([char]0x1b)[91m. Dans PowerShell 6 et versions ultérieures, la même séquence d’échappement est `e[91m. Vous pouvez spécifier d’autres séquences d’échappement, notamment les types suivants :

Deux paramètres de couleur ont été ajoutés pour prendre en charge la personnalisation de psReadLine ListView 2.2.0 :

• ListPredictionColor : définissez la couleur pour le caractère de début > et le nom de la source de fin, par [History]exemple . Par défaut, il utilise DarkYellow comme couleur de premier plan.

• ListPredictionSelectedColor : définissez la couleur pour indiquer qu’un élément de liste est sélectionné. Par défaut, il utilise DarkBlack comme couleur d’arrière-plan.

• 256 couleurs

• Couleur 24 bits

• Premier plan, arrière-plan ou les deux

• Inverse, gras

Pour plus d’informations sur les codes de couleur ANSI, consultez l’article Wikipédia sur le code d’échappement ANSI.

Les clés valides sont les suivantes :

• ContinuationPrompt : couleur de l’invite de continuation.
• Accentuation : La couleur d’accentuation. Par exemple, le texte correspondant lors de la recherche dans l’historique.
• Erreur : la couleur de l’erreur. Par exemple, dans l’invite.
• Sélection : la couleur pour mettre en évidence la sélection de menu ou le texte sélectionné.
• Par défaut : couleur du jeton par défaut.
• Commentaire : la couleur du jeton de commentaire.
• Mot-clé : La couleur du jeton de mot-clé.
• Chaîne : la couleur du jeton de chaîne.
• Opérateur : couleur du jeton d’opérateur.
• Variable : la couleur du jeton variable.
• Commande : couleur du jeton de commande.
• Paramètre : La couleur du jeton de paramètre.
• Type : couleur du jeton de type.
• Number : La couleur du jeton de nombre.
• Membre : couleur du jeton du nom du membre.
• InlinePrediction : couleur de la vue inline de la suggestion prédictive.
• ListPrediction : couleur du caractère de début > et du nom de la source de prédiction.
• ListPredictionSelected : couleur de la prédiction sélectionnée en mode liste.

Propriétés du paramètre

Jeux de paramètres

-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 sa correction. Un gestionnaire de validation peut également modifier la ligne de commande pour corriger les erreurs typographiques courantes.

ValidateAndAcceptLine est utilisé pour éviter d’encombrer votre historique avec des commandes qui ne peuvent pas fonctionner.

Propriétés du paramètre

Jeux de paramètres

-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 demande oui/non avant d’afficher les éléments d’achèvement.

Propriétés du paramètre

Jeux de paramètres

-ContinuationPrompt

Spécifie la chaîne affichée au début des lignes suivantes lors de la saisie de plusieurs lignes. La valeur par défaut est le signe double supérieur à (>>). Une chaîne vide est valide.

Propriétés du paramètre

Jeux de paramètres

-DingDuration

Spécifie la durée du bip lorsque BellStyle est défini sur Audible.

Propriétés du paramètre

Jeux de paramètres

-DingTone

Spécifie la tonalité en Hertz (Hz) du bip lorsque BellStyle est réglé sur Audible.

Propriétés du paramètre

Jeux de paramètres

-EditMode

Spécifie le mode d’édition de la ligne de commande. L’utilisation de ce paramètre réinitialise toutes les combinaisons de touches définies par Set-PSReadLineKeyHandler.

Les valeurs valides sont les suivantes :

• Windows : les raccourcis clavier émulent PowerShell, cmd et Visual Studio. (par défaut sur Windows)
• Emacs : Les raccourcis clavier émulent Bash ou Emacs. (par défaut sur les plateformes non-Windows)
• Vi : Les raccourcis clavier émulent Vi.

Permet Get-PSReadLineKeyHandler d’afficher les raccourcis clavier pour le mode d’édition actuellement configuré.

Propriétés du paramètre

Jeux de paramètres

-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 renvoie une liste de saisies semi-automatiques.

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.

Propriétés du paramètre

Jeux de paramètres

-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 activée, 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 lors du rappel. Toutefois, vous ne souhaitez généralement pas voir la commande plusieurs fois lors du rappel ou de la recherche dans l’historique.

Par défaut, la propriété HistoryNoDuplicates de l’objet PSConsoleReadLineOptions global est définie sur True. Pour modifier la valeur de la propriété, vous devez spécifier la valeur du SwitchParameter comme suit : -HistoryNoDuplicates:$false. Vous pouvez revenir à True l’aide uniquement de SwitchParameter. -HistoryNoDuplicates

À l’aide de la commande suivante, vous pouvez définir directement la valeur de la propriété :

(Get-PSReadLineOption).HistoryNoDuplicates = $false

Propriétés du paramètre

Jeux de paramètres

-HistorySavePath

Spécifie le chemin d’accès au fichier dans lequel l’historique est enregistré. Les ordinateurs exécutant des plates-formes Windows ou non-Windows stockent le fichier à différents emplacements. 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 d’accès par défaut est le suivant :

Windows

• $Env:APPDATA\Microsoft\Windows\PowerShell\PSReadLine\$($Host.Name)_history.txt

non-Windows

• $Env:XDG_DATA_HOME/powershell/PSReadLine/$($Host.Name)_history.txt
• $HOME/.local/share/powershell/PSReadLine/$($Host.Name)_history.txt

Propriétés du paramètre

Jeux de paramètres

-HistorySaveStyle

Spécifie comment 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 sur plusieurs instances de PowerShell.
• SaveAtExit: ajouter un fichier d’historique lorsque PowerShell se ferme.
• SaveNothing: n’utilisez pas de fichier d’historique.

Propriétés du paramètre

Jeux de paramètres

-HistorySearchCaseSensitive

Spécifie que la recherche dans l’historique est sensible à la casse dans des fonctions telles que ReverseSearchHistory ou HistorySearchBackward.

Par défaut, la propriété HistorySearchCaseSensitive de l’objet PSConsoleReadLineOptions global est définie sur False. L’utilisation de ce SwitchParameter définit la valeur de la propriété sur True. Pour modifier à nouveau la valeur de la propriété, vous devez spécifier la valeur du SwitchParameter comme suit : -HistorySearchCaseSensitive:$false.

À l’aide de la commande suivante, vous pouvez définir directement la valeur de la propriété :

(Get-PSReadLineOption).HistorySearchCaseSensitive = $false

Propriétés du paramètre

Jeux de paramètres

-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 où il se trouvait lorsque vous avez appuyé sur les flèches vers le haut ou vers le bas.

Par défaut, la propriété HistorySearchCursorMovesToEnd de l’objet PSConsoleReadLineOptions global est définie sur False. À l’aide de ce SwitchParameter , définissez la valeur de la propriété sur True. Pour modifier à nouveau la valeur de la propriété, vous devez spécifier la valeur du SwitchParameter comme suit : -HistorySearchCursorMovesToEnd:$false.

À l’aide de la commande suivante, vous pouvez définir directement la valeur de la propriété :

(Get-PSReadLineOption).HistorySearchCursorMovesToEnd = $false

Propriétés du paramètre

Jeux de paramètres

-MaximumHistoryCount

Spécifie le nombre maximal de commandes à enregistrer dans l’historique PSReadLine .

L’historique PSReadLine est distinct de l’historique PowerShell.

Propriétés du paramètre

Jeux de paramètres

-MaximumKillRingCount

Spécifie le nombre maximal d’éléments stockés dans l’anneau d’élimination.

Propriétés du paramètre

Jeux de paramètres

-PredictionSource

Spécifie la source de PSReadLine pour obtenir des suggestions prédictives.

Les valeurs valides sont les suivantes :

• Aucun : désactivez la fonctionnalité IntelliSense prédictive (valeur par défaut).
• Historique : activez la fonctionnalité IntelliSense prédictive et utilisez l’historique PSReadLine comme seule source.
• Plug-in : activez la fonctionnalité IntelliSense prédictive et utilisez les plug-ins (CommandPrediction) comme seule source. Cette valeur a été ajoutée dans PSReadLine 2.2.0
• HistoryAndPlugin : activez la fonctionnalité IntelliSense prédictive et utilisez l’historique et le plug-in comme sources. Cette valeur a été ajoutée dans PSReadLine 2.2.0

Propriétés du paramètre

Jeux de paramètres

-PredictionViewStyle

Définit le style de l’affichage du texte prédictif. La valeur par défaut est InlineView.

• InlineView - le style comme existant aujourd’hui, comme dans la coquille de poisson et zsh. (default)
• ListView : les suggestions sont affichées dans une liste déroulante, et les utilisateurs peuvent sélectionner à l’aide d’UpArrow et DownArrow.

Ce paramètre a été ajouté dans PSReadLine 2.2.0

Propriétés du paramètre

Jeux de paramètres

-PromptText

Ce paramètre définit la valeur de la propriété PromptText . La valeur par défaut est "> ".

PSReadLine analyse votre fonction d’invite pour déterminer comment changer uniquement la couleur d’une partie de votre invite. Cette analyse n’est pas fiable à 100%. Utilisez cette option si PSReadLine modifie votre invite de manière inattendue. Incluez les espaces de fin.

La valeur de ce paramètre peut être une seule chaîne ou un tableau de deux chaînes. La première chaîne est la partie de votre chaîne d’invite que vous souhaitez modifier en rouge en cas d’erreur d’analyse. La deuxième chaîne est une autre chaîne à utiliser lorsqu’il existe une erreur d’analyse.

Propriétés du paramètre

Jeux de paramètres

-ShowToolTips

Lors de l’affichage des achèvements possibles, les infobulles sont affichées dans la liste des achèvements.

Cette option est activée par défaut. Cette option n’était pas activée par défaut dans les versions précédentes de PSReadLine. Pour la désactiver, définissez cette option sur $false.

Ce paramètre et cette option ont été ajoutés dans PSReadLine 2.3.4.

Par défaut, la propriété ShowToolTips de l’objet PSConsoleReadLineOptions global est définie sur True. L’utilisation de ce SwitchParameter définit la valeur de la propriété sur True. Pour modifier la valeur de la propriété, vous devez spécifier la valeur du SwitchParameter comme suit : -ShowToolTips:$false.

À l’aide de la commande suivante, vous pouvez définir directement la valeur de la propriété :

(Get-PSReadLineOption).ShowToolTips = $false

Propriétés du paramètre

Jeux de paramètres

-TerminateOrphanedConsoleApps

Ce paramètre définit l’option TerminateOrphanedConsoleApps sur $true.

Sur Windows, lorsque vous appuyez sur Ctrl+c pour arrêter un processus, chaque processus attaché à une console reçoit un signal d’arrêt, par opposition à l’interpréteur de commandes actif. Parfois, lorsqu’un interpréteur de commandes a lancé une grande arborescence de processus enfants (imaginez un système de build, par exemple), certains processus peuvent se quitter, en laissant plusieurs processus simultanément essayer d’utiliser l’entrée de console.

Lorsque vous définissez l’option $trueTerminateOrphanedConsoleApps sur , PSReadLine enregistre la liste des processus actuellement attachés à la console. Ensuite, chaque fois que PSReadLine s’exécute, il obtient une nouvelle liste de processus attachés à la console et met fin à ceux qui ne figurent pas dans la liste d’origine.

Ce paramètre et cette option ont été ajoutés dans PSReadLine 2.3.4.

Propriétés du paramètre

Jeux de paramètres

-ViModeChangeHandler

Lorsque ViModeIndicator est défini sur Script, le bloc de script fourni est appelé chaque fois que le mode change. Le bloc de script est doté d’un argument de type ViMode.

Ce paramètre a été introduit dans PowerShell 7.

Propriétés du paramètre

Jeux de paramètres

-ViModeIndicator

Cette option définit l’indicateur visuel pour le mode Vi actuel. Mode insertion ou mode commande.

Les valeurs valides sont les suivantes :

• Aucun : il n’y a pas d’indicateur.
• Invite : l’invite change de couleur.
• Curseur : la taille du curseur change.
• Script : le texte spécifié par l’utilisateur est imprimé.

Propriétés du paramètre

Jeux de paramètres

-WordDelimiters

Spécifie les caractères qui délimitent les mots pour des fonctions telles que ForwardWord ou KillWord.

Propriétés du paramètre

Jeux de paramètres

CommonParameters

Entrées

None

Sorties

None

Liens associés

• À propos de PSReadLine
• Get-PSReadLineKeyHandler
• Get-PSReadLineOption
• Remove-PSReadLineKeyHandler
• Set-PSReadLineKeyHandler