Compartilhar via

PSReadLine

  • Artigo

about_PSReadLine

Descrição breve

O PSReadLine fornece uma experiência aprimorada de edição de linha de comando no console do PowerShell.

Descrição longa

O PSReadLine 2.0 fornece uma experiência avançada de edição de linha de comando para o console do PowerShell. Ele fornece:

  • Coloração de sintaxe da linha de comando
  • Uma indicação visual de erros de sintaxe
  • Uma melhor experiência de várias linhas (edição e histórico)
  • Associações de chave personalizáveis
  • Modos Cmd e Emacs
  • Muitas opções de configuração
  • Preenchimento de estilo bash (opcional no modo Cmd, padrão no modo Emacs)
  • Emacs ianque/kill-ring
  • Movimentação de "palavra" baseada em token do PowerShell e encerramento

O PSReadLine requer o PowerShell 3.0 ou mais recente e o host do console. Ele não funciona no ISE do PowerShell. Ele funciona no console do Visual Studio Code.

Observação

A partir do PowerShell 7.0, o PowerShell ignorará o carregamento automático do PSReadLine no Windows se um programa de leitor de tela for detectado. Atualmente, o PSReadLine não funciona bem com os leitores de tela. A renderização e a formatação padrão do PowerShell 7.0 no Windows funcionam corretamente. Você pode carregar manualmente o módulo, se necessário.

As funções a seguir estão disponíveis na classe [Microsoft.PowerShell.PSConsoleReadLine].

Funções básicas de edição

Anular

Anular a ação atual, por exemplo, pesquisa de histórico incremental.

  • Emacs: <Ctrl+g>

AcceptAndGetNext

Tente executar a entrada atual. Se ele puder ser executado (como AcceptLine), lembre-se do próximo item do histórico na próxima vez que ReadLine for chamado.

  • Emacs: <Ctrl+o>

AcceptLine

