about_PSReadLine

Descrição curta

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
• Conclusão do estilo Bash (opcional no modo Cmd, padrão no modo Emacs)
• Emacs puxar/matar anel
• Movimentação e exclusão baseadas em token do PowerShell

O PSReadLine requer o PowerShell 3.0 ou mais recente. O PSReadLine funciona com host de console padrão, Visual Studio Code e Terminal de Janela. Ele não funciona no ISE do PowerShell.

O PSReadLine 2.1.0 é fornecido com o PowerShell 7.2 e tem suporte em todas as versões com suporte do PowerShell. Ele está disponível para instalação na Galeria do PowerShell. Para instalar o PSReadLine 2.1.0 em uma versão com suporte do PowerShell, execute o comando a seguir.

Install-Module -Name PSReadLine -RequiredVersion 2.1.0

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

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

Abortar

Anulação da ação atual, por exemplo: pesquisa de histórico incremental.

• Emacs: <Ctrl+g>

Aceitare e obtenhaPróximo

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 em que ReadLine for chamado.

• Emacs: <Ctrl+o>

Linha de Aceitação

Tente executar a entrada atual. Se a entrada atual estiver incompleta (por exemplo, há um parêntese de fechamento ausente, colchete ou aspas), 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 o PSReadLine aguarda chaves para editar 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 anel de exclusão.

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

Linha de Morte para Trás

Desmarque a entrada do início da entrada para o cursor. O texto desmarcado é colocado no anel de eliminação.

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

Palavras para trás

Desmarque 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 desmarcado é colocado no anel de eliminação.

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

Cancelar Linha

Cancele a entrada atual, deixando a entrada na tela, mas retorne ao 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>

Cortar

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

• Cmd: <Ctrl+x>

ExcluirChar

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,Spacebar>

ExcluirCharOrExit

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

• Emacs: <Ctrl+d>

DeleteEndOfBuffer

Exclui até o final do buffer de várias linhas.

• Modo de comando vi: <d,G>

ExcluirEndOfWord

Excluir até o final da palavra.

• Modo de comando vi: <d,e>

Linha de exclusão

Exclui a linha lógica atual de um buffer multilinha, permitindo desfazer.

• Modo de comando Vi: <d,d>, <d,_>

ExcluirLinhas Anteriores

Exclui as linhas lógicas solicitadas anteriormente e a linha lógica atual em um buffer de várias linhas.

• Modo de comando vi: <d,k>

ExcluirLinhas Relativas

Exclui do início do buffer para a linha lógica atual em um buffer de várias linhas.

Como a maioria dos comandos Vi, o comando <d,g,g> pode ser acrescentado com um argumento numérico que especifica um número de linha absoluto, que, juntamente com o número de linha atual, compõem um intervalo de linhas a serem excluídas. Se não for especificado, o argumento numérico padrão será 1, que se refere à primeira linha lógica em um buffer multilinha.

O número real de linhas a serem excluídas da multilinha é computado como a diferença entre o número de linha lógica atual e o argumento numérico especificado, que pode, portanto, ser negativo. Portanto, o relativo parte do nome do método.

• Modo de comando vi: <d,g,g>

ExcluirPróximaLinhas

Exclui a linha lógica atual e as próximas linhas lógicas solicitadas em um buffer de várias linhas.

• Modo de comando vi: <d,j>

ExcluirLinhaParaPrimeiroCaractere

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

• Modo de comando vi: <d,^>

ExcluirParaFim

Excluir até o final da linha.

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

Excluir palavra

Exclua a próxima palavra.

• Modo de comando vi: <d,w>

ForwardDeleteLine

Assim como ForwardKillLine - exclui o texto do ponto até o final da linha, mas não coloca o texto excluído no anel de exclusão.

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

Inserir Linha Acima

Uma nova linha vazia é criada acima da linha atual, independentemente de onde o cursor esteja na linha atual. O cursor passa 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 passa 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: <~>

Linha de Matar

Desmarque a entrada do cursor até o final da entrada. O texto desmarcado é colocado no anel de eliminação.

• Emacs: <Ctrl+k>

Região de Matar

Mate o texto entre o cursor e a marca.

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

Palavra de Morte

Desmarque a entrada do cursor até o final da palavra atual. Se o cursor estiver entre palavras, a entrada será desmarcada do cursor até o final da próxima palavra. O texto desmarcado é colocado no anel de eliminação.

