Set-PSReadLineOption

Syntax

Default (Standard)

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

Exempel

Exempel 1: Ange förgrunds- och bakgrundsfärger

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

Exempel 2: Ange klockformat

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

Exempel 3: Ange flera alternativ

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

Exempel 4: Ange flera färgalternativ

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

Exempel 5: Ange färgvärden för flera typer

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"
}

Exempel 6: Använd ViModeChangeHandler för att visa Ändringar i Vi-läge

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

Exempel 7: Använd HistoryHandler för att filtrera kommandon som lagts till i historiken

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

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

Set-PSReadLineOption -AddToHistoryHandler $ScriptBlock

Exempel 8: Använd CommandValidationHandler för att verifiera ett kommando innan det körs

# 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

Exempel 9: Använda parametern PromptText

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

Parametrar

-AddToHistoryHandler

Anger en ScriptBlock- som styr hur kommandon läggs till i PSReadLine- historik.

ScriptBlock- tar emot kommandoraden som indata.

ScripBlock- ska returnera en medlem i AddToHistoryOption uppräkning, strängnamnet för en av dessa medlemmar eller ett booleskt värde. I listan nedan beskrivs möjliga värden och deras effekter.

• MemoryAndFile – Lägg till kommandot i historikfilen och den aktuella sessionen.
• MemoryOnly – Lägg till kommandot i historiken endast för den aktuella sessionen.
• SkipAdding – Lägg inte till kommandot i historikfilen för den aktuella sessionen.
• $false – samma som om värdet var SkipAdding.
• $true – samma som om värdet var MemoryAndFile.

Parameteregenskaper

Parameteruppsättningar

-AnsiEscapeTimeout

Det här alternativet är specifikt för Windows när indata omdirigeras, till exempel när de körs under tmux eller screen.

Med omdirigerade indata i Windows skickas många nycklar som en sekvens med tecken som börjar med escape-tecknet. Det går inte att skilja mellan ett enda escape-tecken följt av fler tecken och en giltig escape-sekvens.

Antagandet är att terminalen kan skicka tecknen snabbare än en användartyp. PSReadLine- väntar på den här tidsgränsen innan du drar slutsatsen att den har fått en fullständig escape-sekvens.

Om du ser slumpmässiga eller oväntade tecken när du skriver kan du justera den här tidsgränsen.

Parameteregenskaper

Parameteruppsättningar

-BellStyle

Anger hur PSReadLine- svarar på olika fel och tvetydiga villkor.

De giltiga värdena är följande:

• Hörbar: Ett kort pip.
• Visual: Texten blinkar kort.
• Ingen: Ingen feedback.

Parameteregenskaper

Parameteruppsättningar

-Colors

Parametern Colors anger olika färger som används av PSReadLine.

Argumentet är en hash-tabell där nycklarna anger elementen och värdena anger färgen. Mer information finns i about_Hash_Tables.