Tente executar a entrada atual. Se a entrada atual estiver incompleta (por exemplo, há um parêntese de fechamento, colchete ou aspas ausentes, o prompt de continuação será exibido na próxima linha e PSReadLine aguardará as chaves editarem a entrada atual.

  • Cmd: <Enter>
  • Emacs: <Enter>
  • Modo de inserção vi: <Enter>

Addline

O prompt de continuação é exibido na próxima linha e PSReadLine aguarda as chaves editarem a entrada atual. Isso é útil para inserir a entrada de várias linhas como um único comando, mesmo quando uma única linha é a entrada completa por si só.

  • Cmd: <Shift+Enter>
  • Emacs: <Shift+Enter>
  • Modo de inserção vi: <Shift+Enter>
  • Modo de comando Vi: <Shift+Enter>

BackwardDeleteChar

Exclua o caractere antes do cursor.

  • Cmd: <Backspace>, <Ctrl+h>
  • Emacs: <Backspace>, <Ctrl+Backspace>, <Ctrl+h>
  • Modo de inserção vi: <Backspace>
  • Modo de comando Vi: <X>, <d,h>

BackwardDeleteLine

Como BackwardKillLine – exclui o texto do ponto até o início da linha, mas não coloca o texto excluído no kill-ring.

  • Cmd: <Ctrl+Home>
  • Modo de inserção vi: <Ctrl+u>, <Ctrl+Home>
  • Modo de comando Vi: <Ctrl+u>, <Ctrl+Home>, <d,0>

BackwardDeleteWord

Exclui a palavra anterior.

  • Modo de comando Vi: <Ctrl+w>, <d,b>

BackwardKillLine

Limpe a entrada do início da entrada para o cursor. O texto limpo é colocado no kill-ring.

  • Emacs: <Ctrl+u>, <Ctrl+x,Backspace>

BackwardKillWord

Limpe a entrada do início da palavra atual para o cursor. Se o cursor estiver entre palavras, a entrada será desmarcada do início da palavra anterior para o cursor. O texto limpo é colocado no kill-ring.

  • Cmd: <Ctrl+Backspace>
  • Emacs: <Alt+Backspace>, <Escape,Backspace>
  • Modo de inserção vi: <Ctrl+Backspace>
  • Modo de comando Vi: <Ctrl+Backspace>

CancelLine

Cancele a entrada atual, deixando a entrada na tela, mas retorna para o host para que o prompt seja avaliado novamente.

  • Modo de inserção vi: <Ctrl+c>
  • Modo de comando Vi: <Ctrl+c>

Copiar

Copie a região selecionada para a área de transferência do sistema. Se nenhuma região estiver selecionada, copie a linha inteira.

  • Cmd: <Ctrl+C>

CopyOrCancelLine

Se o texto estiver selecionado, copie para a área de transferência, caso contrário, cancele a linha.

  • Cmd: <Ctrl+c>
  • Emacs: <Ctrl+c>

Recortar

Exclua a região selecionada colocando o texto excluído na área de transferência do sistema.

  • Cmd: <Ctrl+x>

DeleteChar

Exclua o caractere sob o cursor.

  • Cmd: <Delete>
  • Emacs: <Delete>
  • Modo de inserção vi: <Delete>
  • Modo de comando Vi: <Delete>, <x>, <d,l>, <d,Space>

DeleteCharOrExit

Exclua o caractere sob o cursor ou, se a linha estiver vazia, saia do processo.

  • Emacs: <Ctrl+d>

DeleteEndOfWord

Exclua até o final da palavra.

  • Modo de comando Vi: <d,e>

DeleteLine

Exclui a linha atual, permitindo desfazer.

  • Modo de comando Vi: <d,d>

DeleteLineToFirstChar

Exclui o texto do cursor para o primeiro caractere não em branco da linha.

  • Modo de comando Vi: <d,^>

DeleteToEnd

Exclua até o final da linha.

  • Modo de comando Vi: <D>, <d,$>

DeleteWord

Exclua a próxima palavra.

  • Modo de comando Vi: <d,w>

ForwardDeleteLine

Como ForwardKillLine – exclui o texto do ponto até o final da linha, mas não coloca o texto excluído no kill-ring.

  • Cmd: <Ctrl+End>
  • Modo de inserção vi: <Ctrl+End>
  • Modo de comando Vi: <Ctrl+End>

InsertLineAbove

Uma nova linha vazia é criada acima da linha atual, independentemente de onde o cursor esteja na linha atual. O cursor se move para o início da nova linha.

  • Cmd: <Ctrl+Enter>

InsertLineBelow

Uma nova linha vazia é criada abaixo da linha atual, independentemente de onde o cursor esteja na linha atual. O cursor se move para o início da nova linha.

  • Cmd: <Shift+Ctrl+Enter>

InvertCase

Inverta o caso do caractere atual e vá para o próximo.

  • Modo de comando Vi: <~>

KillLine

Limpe a entrada do cursor até o final da entrada. O texto limpo é colocado no kill-ring.

  • Emacs: <Ctrl+k>

KillRegion

Encerre o texto entre o cursor e a marca.

  • A função não está relacionada.

KillWord

Limpe a entrada do cursor até o final da palavra atual. Se o cursor estiver entre palavras, a entrada será limpa do cursor até o final da próxima palavra. O texto limpo é colocado no kill-ring.

  • Cmd: <Ctrl+Delete>
  • Emacs: <Alt+d>, <Escape,d>
  • Modo de inserção vi: <Ctrl+Delete>
  • Modo de comando Vi: <Ctrl+Delete>

Colar

Cole o texto da área de transferência do sistema.

  • Cmd: <Ctrl+v>, <Shift+Insert>
  • Modo de inserção vi: <Ctrl+v>
  • Modo de comando Vi: <Ctrl+v>

Importante

Ao usar a função Colar , todo o conteúdo do buffer da área de transferência é colado no buffer de entrada do PSReadLine. Em seguida, o buffer de entrada é passado para o analisador do PowerShell. A entrada colada usando o método de colagem de clique com o botão direito do mouse do aplicativo de console é copiada para o buffer de entrada um caractere por vez. O buffer de entrada é passado para o analisador quando um caractere de nova linha é copiado. Portanto, a entrada é analisada uma linha por vez. A diferença entre os métodos de colagem resulta em um comportamento de execução diferente.

PasteAfter

Cole a área de transferência após o cursor, movendo o cursor para o final do texto colado.

  • Modo de comando Vi: <p>

PasteBefore

Cole a área de transferência antes do cursor, movendo o cursor para o final do texto colado.

  • Modo de comando Vi: <P>

PrependAndAccept

Acrescente um '#' e aceite a linha.

  • Modo de comando Vi: <#>

Refazer

Desfazer uma desfaça.

  • Cmd: <Ctrl+y>
  • Modo de inserção vi: <Ctrl+y>
  • Modo de comando Vi: <Ctrl+y>

RepeatLastCommand

Repita a última modificação de texto.

  • Modo de comando Vi: <.>

RevertLine

Reverte toda a entrada para a entrada atual.

  • Cmd: <Escape>
  • Emacs: <Alt+r>, <Escape,r>

ShellBackwardKillWord

Limpe a entrada do início da palavra atual para o cursor. Se o cursor estiver entre palavras, a entrada será desmarcada do início da palavra anterior para o cursor. O texto limpo é colocado no kill-ring.

A função não está relacionada.

ShellKillWord

Limpe a entrada do cursor até o final da palavra atual. Se o cursor estiver entre palavras, a entrada será limpa do cursor até o final da próxima palavra. O texto limpo é colocado no kill-ring.

A função não está relacionada.

SwapCharacters

Troque o caractere atual e o antes dele.

  • Emacs: <Ctrl+t>
  • Modo de inserção vi: <Ctrl+t>
  • Modo de comando Vi: <Ctrl+t>

Desfazer

Desfazer uma edição anterior.

  • Cmd: <Ctrl+z>
  • Emacs: <Ctrl+_>, <Ctrl+x,Ctrl+u>
  • Modo de inserção vi: <Ctrl+z>
  • Modo de comando Vi: <Ctrl+z>, <u>

UndoAll

Desfazer todas as edições anteriores da linha.

  • Modo de comando Vi: <U>

UnixWordRubout

Limpe a entrada do início da palavra atual para o cursor. Se o cursor estiver entre palavras, a entrada será desmarcada do início da palavra anterior para o cursor. O texto limpo é colocado no kill-ring.

  • Emacs: <Ctrl+w>

ValidateAndAcceptLine

Tente executar a entrada atual. Se a entrada atual estiver incompleta (por exemplo, há um parêntese de fechamento, colchete ou aspas ausentes, o prompt de continuação será exibido na próxima linha e PSReadLine aguardará as chaves editarem a entrada atual.

  • Emacs: <Ctrl+m>

ViAcceptLine

Aceite a linha e alterne para o modo Inserir.

  • Modo de comando Vi: <Enter>

ViAcceptLineOrExit

Como DeleteCharOrExit no modo Emacs, mas aceita a linha em vez de excluir um caractere.

  • Modo de inserção vi: <Ctrl+d>
  • Modo de comando Vi: <Ctrl+d>

ViAppendLine

Uma nova linha é inserida abaixo da linha atual.

  • Modo de comando Vi: <o>

ViBackwardDeleteGlob

Exclui a palavra anterior, usando apenas espaço em branco como delimitador de palavra.

  • Modo de comando Vi: <d,B>

ViBackwardGlob

Move o cursor de volta para o início da palavra anterior, usando apenas espaço em branco como delimitadores.

  • Modo de comando Vi: <B>

ViDeleteBrace

Localize a chave, parênteses ou colchetes correspondentes e exclua todo o conteúdo dentro, incluindo a chave.

  • Modo de comando Vi: <d,%>

ViDeleteEndOfGlob

Exclua até o final da palavra.

  • Modo de comando Vi: <d,E>

ViDeleteGlob

Exclua o próximo glob (palavra delimitada por espaço em branco).

  • Modo de comando Vi: <d,W>

ViDeleteToBeforeChar

Exclui até o caractere especificado.

  • Modo de comando Vi: <d,t>

ViDeleteToBeforeCharBackward

Exclui até o caractere especificado.

  • Modo de comando Vi: <d,T>

ViDeleteToChar

Exclui até o caractere especificado.

  • Modo de comando Vi: <d,f>

ViDeleteToCharBackward

Exclui para trás até o caractere especificado.

  • Modo de comando Vi: <d,F>

ViInsertAtBegining

Alterne para o modo Inserir e posicione o cursor no início da linha.

  • Modo de comando Vi: <I>

ViInsertAtEnd

Alterne para o modo Inserir e posicione o cursor no final da linha.

  • Modo de comando Vi: <A>

ViInsertLine

Uma nova linha é inserida acima da linha atual.

  • Modo de comando Vi: <O>

ViInsertWithAppend

Acrescente da posição da linha atual.

  • Modo de comando Vi: <a>

ViInsertWithDelete

Exclua o caractere atual e alterne para o modo Inserir.

  • Modo de comando Vi: <s>

ViJoinLines

Une a linha atual e a próxima linha.

  • Modo de comando Vi: <J>

ViReplaceLine

Apagar toda a linha de comando.

  • Modo de comando Vi: <S>, <c,c>

ViReplaceToBeforeChar

Substitui até o caractere especificado.

  • Modo de comando Vi: <c,t>

ViReplaceToBeforeCharBackward

Substitui até o caractere especificado.

  • Modo de comando Vi: <c,T>

ViReplaceToChar

Exclui até o caractere especificado.

  • Modo de comando Vi: <c,f>

ViReplaceToCharBackward

Substitui até o caractere especificado.

  • Modo de comando Vi: <c,F>

ViYankBeginningOfLine

Puxe do início do buffer para o cursor.

  • Modo de comando Vi: <y,0>

ViYankEndOfGlob

Puxe do cursor até o final do(s) WORD(s).

  • Modo de comando Vi: <y,E>

ViYankEndOfWord

Puxe do cursor até o final da(s) palavra(s).

  • Modo de comando Vi: <y,e>

ViYankLeft

Puxe caracteres à esquerda do cursor.

  • Modo de comando Vi: <y,h>

ViYankLine

Puxe todo o buffer.

  • Modo de comando Vi: <y,y>

ViYankNextGlob

Puxe do cursor para o início das próximas PALAVRAS.

  • Modo de comando Vi: <y,W>

ViYankNextWord

Puxe a(s) palavra(s) após o cursor.

  • Modo de comando vi: <y,w>

ViYankPercent

Puxe de/para a chave correspondente.

  • Modo de comando vi: <y,%>

ViYankPreviousGlob

Puxe do início do WORD(s) para o cursor.

  • Modo de comando vi: <y,B>

ViYankPreviousWord

Puxe a(s) palavra(s) antes do cursor.

  • Modo de comando vi: <y,b>

ViYankRight

Puxe caracteres sob e à direita do cursor.

  • Modo de comando Vi: <y,l>, <y,Space>

ViYankToEndOfLine

Puxe do cursor até o final do buffer.

  • Modo de comando vi: <y,$>

ViYankToFirstChar

Puxe do primeiro caractere não whitespace para o cursor.

  • Modo de comando vi: <y,^>

Ianque

Adicione o texto morto mais recentemente à entrada.

  • Emacs: <Ctrl+y>

YankLastArg

Puxe o último argumento da linha de histórico anterior. Com um argumento, a primeira vez que ele é invocado, comporta-se exatamente como YankeeNthArg. Se invocado várias vezes, em vez disso, itera através do histórico e arg define a direção (negativo inverte a direção.)

  • Cmd: <Alt+.>
  • Emacs: <Alt+.>, <Alt+_>, , <Escape,.><Escape,_>

YankeeNthArg

Puxe o primeiro argumento (após o comando) da linha de histórico anterior. Com um argumento , puxe o nº argumento (começando a partir de 0), se o argumento for negativo, comece a partir do último argumento.

  • Emacs: <Ctrl+Alt+y>, <Escape,Ctrl+y>

YankPop

Se a operação anterior for Ianque ou IanquePop, substitua o texto anteriormente arrancado pelo próximo texto morto do anel de morte.

  • Emacs: <Alt+y>, <Escape,y>

Funções de movimento do cursor

BackwardChar

Mova o cursor um caractere para a esquerda. Isso pode mover o cursor para a linha anterior de entrada de várias linhas.

  • Cmd: <LeftArrow>
  • Emacs: <LeftArrow>, <Ctrl+b>
  • Modo de inserção vi: <LeftArrow>
  • Modo de comando vi: <LeftArrow>, <Backspace>, <h>

BackwardWord

Mova o cursor de volta para o início da palavra atual ou, se entre palavras, o início da palavra anterior. Word limites são definidos por um conjunto configurável de caracteres.

  • Cmd: <Ctrl+LeftArrow>
  • Emacs: <Alt+b>, <Escape,b>
  • Modo de inserção vi: <Ctrl+LeftArrow>
  • Modo de comando vi: <Ctrl+LeftArrow>

BeginningOfLine

Se a entrada tiver várias linhas, vá para o início da linha atual ou, se já estiver no início da linha, vá para o início da entrada. Se a entrada tiver uma única linha, vá para o início da entrada.

  • Cmd: <Home>
  • Emacs: <Home>, <Ctrl+a>
  • Modo de inserção vi: <Home>
  • Modo de comando vi: <Home>

EndOfLine

Se a entrada tiver várias linhas, mova para o final da linha atual ou, se já estiver no final da linha, vá para o final da entrada. Se a entrada tiver uma única linha, vá para o final da entrada.

  • Cmd: <End>
  • Emacs: <End>, <Ctrl+e>
  • Modo de inserção vi: <End>

ForwardChar

Mova o cursor um caractere para a direita. Isso pode mover o cursor para a próxima linha de entrada de várias linhas.

  • Cmd: <RightArrow>
  • Emacs: <RightArrow>, <Ctrl+f>
  • Modo de inserção vi: <RightArrow>
  • Modo de comando vi: <RightArrow>, <Space>, <l>

ForwardWord

Mova o cursor para o final da palavra atual ou, se houver palavras, para o final da próxima palavra. Word limites são definidos por um conjunto configurável de caracteres.

  • Emacs: <Alt+f>, <Escape,f>

GotoBrace

Vá para a chave correspondente, parêntese ou colchete.

  • Cmd: <Ctrl+]>
  • Modo de inserção vi: <Ctrl+]>
  • Modo de comando vi: <Ctrl+]>