• Cmd: <Alt+d>, <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>

Cole depois

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

• Modo de comando vi: <p>

ColarAntes

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

• Modo de comando vi: <P>

PrependAndAccept

Prepare um '#' e aceite a linha.

• Modo de comando vi: <#>

Refazer

Desfazer uma desfazer.

• 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

Desmarque 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 desmarcado é colocado no anel de eliminação.

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

ShellKillWord

Desmarque a entrada do cursor até o final da palavra atual. Se o cursor estiver entre palavras, a entrada será desmarcada do cursor até o final da próxima palavra. O texto desmarcado é colocado no anel de eliminação.

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

Caracteres de troca

Troque o caractere atual e o anterior.

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

Desfazer tudo

Desfazer todas as edições anteriores para linha.

• Modo de comando vi: <U>

UnixWordRubout

Desmarque 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 desmarcado é colocado no anel de eliminação.

• Emacs: <Ctrl+w>

ValidateAndAcceptLine

Tente executar a entrada atual. Se a entrada atual estiver incompleta (por exemplo, há um parêntese de fechamento ausente, colchete ou aspas), 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 o espaço em branco como delimitador de palavras.

• Modo de comando vi: <d,B>

ViBackwardGlob

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

• Modo de comando vi: <B>

ViDeleteBrace

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

• Modo de comando vi: <d,%>

ViDeleteEndOfGlob

Excluir 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é determinado caractere.

• Modo de comando vi: <d,t>

ViDeleteToBeforeCharBackward

Exclui até determinado caractere.

• Modo de comando vi: <d,T>

ViDeleteToChar

Exclui até determinado caractere.

• Modo de comando vi: <d,f>

ViDeleteToCharBackward

Exclui para trás até determinado caractere.

• 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

Apago toda a linha de comando.

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

ViReplaceToBeforeChar

Substitui até determinado caractere.

• Modo de comando vi: <c,t>

ViReplaceToBeforeCharBackward

Substitui até determinado caractere.

• Modo de comando vi: <c,T>

ViReplaceToChar

Exclui até determinado caractere.

• Modo de comando vi: <c,f>

ViReplaceToCharBackward

Substitui até determinado caractere.

• 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 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 do próximo WORD(s).

• Modo de comando vi: <y,W>

ViYankNextWord

Puxe a palavra após o cursor.

• Modo de comando vi: <y,w>

ViYankPercent

Puxe de/para a chave correspondente.

• Modo de comando vi: <y,%>

ViYankAnteriorGlob

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

• Modo de comando vi: <y,B>

ViYankAnteriorPalavra

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

• Modo de comando vi: <y,b>

ViYankRight

Puxe caracteres para baixo e à direita do cursor.

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

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 YankNthArg. Se invocado várias vezes, em vez disso, itera por meio do histórico e o arg define a direção (negativo inverte a direção).)

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

YankNthArg

Puxe o primeiro argumento (após o comando) da linha de histórico anterior. Com um argumento, remova o nth argumento (a partir de 0), se o argumento for negativo, comece do último argumento.

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

YankPop

Se a operação anterior fosse Yank ou YankPop, substitua o texto anteriormente arrancado pelo texto morto seguinte do anel de eliminação.

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

Palavra anterior

Mova o cursor de volta para o início da palavra atual ou, se entre palavras, o início da palavra anterior. Os limites do Word 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>

Os caracteres que definem limites de palavra são configurados na propriedade WordDelimiters do objeto PSConsoleReadLineOptions. Para exibir ou alterar a propriedade WordDelimiters, consulte Get-PSReadLineOption e Set-PSReadLineOption.

Começo de Linha

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>

Fim da Linha

Se a entrada tiver várias linhas, vá 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>

Palavra de encaminhamento

Mova o cursor para a frente até o final da palavra atual, ou se entre palavras, para o final da próxima palavra. Os limites do Word são definidos por um conjunto configurável de caracteres.

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

Os caracteres que definem limites de palavra são configurados na propriedade WordDelimiters do objeto PSConsoleReadLineOptions. Para exibir ou alterar a propriedade WordDelimiters, consulte Get-PSReadLineOption e Set-PSReadLineOption.

Ir para Brace

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

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

Ir para Coluna

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: <^>, <_>

