Set-PSReadLineOption

Sintaxe

Default (Padrão)

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>]

Descrição

Exemplos

Exemplo 1: Definir cores de primeiro plano e plano de fundo

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

Exemplo 2: Definir estilo de sino

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

Exemplo 3: Definir várias opções

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

Exemplo 4: Definir várias opções de cor

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

Exemplo 5: Definir valores de cor para vários tipos

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

Exemplo 6: Use ViModeChangeHandler para exibir alterações no modo 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

Exemplo 7: Usar HistoryHandler para filtrar comandos adicionados ao histórico

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

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

Set-PSReadLineOption -AddToHistoryHandler $ScriptBlock

Exemplo 8: Use CommandValidationHandler para validar um comando antes de ser executado

# 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

Exemplo 9: Usando o parâmetro PromptText

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

Parâmetros

-AddToHistoryHandler

Especifica um ScriptBlock que controla como os comandos são adicionados ao histórico PSReadLine.

O ScriptBlock recebe a linha de comando como entrada.

O ScripBlock deve retornar um membro do AddToHistoryOption enum, o nome da cadeia de caracteres de um desses membros ou um valor booleano. A lista abaixo descreve os valores possíveis e seus efeitos.

• - Adicione o comando ao arquivo de histórico e à sessão atual.
• - Adicione o comando ao histórico apenas para a sessão atual.
• - Não adicione o comando ao arquivo de histórico da sessão atual.
• - O mesmo que se o valor fosse .
• - O mesmo que se o valor fosse .

Propriedades dos parâmetros

Conjuntos de parâmetros

-AnsiEscapeTimeout

Esta opção é específica para Windows quando a entrada é redirecionada, por exemplo, ao correr sob tmux ou screen.

Com a entrada redirecionada em Windows, muitas chaves são enviadas como uma sequência de caracteres começando pelo carácter escape. É impossível distinguir entre um único personagem de fuga seguido por mais personagens e uma sequência de fuga válida.

A suposição é que o terminal pode enviar os caracteres mais rápido do que um usuário digita. PSReadLine aguarda esse tempo limite antes de concluir que recebeu uma sequência de fuga completa.

Se vir carateres aleatórios ou inesperados quando escreve, pode ajustar este tempo limite.

Propriedades dos parâmetros

Conjuntos de parâmetros

-BellStyle

Especifica como PSReadLine responde a vários erros e condições ambíguas.

Os valores válidos são os seguintes:

• : Um bip curto.
• : O texto pisca brevemente.
• : Sem feedback.

Propriedades dos parâmetros

Conjuntos de parâmetros

-Colors

O parâmetro Colors especifica várias cores usadas por PSReadLine.

O argumento é uma tabela de hash onde as chaves especificam os elementos e os valores especificam a cor. Para obter mais informações, consulte about_Hash_Tables.

As cores podem ser um valor de ConsoleColor, por exemplo, , ou uma sequência de escape ANSI válida. Sequências de fuga válidas dependem do seu terminal. No PowerShell 5.0, um exemplo de sequência de escape para texto vermelho é . No PowerShell 6 e mais recente, a mesma sequência de escape é . Você pode especificar outras sequências de escape, incluindo os seguintes tipos:

Duas configurações de cor foram adicionadas para suportar a personalização do no PSReadLine 2.2.0:

• - definir a cor para o carácter principal e o nome da fonte final, como . Por padrão, ele usa como a cor de primeiro plano.

• - definir cor para indicar que um item da lista foi selecionado. Por padrão, ele usa como a cor do plano de fundo.

• 256 cores

• Cor de 24 bits

• Primeiro plano, plano de fundo ou ambos

• Inverso, negrito

Para obter mais informações sobre códigos de cores ANSI, consulte o artigo da Wikipédia código de escape ANSI.

As chaves válidas incluem:

• : A cor do prompt de continuação.
• : A cor de ênfase. Por exemplo, o texto correspondente ao pesquisar o histórico.
• : A cor do erro. Por exemplo, no prompt.
• : A cor para destacar a seleção do menu ou o texto selecionado.
• : A cor padrão do token.
• : A cor do token de comentário.
• : A palavra-chave cor do token.
• : A cor do token da corda.
• : A cor do token do operador.
• : A cor variável do token.
• : A cor do token de comando.
• : A cor do token de parâmetro.
• : A cor do token tipo.
• : A cor do token numérico.
• : Cor do nome do símbolo do membro.
• : A cor para a vista em linha da sugestão preditiva.
• : A cor do personagem principal e do nome da fonte da previsão.
• : A cor para a previsão selecionada em vista de lista.

Propriedades dos parâmetros

Conjuntos de parâmetros

-CommandValidationHandler

Especifica um ScriptBlock que é chamado de ValidateAndAcceptLine . Se uma exceção for lançada, a validação falhará e o erro será relatado.

Antes de lançar uma exceção, o manipulador de validação pode colocar o cursor no ponto do erro para facilitar a correção. Um manipulador de validação também pode alterar a linha de comando para corrigir erros tipográficos comuns.

ValidateAndAcceptLine é usado para evitar sobrecarregar seu histórico com comandos que não podem funcionar.

Propriedades dos parâmetros

Conjuntos de parâmetros

-CompletionQueryItems

Especifica o número máximo de itens de conclusão que são mostrados sem avisar.

Se o número de itens a serem exibidos for maior que esse valor, PSReadLine solicitará sim/não antes de exibir os itens de conclusão.

Propriedades dos parâmetros

Conjuntos de parâmetros

-ContinuationPrompt

Especifica a cadeia de caracteres exibida no início das linhas subsequentes quando a entrada de várias linhas é inserida. O padrão é o dobro de sinais maiores do que (). Uma cadeia de caracteres vazia é válida.

Propriedades dos parâmetros

Conjuntos de parâmetros

-DingDuration

Especifica a duração do sinal sonoro quando o BellStyle está definido para .

Propriedades dos parâmetros

Conjuntos de parâmetros

-DingTone

Especifica o tom em Hertz (Hz) do bip quando o BellStyle está definido para

Propriedades dos parâmetros

Conjuntos de parâmetros

-EditMode

Especifica o modo de edição da linha de comando. O uso desse parâmetro redefine todas as ligações de chave definidas por .

Os valores válidos são os seguintes:

• Windows: As combinações de teclas emulam PowerShell, cmd e Visual Studio. (padrão em Windows)
• : As combinações de teclas emulam Bash ou Emacs. (por defeito em plataformas não-Windows)
• : As teclas emulam Vi.

Use para ver as ligações de chave para o EditModeconfigurado no momento.

Propriedades dos parâmetros

Conjuntos de parâmetros

-ExtraPromptLineCount

Especifica o número de linhas extras.

Se o prompt se estender por mais de uma linha, especifique um valor para esse parâmetro. Use esta opção quando quiser que linhas extras estejam disponíveis quando PSReadLine exibir o prompt depois de mostrar alguma saída. Por exemplo, PSReadLine retorna uma lista de conclusão.

Esta opção é menos necessária do que em versões anteriores do PSReadLine, mas é útil quando a função é usada.

Propriedades dos parâmetros

Conjuntos de parâmetros

-HistoryNoDuplicates

Esta opção controla o comportamento de recuperação. Comandos duplicados ainda são adicionados ao arquivo de histórico. Quando essa opção é definida, somente a invocação mais recente aparece ao chamar comandos. Comandos repetidos são adicionados ao histórico para preservar a ordem durante a recuperação. No entanto, normalmente você não quer ver o comando várias vezes ao lembrar ou pesquisar o histórico.

Por padrão, a propriedade HistoryNoDuplicates do objeto global PSConsoleReadLineOptions é definida como . Para alterar o valor da propriedade, você deve especificar o valor do SwitchParameter da seguinte maneira: . Você pode voltar para usando apenas o SwitchParameter, .