GotoColumn

Mova para a coluna indicada por arg.

  • Modo de comando vi: <|>

GotoFirstNonBlankOfLine

Mova o cursor para o primeiro caractere não em branco na linha.

  • Modo de comando vi: <^>

MoveToEndOfLine

Mova o cursor para o final da entrada.

  • Modo de comando Vi: <End>, <$>

NextLine

Mova o cursor para a próxima linha.

  • A função é desvinculada.

NextWord

Mova o cursor para o início da próxima palavra. Word limites são definidos por um conjunto configurável de caracteres.

  • Cmd: <Ctrl+RightArrow>
  • Modo de inserção vi: <Ctrl+RightArrow>
  • Modo de comando vi: <Ctrl+RightArrow>

NextWordEnd

Mova o cursor para o final da palavra atual ou, se houver palavras, para o final da próxima palavra. Word limites são definidos por um conjunto configurável de caracteres.

  • Modo de comando vi: <e>

PreviousLine

Mova o cursor para a linha anterior.

  • A função é desvinculada.

ShellBackwardWord

Mova o cursor de volta para o início da palavra atual ou, se entre palavras, o início da palavra anterior. Word limites são definidos por tokens do PowerShell.

  • A função é desvinculada.

ShellForwardWord

Mova o cursor para o início da próxima palavra. Word limites são definidos por tokens do PowerShell.

  • A função é desvinculada.