MoverParaEndOfLine

Mova o cursor para o final da entrada.

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

Linha Seguinte

Mova o cursor para a próxima linha.

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

PróximoPalavra

Mova o cursor para a frente até o início da próxima palavra. Os limites do Word 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>

Os caracteres que definem limites de palavra são configurados na propriedade WordDelimiters do objeto PSConsoleReadLineOptions. Para exibir ou alterar a propriedade WordDelimiters, consulte Get-PSReadLineOption e Set-PSReadLineOption.

PróximoPalavraFim

Mova o cursor para a frente até o final da palavra atual, ou se entre palavras, para o final da próxima palavra. Os limites do Word são definidos por um conjunto configurável de caracteres.

• Modo de comando vi: <e>

Os caracteres que definem limites de palavra são configurados na propriedade WordDelimiters do objeto PSConsoleReadLineOptions. Para exibir ou alterar a propriedade WordDelimiters, consulte Get-PSReadLineOption e Set-PSReadLineOption.

Linha Anterior

Mova o cursor para a linha anterior.

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

ShellBackwardWord

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

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

ShellForwardWord

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

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

ShellNextWord

Mova o cursor para a frente até o final da palavra atual, ou se entre palavras, para o final da próxima palavra. Os limites do Word são definidos por tokens do PowerShell.

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

ViBackwardChar

Mova o cursor um caractere para a esquerda no modo de edição do Vi. Isso pode mover o cursor para a linha anterior de entrada de várias linhas.

• Modo de inserção vi: <LeftArrow>
• Modo de comando Vi: <LeftArrow>, <Backspace>, <h>

ViBackwardWord

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

• Modo de comando vi: <b>

Os caracteres que definem limites de palavra são configurados na propriedade WordDelimiters do objeto PSConsoleReadLineOptions. Para exibir ou alterar a propriedade WordDelimiters, consulte Get-PSReadLineOption e Set-PSReadLineOption.

ViForwardChar

Mova o cursor um caractere para a direita no modo de edição do Vi. Isso pode mover o cursor para a próxima linha de entrada de várias linhas.

• Modo de inserção vi: <RightArrow>
• Modo de comando Vi: <RightArrow>, <Spacebar>, <l>

ViEndOfGlob

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

• Modo de comando vi: <E>

ViEndOfPreviousGlob

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

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

ViGotoBrace

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

• Modo de comando vi: <%>

ViNextGlob

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

• Modo de comando vi: <W>

ViNextWord

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

• Modo de comando vi: <w>

Os caracteres que definem limites de palavra são configurados na propriedade WordDelimiters do objeto PSConsoleReadLineOptions. Para exibir ou alterar a propriedade WordDelimiters, consulte Get-PSReadLineOption e Set-PSReadLineOption.

Funções de histórico

Começo da História

Mova para o primeiro item do histórico.

• Emacs: <Alt+<>

Limpar História

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

• Cmd: <Alt+F7>

Fim da história

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

• Emacs: <Alt+>>

ForwardSearchHistory

Execute uma pesquisa 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>

HistóriaPesquisaEncaminhar

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>

PróximoHistória

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>, <+>

AnteriorHistória

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

Completar

Tente executar a conclusão no texto ao redor do cursor. Se houver várias conclusões possíveis, o prefixo inequívoca 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>

Cardápio Completo

Tente executar a conclusão no texto ao redor do cursor. Se houver várias conclusões possíveis, o prefixo inequívoca 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+@>, <Ctrl+Spacebar>
• Emacs: <Ctrl+Spacebar>

Conclusões possíveis

Exiba a lista de conclusões possíveis.

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

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 em torno do cursor com a conclusão disponível anterior.

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

ViTabCompleteNext

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

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

ViTabCompletePrevious

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

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

Funções diversas

AcceptNextSuggestionWord

Aceite a próxima palavra da sugestão embutida ou selecionada.

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

AceitarSugestão

Aceite a sugestão embutida ou selecionada atual.

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

Tela de captura

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

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

Limpar Tela

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

Argumento de dígito

Inicie um novo argumento de dígito para passar para outras funções. Você pode usá-lo como um multiplicador para a próxima função que é invocada por uma tecla. Por exemplo, pressionar <Alt+1><Alt+0> define o valor de argumento de dígito como 10. Em seguida, pressionar a tecla # envia 10 # caracteres (##########) para a linha de entrada. Da mesma forma, você pode usá-lo com outras operações, como <Delete> ou Left-Arrow.

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