Färger kan antingen vara ett värde från ConsoleColor, till exempel [ConsoleColor]::Redeller en giltig ANSI-escape-sekvens. Giltiga escape-sekvenser beror på terminalen. I PowerShell 5.0 är ett exempel på en escape-sekvens för röd text $([char]0x1b)[91m. I PowerShell 6 och senare är samma escape-sekvens `e[91m. Du kan ange andra escape-sekvenser, inklusive följande typer:

Två färginställningar har lagts till för att stödja anpassning av ListView i PSReadLine 2.2.0:

• ListPredictionColor – ange färg för det inledande >-tecknet och det avslutande källnamnet, till exempel [History]. Som standard används DarkYellow som förgrundsfärg.

• ListPredictionSelectedColor – ange färg för att ange att ett listobjekt är markerat. Som standard används DarkBlack som bakgrundsfärg.

• 256 färg

• 24-bitars färg

• Förgrund, bakgrund eller båda

• Invertera, fetstil

Mer information om ANSI-färgkoder finns i Wikipedia-artikeln ANSI escape code.

De giltiga nycklarna är:

• ContinuationPrompt: Färgen på fortsättningsprompten.
• Betoning: Betoningsfärgen. Till exempel matchande text vid sökning i historiken.
• Fel: Felfärgen. Till exempel i prompten.
• Markering: Färgen för att markera menymarkeringen eller markerad text.
• Standard: Standardtokenfärgen.
• Kommentar: Kommentartokens färg.
• Nyckelord: Nyckelordets tokenfärg.
• String: Strängtokenfärgen.
• Operator: Operatortokenfärgen.
• Variabel: Variabeltokens färg.
• Kommando: Kommandotokens färg.
• Parameter: Parametertokenfärgen.
• Typ: Typtokenfärg.
• Number: Den numeriska tokenfärgen.
• Medlems-: Tokenfärg för medlemsnamn.
• InlinePrediction: Färgen på den infogade vyn för förutsägelseförslaget.
• ListPrediction: Färgen för det inledande >-tecknet och förutsägelsekällans namn.
• ListPredictionSelected: Färgen för den valda förutsägelsen i listvyn.

Parameteregenskaper

Parameteruppsättningar

-CommandValidationHandler

Anger en ScriptBlock- som anropas från ValidateAndAcceptLine. Om ett undantag utlöses misslyckas verifieringen och felet rapporteras.

Innan du utlöser ett undantag kan valideringshanteraren placera markören vid felpunkten för att göra det enklare att åtgärda. En valideringshanterare kan också ändra kommandoraden för att korrigera vanliga typografiska fel.

ValidateAndAcceptLine används för att undvika att störa din historik med kommandon som inte kan fungera.

Parameteregenskaper

Parameteruppsättningar

-CompletionQueryItems

Anger det maximala antalet slutförandeobjekt som visas utan att fråga.

Om antalet objekt som ska visas är större än det här värdet uppmanar PSReadLineja/nej- innan slutförandeobjekten visas.

Parameteregenskaper

Parameteruppsättningar

-ContinuationPrompt

Anger strängen som visas i början av efterföljande rader när indata för flera rader anges. Standardvärdet är dubbelt större än tecken (>>). En tom sträng är giltig.

Parameteregenskaper

Parameteruppsättningar

-DingDuration

Anger varaktigheten för pipet när BellStyle- är inställd på Audible.

Parameteregenskaper

Parameteruppsättningar

-DingTone

Anger tonen i Hertz (Hz) i pipet när BellStyle- är inställd på Audible.

Parameteregenskaper

Parameteruppsättningar

-EditMode

Anger redigeringsläget för kommandoraden. Med den här parametern återställs alla nyckelbindningar som anges av Set-PSReadLineKeyHandler.

De giltiga värdena är följande:

• Windows: Nyckelbindningar emulerar PowerShell, cmd och Visual Studio. (standard i Windows)
• Emacs: Nyckelbindningar emulerar Bash eller Emacs. (standard på plattformar som inte är Windows)
• Vi: Nyckelbindningar emulerar Vi.

Använd Get-PSReadLineKeyHandler för att se nyckelbindningarna för den för närvarande konfigurerade EditMode.

Parameteregenskaper

Parameteruppsättningar

-ExtraPromptLineCount

Anger antalet extra rader.

Om din fråga sträcker sig över mer än en rad anger du ett värde för den här parametern. Använd det här alternativet när du vill att extra rader ska vara tillgängliga när PSReadLine- visar kommandotolken efter att ha visat utdata. Till exempel returnerar PSReadLine en lista över slutföranden.

Det här alternativet behövs mindre än i tidigare versioner av PSReadLine, men är användbart när funktionen InvokePrompt används.

Parameteregenskaper

Parameteruppsättningar

-HistoryNoDuplicates

Det här alternativet styr återkallningsbeteendet. Dubblettkommandon läggs fortfarande till i historikfilen. När det här alternativet har angetts visas endast det senaste anropet när kommandon återkallas. Upprepade kommandon läggs till i historiken för att bevara ordningen under återkallandet. Du vill dock vanligtvis inte se kommandot flera gånger när du återkallar eller söker i historiken.

Som standard egenskapen HistoryNoDuplicates för det globala PSConsoleReadLineOptions-objektet till True. Om du vill ändra egenskapsvärdet måste du ange värdet för SwitchParameter enligt följande: -HistoryNoDuplicates:$false. Du kan återgå till True genom att bara använda SwitchParameter, -HistoryNoDuplicates.

Med följande kommando kan du ange egenskapsvärdet direkt:

(Get-PSReadLineOption).HistoryNoDuplicates = $false

Parameteregenskaper

Parameteruppsättningar

-HistorySavePath

Anger sökvägen till filen där historiken sparas. Datorer som kör Windows- eller icke-Windows-plattformar lagrar filen på olika platser. Filnamnet lagras i en variabel $($Host.Name)_history.txt, till exempel ConsoleHost_history.txt.

Om du inte använder den här parametern är standardsökvägen följande:

Windows

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

icke-Windows-

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

Parameteregenskaper

Parameteruppsättningar

-HistorySaveStyle

Anger hur PSReadLine sparar historik.

Giltiga värden är följande:

• SaveIncrementally: Spara historik när varje kommando har körts och dela över flera instanser av PowerShell.
• SaveAtExit: Fil med tilläggshistorik när PowerShell avslutas.
• SaveNothing: Använd inte en historikfil.

Parameteregenskaper

Parameteruppsättningar

-HistorySearchCaseSensitive

Anger att historiksökning är skiftlägeskänsligt i funktioner som ReverseSearchHistory eller HistorySearchBackward.

Som standard är egenskapen HistorySearchCaseSensitive för det globala PSConsoleReadLineOptions-objektet inställt på False. Med den här SwitchParameter anger egenskapsvärdet till True. Om du vill ändra tillbaka egenskapsvärdet måste du ange värdet för SwitchParameter enligt följande: -HistorySearchCaseSensitive:$false.

Med följande kommando kan du ange egenskapsvärdet direkt:

(Get-PSReadLineOption).HistorySearchCaseSensitive = $false

Parameteregenskaper

Parameteruppsättningar

-HistorySearchCursorMovesToEnd

Anger att markören flyttas till slutet av kommandon som du läser in från historiken med hjälp av en sökning. När den här parametern är inställd på $falseförblir markören kvar på den position den var när du tryckte på uppåt- eller nedåtpilarna.

Som standard är egenskapen HistorySearchCursorMovesToEnd för det globala PSConsoleReadLineOptions-objektet inställt på False. Använd den här SwitchParameter ange egenskapsvärdet till True. Om du vill ändra tillbaka egenskapsvärdet måste du ange värdet för SwitchParameter enligt följande: -HistorySearchCursorMovesToEnd:$false.

Med följande kommando kan du ange egenskapsvärdet direkt:

(Get-PSReadLineOption).HistorySearchCursorMovesToEnd = $false

Parameteregenskaper

Parameteruppsättningar

-MaximumHistoryCount

Anger det maximala antalet kommandon som ska sparas i PSReadLine historik.

PSReadLine-historiken är separat från PowerShell-historiken.

Parameteregenskaper

Parameteruppsättningar

-MaximumKillRingCount

Anger det maximala antalet objekt som lagras i dödsringen.

Parameteregenskaper

Parameteruppsättningar

-PredictionSource

Anger källan för PSReadLine för att få förutsägelseförslag.

Giltiga värden är:

• Ingen – inaktivera funktionen prediktiv IntelliSense (standard).
• History – aktivera funktionen predictive IntelliSense och använd PSReadLine-historiken som den enda källan.
• plugin- – aktivera funktionen predictive IntelliSense och använd plugin-program (CommandPrediction) som den enda källan. Det här värdet lades till i PSReadLine 2.2.0
• HistoryAndPlugin – aktivera funktionen predictive IntelliSense och använda både historik och plugin-program som källor. Det här värdet lades till i PSReadLine 2.2.0

Parameteregenskaper

Parameteruppsättningar

-PredictionViewStyle

Anger formatmallen för visning av prediktiv text. Standardvärdet är InlineView.

• InlineView - stilen som finns idag, liknande den i fish shell och zsh. (default)
• ListView – förslag återges i en listruta och användarna kan välja att använda UpArrow och DownArrow.

Den här parametern lades till i PSReadLine 2.2.0

Parameteregenskaper

Parameteruppsättningar

-PromptText

Den här parametern anger värdet för egenskapen PromptText. Standardvärdet är "> ".

PSReadLine analyserar din promptfunktion för att avgöra hur du bara ändrar färgen på en del av prompten. Den här analysen är inte 100% tillförlitlig. Använd det här alternativet om PSReadLine ändrar din fråga på oväntade sätt. Ta med eventuella avslutande blanksteg.

Värdet för den här parametern kan vara en enskild sträng eller en matris med två strängar. Den första strängen är den del av promptsträngen som du vill ändra till röd när det finns ett parsfel. Den andra strängen är en alternativ sträng att använda för när det finns ett parsfel.

Parameteregenskaper

Parameteruppsättningar

-ShowToolTips

När du visar möjliga slutföranden visas knappbeskrivningar i listan över slutföranden.

Det här alternativet är aktiverat som standard. Det här alternativet har inte aktiverats som standard i tidigare versioner av PSReadLine. Om du vill inaktivera anger du det här alternativet till $false.

Den här parametern och alternativet lades till i PSReadLine 2.3.4.

Som standard är egenskapen ShowToolTips för det globala PSConsoleReadLineOptions-objektet inställt på True. Med den här SwitchParameter anger egenskapsvärdet till True. Om du vill ändra egenskapsvärdet måste du ange värdet för SwitchParameter enligt följande: -ShowToolTips:$false.

Med följande kommando kan du ange egenskapsvärdet direkt:

(Get-PSReadLineOption).ShowToolTips = $false

Parameteregenskaper

Parameteruppsättningar

-TerminateOrphanedConsoleApps

Den här parametern anger alternativet TerminateOrphanedConsoleApps till $true.

I Windows, när du trycker på Ctrl+c för att avsluta en process, får varje process som är ansluten till en konsol en avsluta-signal, i stället för bara det aktiva gränssnittet. Ibland kan vissa processer avslutas när ett gränssnitt har startat ett stort träd med underordnade processer (anta till exempel ett byggsystem), vilket gör att flera processer samtidigt försöker använda konsolindata.

När du anger alternativet TerminateOrphanedConsoleApps till $trueregistrerar PSReadLine listan över processer som för närvarande är anslutna till konsolen. När PSReadLine körs får den efteråt en ny lista över processer som är anslutna till konsolen och avslutar dem som inte finns i den ursprungliga listan.

Den här parametern och alternativet lades till i PSReadLine 2.3.4.

Parameteregenskaper

Parameteruppsättningar

-ViModeChangeHandler

När ViModeIndicator är inställt på Scriptanropas det angivna skriptblocket varje gång läget ändras. Skriptblocket tillhandahålls ett argument av typen ViMode.

Den här parametern introducerades i PowerShell 7.

Parameteregenskaper

Parameteruppsättningar

-ViModeIndicator

Det här alternativet anger den visuella indikatorn för aktuellt Vi läge. Antingen infogningsläge eller kommandoläge.

De giltiga värdena är följande:

• Ingen: Det finns ingen indikator.
• Fråga: Frågan ändrar färg.
• cursor: Markören ändrar storlek.
• Script: Användarangiven text skrivs ut.

Parameteregenskaper

Parameteruppsättningar

-WordDelimiters

Anger de tecken som avgränsar ord för funktioner som ForwardWord eller KillWord.

Parameteregenskaper

Parameteruppsättningar

CommonParameters

Indata

None

Utdata

None

Relaterade länkar

• about_PSReadLine
• Get-PSReadLineKeyHandler
• Get-PSReadLineOption (kommando i PowerShell)
• Remove-PSReadLineKeyHandler
• Set-PSReadLineKeyHandler