Usando o seguinte comando, você pode definir o valor da propriedade diretamente:

(Get-PSReadLineOption).HistoryNoDuplicates = $false

Propriedades dos parâmetros

Conjuntos de parâmetros

-HistorySavePath

Especifica o caminho para o arquivo onde o histórico é salvo. Computadores que executam plataformas Windows ou não-Windows armazenam o ficheiro em locais diferentes. O nome do arquivo é armazenado em uma variável , por exemplo, .

Se você não usar esse parâmetro, o caminho padrão será o seguinte:

Windows

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

não-Windows

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

Propriedades dos parâmetros

Conjuntos de parâmetros

-HistorySaveStyle

Especifica como PSReadLine salva o histórico.

Os valores válidos são os seguintes:

• : Salve o histórico depois que cada comando for executado e compartilhe em várias instâncias do PowerShell.
• : Anexe o arquivo de histórico quando o PowerShell for encerrado.
• : Não use um arquivo de histórico.

Propriedades dos parâmetros

Conjuntos de parâmetros

-HistorySearchCaseSensitive

Especifica que a pesquisa de histórico diferencia maiúsculas de minúsculas em funções como ReverseSearchHistory ou HistorySearchBackward.

Por padrão, a propriedade HistorySearchCaseSensitive do objeto global PSConsoleReadLineOptions está definida como . Usando esse SwitchParameter define o valor da propriedade como . Para alterar o valor da propriedade de volta, você deve especificar o valor do SwitchParameter da seguinte maneira: .

Usando o seguinte comando, você pode definir o valor da propriedade diretamente:

(Get-PSReadLineOption).HistorySearchCaseSensitive = $false

Propriedades dos parâmetros

Conjuntos de parâmetros

-HistorySearchCursorMovesToEnd

Indica que o cursor se move para o final dos comandos que você carrega do histórico usando uma pesquisa. Quando esse parâmetro é definido como , o cursor permanece na posição em que estava quando você pressionou as setas para cima ou para baixo.

Por padrão, a propriedade HistorySearchCursorMovesToEnd do objeto global PSConsoleReadLineOptions é definida como . Usando esse SwitchParameter definir o valor da propriedade como . Para alterar o valor da propriedade de volta, você deve especificar o valor do SwitchParameter da seguinte maneira: .

Usando o seguinte comando, você pode definir o valor da propriedade diretamente:

(Get-PSReadLineOption).HistorySearchCursorMovesToEnd = $false

Propriedades dos parâmetros

Conjuntos de parâmetros

-MaximumHistoryCount

Especifica o número máximo de comandos a serem salvos em histórico de PSReadLine.

histórico do PSReadLine é separado do histórico do PowerShell.

Propriedades dos parâmetros

Conjuntos de parâmetros

-MaximumKillRingCount

Especifica o número máximo de itens armazenados no anel de eliminação.

Propriedades dos parâmetros

Conjuntos de parâmetros

-PredictionSource

Especifica a origem do PSReadLine para obter sugestões preditivas.

Os valores válidos são:

• - desativar a funcionalidade preditiva do IntelliSense (por defeito).
• - ativar a funcionalidade preditiva IntelliSense e usar o histórico PSReadLine como única fonte.
• - ativar a funcionalidade preditiva IntelliSense e usar os plugins () como única fonte. Este valor foi adicionado em PSReadLine 2.2.0
• - ativar a funcionalidade preditiva IntelliSense e usar tanto o histórico como o plugin como fontes. Este valor foi adicionado em PSReadLine 2.2.0

Propriedades dos parâmetros

Conjuntos de parâmetros

-PredictionViewStyle

Define o estilo para a exibição do texto preditivo. A predefinição é .