Invocar Prompt

Apaga o prompt atual e chama a função de prompt para redisplay do prompt. Útil para manipuladores de chaves personalizados que alteram o estado. Por exemplo, altere o diretório atual.

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

ScrollDisplayDown

Role a exibição para baixo em uma tela.

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

ScrollDisplayDownLine

Role a exibição para baixo em uma linha.

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

ScrollDisplayToCursor

Role a exibição até o cursor.

• Emacs: <Ctrl+End>

ScrollDisplayTop

Role a exibição 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>

Autoinserção

Insira a chave.

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

ShowKeyBindings

Mostrar todas as chaves associadas.

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

Modo de comando do Vi

Alterne o modo operacional 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.

ViEditVisualmente

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>

Saída Vi

Sai do shell.

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

Modo de inserção de vis

Alterne para o modo Inserir.

• Modo de comando vi: <i>

O que é a chave

Leia uma chave e me diga ao que a 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>

Selecionar Tudo

Selecione a linha inteira.

• Cmd: <Ctrl+a>

SelecioneBackwardChar

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>

SelecioneBackwardWord

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

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

SelecioneForwardChar

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

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

SelecioneEncaminharPalavra

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>

SelecionePróximoPalavra

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

• Cmd: <Shift+Ctrl+RightArrow>

SelecioneShellBackwardWord

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

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

SelecioneShellForwardWord

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

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

SelecioneShellPróximoWord

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

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

Marca do conjunto

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

• Emacs: <Ctrl+@>

Funções preditivas do IntelliSense

AcceptNextWordSuggestion

Aceita a próxima palavra da sugestão embutida do Predictive IntelliSense. Essa função pode ser vinculada com Ctrl+F executando o comando a seguir.

Set-PSReadLineKeyHandler -Chord "Ctrl+f" -Function ForwardWord

AceitarSugestão

Aceita a sugestão embutida atual do IntelliSense Preditivo pressionando Seta para a direita quando o cursor está no final da linha atual.

Funções de pesquisa

Pesquisa de Personagens

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>

PersonagemPesquisaBackward

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: <,>

Repetir Pesquisa

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, retire um caractere. Isso é para a funcionalidade 't'.

• Modo de comando vi: <f>

ProcurarCharBackward

Leia o próximo caractere e, em seguida, localize-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, localize-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, retire um caractere. Isso é para a funcionalidade 't'.

• Modo de comando vi: <t>

Pesquisar para a frente

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

PSReadLine oferece suporte a associações de teclas 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á verificar $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, é 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 quer 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 chave usa algumas funções auxiliares para editar a linha de comando. Essas APIs estão documentadas na próxima seção.

APIs de suporte de associação de chave personalizada

As funções a seguir são públicas em Microsoft.PowerShell.PSConsoleReadLine, mas não podem ser diretamente associadas 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()

Desmarque o anel de morte. Isso é usado principalmente para testes.

void Delete(int start, int length)

Exclua caracteres de comprimento desde o início. Essa 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)

IEnumerable[Microsoft.PowerShell.KeyHandler]
  GetKeyHandlers(string[] Chord)

Essas duas funções são usadas por Get-PSReadLineKeyHandler. O primeiro é usado para obter todas as associações de chave. O segundo é usado para obter associações de chave específicas.

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, a função retornará -1 em início e 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. Essa operação dá suporte a desfazer/refazer.

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

Esse é o ponto de entrada principal 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. Essa operação dá suporte a desfazer/refazer. Isso é preferencial em vez de Excluir seguido por Inserir porque é 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 é controlado 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 o DigitArgument. Uma chamada típica se parece com

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

Anotações

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

O histórico pode conter dados confidenciais, incluindo senhas. O PSReadLine tenta filtrar informações confidenciais. Todas as linhas de comando que contêm as cadeias de caracteres a seguir não são gravadas no arquivo de histórico.

• senha
• texto simples
• símbolo
• Chave de API
• segredo

Feedback e Contribuição para o PSReadLine

PSReadLine no GitHub

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

Consulte Também

• O PSReadLine é fortemente influenciado pelo GNU biblioteca de de linha de leitura.