ShellNextWord

Mova o cursor para o final da palavra atual ou, se houver palavras, para o final da próxima palavra. Word limites são definidos por tokens do PowerShell.

  • A função é desvinculada.

ViBackwardWord

Mova o cursor de volta para o início da palavra atual ou, se entre palavras, o início da palavra anterior. Word limites são definidos por um conjunto configurável de caracteres.

  • Modo de comando vi: <b>

ViEndOfGlob

Move o cursor para o final da palavra, usando apenas espaço em branco como delimitadores.

  • Modo de comando vi: <E>

ViEndOfPreviousGlob

Move-se para o final da palavra anterior, usando apenas espaço em branco como um delimitador de palavras.

  • A função é desvinculada.

ViGotoBrace

Semelhante a GotoBrace, mas é baseado em caractere em vez de baseado em token.

  • Modo de comando vi: <%>

ViNextGlob

Passa para a próxima palavra, usando apenas espaço em branco como delimitador de palavras.

  • Modo de comando vi: <W>

ViNextWord

Mova o cursor para o início da próxima palavra. Word limites são definidos por um conjunto configurável de caracteres.

  • Modo de comando vi: <w>

Funções de histórico

BeginningOfHistory

Mova para o primeiro item do histórico.

  • Emacs: <Alt+<>'