• - o estilo existente atualmente, semelhante ao de fish shell e zsh. (default)
• - as sugestões são renderizadas numa lista suspensa, e os utilizadores podem selecionar usando UpArrow e DownArrow.

Este parâmetro foi adicionado no PSReadLine 2.2.0

Propriedades dos parâmetros

Conjuntos de parâmetros

-PromptText

Este parâmetro define o valor da propriedade PromptText. O valor predefinido é .

PSReadLine analisa a função de prompt para determinar como alterar apenas a cor de parte do prompt. Esta análise não é 100% confiável. Use esta opção se PSReadLine estiver alterando seu prompt de maneiras inesperadas. Inclua qualquer espaço em branco à direita.

O valor desse parâmetro pode ser uma única cadeia de caracteres ou uma matriz de duas cadeias de caracteres. A primeira cadeia de caracteres é a parte da cadeia de caracteres de prompt que você deseja que seja alterada para vermelho quando houver um erro de análise. A segunda cadeia de caracteres é uma cadeia de caracteres alternativa a ser usada quando há um erro de análise.

Propriedades dos parâmetros

Conjuntos de parâmetros

-ShowToolTips

Ao exibir possíveis conclusão, as dicas de ferramentas são mostradas na lista de conclusão.

Esta opção está ativada por predefinição. Esta opção não estava habilitada por padrão em versões anteriores do PSReadLine. Para desativar, defina esta opção como .

Este parâmetro e opção foram adicionados no PSReadLine 2.3.4.

Por padrão, a propriedade ShowToolTips do objeto global PSConsoleReadLineOptions é definida como . Usando esse SwitchParameter define o valor da propriedade como . Para alterar o valor da propriedade, você deve especificar o valor do SwitchParameter da seguinte maneira: .

Usando o seguinte comando, você pode definir o valor da propriedade diretamente:

(Get-PSReadLineOption).ShowToolTips = $false

Propriedades dos parâmetros

Conjuntos de parâmetros

-TerminateOrphanedConsoleApps

Este parâmetro define a opção TerminateOrphanedConsoleApps como .

No Windows, quando pressionas Ctrl+c para terminar um processo, cada processo ligado a uma consola recebe um sinal de terminação, em vez de apenas a shell ativa. Às vezes, quando um shell lançou alguma grande árvore de processos filho, (imagine um sistema de compilação, por exemplo) alguns processos podem sair, deixando vários processos simultaneamente tentando consumir a entrada do console.

Ao definir a opção TerminateOrphanedConsoleApps para , PSReadLine registra a lista de processos que estão atualmente anexados ao console. Depois, sempre que o PSReadLine for executado, ele receberá uma nova lista de processos anexados ao console e encerrará aqueles que não estão na lista original.

Este parâmetro e opção foram adicionados no PSReadLine 2.3.4.

Propriedades dos parâmetros

Conjuntos de parâmetros

-ViModeChangeHandler

Quando o ViModeIndicator está definido para , o bloco de scripts fornecido será invocado sempre que o modo mudar. O bloco de script é fornecido um argumento do tipo .

Esse parâmetro foi introduzido no PowerShell 7.

Propriedades dos parâmetros

Conjuntos de parâmetros

-ViModeIndicator

Esta opção define o indicador visual para o modo atual . Modo de inserção ou modo de comando.

Os valores válidos são os seguintes:

• : Não há indicador.
• : O prompt muda de cor.
• : O cursor muda de tamanho.
• : O texto especificado pelo utilizador é impresso.

Propriedades dos parâmetros

Conjuntos de parâmetros

-WordDelimiters

Especifica os caracteres que delimitam palavras para funções como ForwardWord ou KillWord.

Propriedades dos parâmetros

Conjuntos de parâmetros

CommonParameters

Entradas

None

Saídas

None

Ligações relacionadas

• sobre_PSReadLine
• Get-PSReadLineKeyHandler
• Get-PSReadLineOption
• Remove-PSReadLineKeyHandler
• Set-PSReadLineKeyHandler