ClearHistory

Limpa o histórico no PSReadLine. Isso não afeta o histórico do PowerShell.

  • Cmd: <Alt+F7>

EndOfHistory

Mova para o último item (a entrada atual) no histórico.

  • Emacs: <Alt+>>

ForwardSearchHistory

Execute uma pesquisa de encaminhamento incremental por meio do histórico.

  • Cmd: <Ctrl+s>
  • Emacs: <Ctrl+s>

HistorySearchBackward

Substitua a entrada atual pelo item 'anterior' do histórico PSReadLine que corresponde aos caracteres entre o início e a entrada e o cursor.

  • Cmd: <F8>

HistorySearchForward

Substitua a entrada atual pelo item 'next' do histórico PSReadLine que corresponde aos caracteres entre o início e a entrada e o cursor.

  • Cmd: <Shift+F8>

NextHistory

Substitua a entrada atual pelo item 'next' do histórico PSReadLine.

  • Cmd: <DownArrow>
  • Emacs: <DownArrow>, <Ctrl+n>
  • Modo de inserção vi: <DownArrow>
  • Modo de comando vi: <DownArrow>, <j>, <+>

PreviousHistory

Substitua a entrada atual pelo item 'anterior' do histórico PSReadLine.

  • Cmd: <UpArrow>
  • Emacs: <UpArrow>, <Ctrl+p>
  • Modo de inserção vi: <UpArrow>
  • Modo de comando vi: <UpArrow>, <k>, <->

ReverseSearchHistory

Execute uma pesquisa incremental com versões anteriores por meio do histórico.

  • Cmd: <Ctrl+r>
  • Emacs: <Ctrl+r>

ViSearchHistoryBackward

Solicita uma cadeia de caracteres de pesquisa e inicia a pesquisa em AcceptLine.

  • Modo de inserção vi: <Ctrl+r>
  • Modo de comando Vi: </>, <Ctrl+r>

Funções de conclusão

Concluir

Tente executar a conclusão no texto ao redor do cursor. Se houver várias conclusões possíveis, o prefixo inequívoco mais longo será usado para conclusão. Se estiver tentando concluir a conclusão inequívoca mais longa, uma lista de conclusões possíveis será exibida.

  • Emacs: <Tab>

Tente executar a conclusão no texto ao redor do cursor. Se houver várias conclusões possíveis, o prefixo inequívoco mais longo será usado para conclusão. Se estiver tentando concluir a conclusão inequívoca mais longa, uma lista de conclusões possíveis será exibida.

  • Cmd: <Ctrl+Space>
  • Emacs: <Ctrl+Space>

PossibleCompletions

Exiba a lista de conclusões possíveis.

  • Emacs: <Alt+=>
  • Modo de inserção vi: <Ctrl+Space>
  • Modo de comando vi: <Ctrl+Space>

TabCompleteNext

Tente concluir o texto em torno do cursor com a próxima conclusão disponível.

  • Cmd: <Tab>
  • Modo de comando vi: <Tab>

TabCompletePrevious

Tente concluir o texto ao redor do cursor com a conclusão disponível anterior.

  • Cmd: <Shift+Tab>
  • Modo de comando Vi: <Shift+Tab>

ViTabCompleteNext

Encerra o grupo de edição atual, se necessário, e invoca TabCompleteNext.

  • Modo de inserção vi: <Tab>

ViTabCompletePrevious

Encerra o grupo de edição atual, se necessário, e invoca TabCompletePrevious.

  • Modo de inserção vi: <Shift+Tab>

Funções diversas

CaptureScreen

Inicie a captura de tela interativa – setas para cima/para baixo selecionem linhas, insira o texto selecionado para a área de transferência como texto e html.

  • A função não está relacionada.

ClearScreen

Limpe a tela e desenhe a linha atual na parte superior da tela.

  • Cmd: <Ctrl+l>
  • Emacs: <Ctrl+l>
  • Modo de inserção vi: <Ctrl+l>
  • Modo de comando Vi: <Ctrl+l>

DigitArgument

Inicie um novo argumento de dígito para passar para outras funções.

  • Cmd: <Alt+0>, <Alt+1>, <Alt+2>, , <Alt+4><Alt+3>, <Alt+5>, <Alt+6>, <Alt+7>, <Alt+8>, , <Alt+9>,<Alt+->
  • Emacs: <Alt+0>, <Alt+1>, , <Alt+2>, <Alt+4><Alt+3>, <Alt+5>, <Alt+6>, <Alt+7>, <Alt+8>, , <Alt+9>,<Alt+->
  • Modo de comando Vi: <0>, <1>, , <3><2>, <4>, <5>, <6>, <7>, , <8><9>

InvokePrompt

Apaga o prompt atual e chama a função prompt para exibir novamente o prompt. Útil para manipuladores de chave personalizados que alteram o estado, por exemplo, altere o diretório atual.

  • A função não está relacionada.

ScrollDisplayDown

Role a tela para baixo em uma tela.

  • Cmd: <PageDown>
  • Emacs: <PageDown>

ScrollDisplayDownLine

Role a tela uma linha para baixo.

  • Cmd: <Ctrl+PageDown>
  • Emacs: <Ctrl+PageDown>

ScrollDisplayToCursor

Role a tela até o cursor.

  • Emacs: <Ctrl+End>

ScrollDisplayTop

Role a tela até a parte superior.

  • Emacs: <Ctrl+Home>

ScrollDisplayUp

Role a tela para cima em uma tela.

  • Cmd: <PageUp>
  • Emacs: <PageUp>

ScrollDisplayUpLine

Role a tela para cima em uma linha.

  • Cmd: <Ctrl+PageUp>
  • Emacs: <Ctrl+PageUp>

SelfInsert

Insira a chave.

  • A função não está relacionada.

ShowKeyBindings

Mostrar todas as teclas associadas.

  • Cmd: <Ctrl+Alt+?>
  • Emacs: <Ctrl+Alt+?>
  • Modo de inserção vi: <Ctrl+Alt+?>

ViCommandMode

Alterne o modo de operação atual de Vi-Insert para Vi-Command.

  • Modo de inserção vi: <Escape>

ViDigitArgumentInChord

Inicie um novo argumento de dígito para passar para outras funções enquanto estiver em um dos acordes de vi.

  • A função não está relacionada.

ViEditVisually

Edite a linha de comando em um editor de texto especificado por $env:EDITOR ou $env:VISUAL.

  • Emacs: <Ctrl+x,Ctrl+e>
  • Modo de comando Vi: <v>

ViExit

Sai do shell.

  • A função não está relacionada.

ViInsertMode

Alterne para o modo Inserir.

  • Modo de comando Vi: <i>

WhatIsKey

Leia uma chave e me diga a qual chave está associada.

  • Cmd: <Alt+?>
  • Emacs: <Alt+?>

Funções de seleção

ExchangePointAndMark

O cursor é colocado no local da marca e a marca é movida para o local do cursor.

  • Emacs: <Ctrl+x,Ctrl+x>

SelectAll

Selecione a linha inteira.

  • Cmd: <Ctrl+a>

SelectBackwardChar

Ajuste a seleção atual para incluir o caractere anterior.

  • Cmd: <Shift+LeftArrow>
  • Emacs: <Shift+LeftArrow>

SelectBackwardsLine

Ajuste a seleção atual para incluir do cursor até o início da linha.

  • Cmd: <Shift+Home>
  • Emacs: <Shift+Home>

SelectBackwardWord

Ajuste a seleção atual para incluir a palavra anterior.

  • Cmd: <Shift+Ctrl+LeftArrow>
  • Emacs: <Alt+B>

SelectForwardChar

Ajuste a seleção atual para incluir o próximo caractere.

  • Cmd: <Shift+RightArrow>
  • Emacs: <Shift+RightArrow>

SelectForwardWord

Ajuste a seleção atual para incluir a próxima palavra usando ForwardWord.

  • Emacs: <Alt+F>

Selecionar Linha

Ajuste a seleção atual para incluir do cursor até o final da linha.

  • Cmd: <Shift+End>
  • Emacs: <Shift+End>

SelectNextWord

Ajuste a seleção atual para incluir a próxima palavra.

  • Cmd: <Shift+Ctrl+RightArrow>

SelectShellBackwardWord

Ajuste a seleção atual para incluir a palavra anterior usando ShellBackwardWord.

  • A função não está relacionada.

SelectShellForwardWord

Ajuste a seleção atual para incluir a próxima palavra usando ShellForwardWord.

  • A função não está relacionada.

SelectShellNextWord

Ajuste a seleção atual para incluir a próxima palavra usando ShellNextWord.

  • A função não está relacionada.

SetMark

Marque o local atual do cursor para uso em um comando de edição subsequente.

  • Emacs: <Ctrl+>'

Pesquisa funções

CharacterSearch

Leia um caractere e pesquise a próxima ocorrência desse caractere. Se um argumento for especificado, pesquise para frente (ou para trás se negativo) para a nª ocorrência.

  • Cmd: <F3>
  • Emacs: <Ctrl+]>
  • Modo de inserção vi: <F3>
  • Modo de comando Vi: <F3>

CharacterSearchBackward

Leia um caractere e pesquise para trás a próxima ocorrência desse caractere. Se um argumento for especificado, pesquise para trás (ou para frente, se negativo) para a nª ocorrência.

  • Cmd: <Shift+F3>
  • Emacs: <Ctrl+Alt+]>
  • Modo de inserção vi: <Shift+F3>
  • Modo de comando Vi: <Shift+F3>

RepeatLastCharSearch

Repita a última pesquisa de caracteres gravada.

  • Modo de comando Vi: <;>

RepeatLastCharSearchBackwards

Repita a última pesquisa de caracteres gravada, mas na direção oposta.

  • Modo de comando Vi: <,>

RepeatSearch

Repita a última pesquisa na mesma direção de antes.

  • Modo de comando Vi: <n>

RepeatSearchBackward

Repita a última pesquisa na mesma direção de antes.

  • Modo de comando Vi: <N>

SearchChar

Leia o próximo caractere e, em seguida, encontre-o, daqui para frente e, em seguida, desative um caractere. Isso é para a funcionalidade 't'.

  • Modo de comando Vi: <f>

SearchCharBackward

Leia o próximo caractere e, em seguida, encontre-o, indo para trás e, em seguida, desative um caractere. Isso é para a funcionalidade 'T'.

  • Modo de comando Vi: <F>

SearchCharBackwardWithBackoff

Leia o próximo caractere e, em seguida, encontre-o, indo para trás e, em seguida, desative um caractere. Isso é para a funcionalidade 'T'.

  • Modo de comando Vi: <T>

SearchCharWithBackoff

Leia o próximo caractere e, em seguida, encontre-o, daqui para frente e, em seguida, desative um caractere. Isso é para a funcionalidade 't'.

  • Modo de comando Vi: <t>

Searchforward

Solicita uma cadeia de caracteres de pesquisa e inicia a pesquisa em AcceptLine.

  • Modo de inserção vi: <Ctrl+s>
  • Modo de comando Vi: <?>, <Ctrl+s>

Associações de chave personalizadas

O PSReadLine dá suporte a associações de chave personalizadas usando o cmdlet Set-PSReadLineKeyHandler. A maioria das associações de chave personalizadas chama uma das funções acima, por exemplo

Set-PSReadLineKeyHandler -Key UpArrow -Function HistorySearchBackward

Você pode associar um ScriptBlock a uma chave. O ScriptBlock pode fazer praticamente tudo o que você quiser. Alguns exemplos úteis incluem

  • editar a linha de comando
  • abrindo uma nova janela (por exemplo, ajuda)
  • alterar diretórios sem alterar a linha de comando

O ScriptBlock recebe dois argumentos:

  • $key - Um objeto [ConsoleKeyInfo] que é a chave que disparou a associação personalizada. Se você associar o mesmo ScriptBlock a várias chaves e precisar executar ações diferentes dependendo da chave, poderá marcar $key. Muitas associações personalizadas ignoram esse argumento.

  • $arg - Um argumento arbitrário. Na maioria das vezes, esse seria um argumento inteiro que o usuário passa das associações de chave DigitArgument. Se a associação não aceitar argumentos, será razoável ignorar esse argumento.

Vamos dar uma olhada em um exemplo que adiciona uma linha de comando ao histórico sem executá-la. Isso é útil quando você percebe que esqueceu de fazer algo, mas não deseja inserir novamente a linha de comando que você já inseriu.

$parameters = @{
    Key = 'Alt+w'
    BriefDescription = 'SaveInHistory'
    LongDescription = 'Save current line in history but do not execute'
    ScriptBlock = {
      param($key, $arg)   # The arguments are ignored in this example

      # GetBufferState gives us the command line (with the cursor position)
      $line = $null
      $cursor = $null
      [Microsoft.PowerShell.PSConsoleReadLine]::GetBufferState([ref]$line,
        [ref]$cursor)

      # AddToHistory saves the line in history, but does not execute it.
      [Microsoft.PowerShell.PSConsoleReadLine]::AddToHistory($line)

      # RevertLine is like pressing Escape.
      [Microsoft.PowerShell.PSConsoleReadLine]::RevertLine()
  }
}
Set-PSReadLineKeyHandler @parameters

Você pode ver muitos outros exemplos no arquivo SamplePSReadLineProfile.ps1 que está instalado na pasta do módulo PSReadLine.

A maioria das associações de teclas usa algumas funções auxiliares para editar a linha de comando. Essas APIs estão documentadas na próxima seção.

APIs de suporte à associação de chave personalizada

As funções a seguir são públicas em Microsoft.PowerShell.PSConsoleReadLine, mas não podem ser associadas diretamente a uma chave. A maioria é útil em associações de chave personalizadas.

void AddToHistory(string command)

Adicione uma linha de comando ao histórico sem executá-la.

void ClearKillRing()

Limpe o kill-ring. Isso é usado principalmente para teste.

void Delete(int start, int length)

Exclua caracteres de comprimento desde o início. Esta operação dá suporte a desfazer/refazer.

void Ding()

Execute a ação Ding com base na preferência dos usuários.

void GetBufferState([ref] string input, [ref] int cursor)
void GetBufferState([ref] Ast ast, [ref] Token[] tokens,
  [ref] ParseError[] parseErrors, [ref] int cursor)

Essas duas funções recuperam informações úteis sobre o estado atual do buffer de entrada. O primeiro é mais comumente usado para casos simples. O segundo será usado se a associação estiver fazendo algo mais avançado com o Ast.

IEnumerable[Microsoft.PowerShell.KeyHandler]
  GetKeyHandlers(bool includeBound, bool includeUnbound)

Essa função é usada por Get-PSReadLineKeyHandler e provavelmente não é útil em uma associação de chave personalizada.

Microsoft.PowerShell.PSConsoleReadLineOptions GetOptions()

Essa função é usada por Get-PSReadLineOption e provavelmente não é muito útil em uma associação de chave personalizada.

void GetSelectionState([ref] int start, [ref] int length)

Se não houver seleção na linha de comando, -1 será retornado no início e no comprimento. Se houver uma seleção na linha de comando, o início e o comprimento da seleção serão retornados.

void Insert(char c)
void Insert(string s)

Insira um caractere ou cadeia de caracteres no cursor. Esta operação dá suporte a desfazer/refazer.

string ReadLine(runspace remoteRunspace,
  System.Management.Automation.EngineIntrinsics engineIntrinsics)

Esse é o ponto de entrada main para PSReadLine. Ele não dá suporte à recursão, portanto, não é útil em uma associação de chave personalizada.

void RemoveKeyHandler(string[] key)

Essa função é usada por Remove-PSReadLineKeyHandler e provavelmente não é muito útil em uma associação de chave personalizada.

void Replace(int start, int length, string replacement)

Substitua parte da entrada. Esta operação dá suporte a desfazer/refazer. Isso é preferencial em vez de Excluir seguido por Inserir porque ele é tratado como uma única ação para desfazer.

void SetCursorPosition(int cursor)

Mova o cursor para o deslocamento fornecido. O movimento do cursor não é rastreado para desfazer.

void SetOptions(Microsoft.PowerShell.SetPSReadLineOption options)

Essa função é um método auxiliar usado pelo cmdlet Set-PSReadLineOption, mas pode ser útil para uma associação de chave personalizada que deseja alterar temporariamente uma configuração.

bool TryGetArgAsInt(System.Object arg, [ref] int numericArg,
  int defaultNumericArg)

Esse método auxiliar é usado para associações personalizadas que respeitam DigitArgument. Uma chamada típica se parece com

[int]$numericArg = 0
[Microsoft.PowerShell.PSConsoleReadLine]::TryGetArgAsInt($arg,
  [ref]$numericArg, 1)

Observação

Histórico de Comandos

O PSReadLine mantém um arquivo de histórico que contém todos os comandos e dados inseridos na linha de comando. Isso pode conter dados confidenciais, incluindo senhas. Por exemplo, se você usar o ConvertTo-SecureString cmdlet, a senha será registrada no arquivo de histórico como texto sem formatação. Os arquivos de histórico são um arquivo chamado $($host.Name)_history.txt. Em sistemas Windows, o arquivo de histórico é armazenado em $env:APPDATA\Microsoft\Windows\PowerShell\PSReadLine. Em sistemas não Windows, os arquivos de histórico são armazenados em $env:XDG_DATA_HOME/powershell/PSReadLine ou $env:HOME/.local/share/powershell/PSReadLine.

Comentários & contribuindo para o PSReadLine

PSReadLine no GitHub

Fique à vontade para enviar uma solicitação de pull ou enviar comentários na página do GitHub.

Consulte Também

O PSReadLine é fortemente influenciado pela biblioteca de linha de leitura do GNU.