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 PowerShell 7.3 é fornecido com PSReadLine 2.2.6. A versão atual é PSReadLine 2.3.4. A versão atual do PSReadLine pode ser instalada e usada no Windows PowerShell 5.1 e mais recente. Para alguns recursos, você precisa estar executando o PowerShell 7.2 ou superior.
O PSReadLine 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 e exclusão baseadas em token do PowerShell
- IntelliSense preditivo
- Exibição dinâmica da Ajuda no console sem perder seu lugar na linha de comando
O PSReadLine requer o PowerShell 5.1 ou mais recente. O PSReadLine funciona com o host do console do Windows padrão, Terminal do Windows e Visual Studio Code. Ele não funciona no ISE do Windows PowerShell.
O PSReadLine pode ser instalado do Galeria do PowerShell. Para instalar o PSReadLine em uma versão com suporte do PowerShell, execute o comando a seguir.
Install-Module -Name PSReadLine -AllowClobber -Force
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.
IntelliSense preditivo
O IntelliSense preditivo é uma adição ao conceito de preenchimento com tabulação que ajuda o usuário a concluir comandos com êxito. Ele permite que os usuários descubram, editem e executem comandos completos com base em previsões correspondentes do histórico do usuário e plug-ins específicos de domínio adicionais.
Habilitar IntelliSense Preditivo
O IntelliSense Preditivo está desabilitado por padrão. Para habilitar previsões, basta executar o seguinte comando:
Set-PSReadLineOption -PredictionSource History
O parâmetro PredictionSource também pode aceitar plug-ins para requisitos específicos e personalizados do domínio.
Para desabilitar o IntelliSense Preditivo, basta executar:
Set-PSReadLineOption -PredictionSource None
Observação
O IntelliSense preditivo está habilitado por padrão no PSReadLine 2.2.6. Para obter mais informações, consulte o histórico de versões do PSReadLine na seção Anotações abaixo.
Associações de chave personalizadas
O PSReadLine dá suporte a associações de chave personalizadas usando o Set-PSReadLineKeyHandler
cmdlet . A maioria das associações de chave personalizadas chama uma das funções associáveis, 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 em about_PSReadLine_Functions.
Observaçõ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. As linhas de comando que contêm as cadeias de caracteres a seguir não são gravadas no arquivo de histórico.
password
asplaintext
token
apikey
secret
O PSReadLine 2.2.0 melhora a filtragem de dados confidenciais
- Usa a AST (Árvore de Sintaxe Abstrata) do PowerShell da linha de comando analisada para procurar dados confidenciais.
- Usa uma lista de permitidos de cmdlets seguros do módulo SecretManagement para permitir que esses comandos sejam adicionados ao histórico. A lista de permitidos contém:
Get-Secret
Get-SecretInfo
Get-SecretVault
Register-SecretVault
Remove-Secret
Set-SecretInfo
Set-SecretVaultDefault
Test-SecretVault
Unlock-SecretVault
Unregister-SecretVault
Por exemplo, os seguintes comandos têm permissão para serem gravados no arquivo de histórico:
Get-Secret PSGalleryApiKey -AsPlainText # Get-Secret is in the allowlist
$token = Get-Secret -Name github-token -Vault MySecret
[MyType]::CallRestAPI($token, $url, $args)
$template -f $token
Os comandos a seguir não estão sendo gravados no arquivo de histórico:
$token = 'abcd' # Assign expr-value to sensitive variable name.
Set-Secret abc $mySecret # Set-Secret is not in the allowlist.
ConvertTo-SecureString stringValue -AsPlainText # '-AsPlainText' is an alert.
Invoke-WebRequest -Token xxx # Expr-value as argument to '-Token'.
Get-ResultFromTwo -Secret1 (Get-Secret -Name blah -AsPlainText) -Secret2 sdv87ysdfayf798hfasd8f7ha # '-Secret2' has expr-value argument.
Se houver outros comandos que você não deseja gravar nos arquivos de histórico, você poderá usar o parâmetro AddToHistoryHandler do Set-PSReadLineOption
cmdlet . Para obter um exemplo de como usar AddToHistoryHandler, consulte Exemplo 7 de Set-PSReadLineOption.
O PSReadLine 2.3.4 melhora a filtragem de dados confidenciais
Melhorou a depuração de histórico confidencial padrão para permitir que o histórico contenha acesso à propriedade segura.
Quando a cadeia de caracteres confidencial faz parte de um acesso à propriedade:
- Se essa operação de acesso de membro não fizer parte de uma atribuição, consideraremos isso seguro
- Caso contrário, se o lado direito for um pipeline ou uma variável, também o consideraremos seguro
Por exemplo, os casos de uso a seguir são considerados seguros e podem ser salvos no histórico.
$a.Secret = Get-Secret -Name github-token -Vault MySecret
$a.Secret = $secret
$a.Password.Secret | Set-Value
$token = (Get-AzAccessToken -ResourceUrl 'https://app.contoso.com').Token
A versão também melhorou a depuração de histórico confidencial para permitir a recuperação de token usando as az
ferramentas de linha de comando , gcloud
e kubectl
.
Por exemplo, os casos de uso a seguir são considerados seguros e podem ser salvos no histórico.
kubectl get secrets
kubectl get secret db-user-pass -o jsonpath='{.data.password}' | base64 --decode
kubectl describe secret db-user-pass
az account get-access-token --resource=https://app.contoso.com --query accessToken --output tsv
$env:PGPASS = gcloud auth print-access-token
Histórico de versões do PSReadLine
Houve muitas atualizações no PSReadLine desde a versão fornecida no Windows PowerShell 5.1.
- A versão atual é PSReadLine 2.3.4
- O PowerShell 7.4 é fornecido com PSReadLine 2.3.4
- O PowerShell 7.3 é fornecido com PSReadLine 2.2.6
- O PowerShell 7.2 é fornecido com PSReadLine 2.1.0
- PowerShell 7.0.11 fornecido com PSReadLine 2.0.4
- O PowerShell 5.1 é fornecido com PSReadLine 2.0.0
Para obter uma lista completa de alterações, consulte o PSReadLine ChangeLog.
- PSReadLine 2.3.4
Além de várias correções de bugs, esta versão inclui os seguintes aprimoramentos:
ListView rolável para IntelliSense Preditivo
- Dimensiona automaticamente o tamanho com base no tamanho da janela do terminal
- Pode conter até 50 resultados de previsão
- Cabeçalho de lista dinâmica que mostra o número de resultados e a fonte de previsão atual
Limpeza de histórico confidencial aprimorada para permitir a recuperação de token de
az
,gcloud
ekubectl
Melhorar a eliminação de histórico confidencial padrão para permitir o acesso seguro à propriedade
Adicionado suporte para upcasing, downcasing e palavras de maiúsculas
Fazer a conclusão da guia mostrar resultados cujos
ListItemText
são diferentes apenas por casoDá suporte ao comando
<d,i,w>
text-object no modo de edição VIAlterar a cor padrão para que a previsão embutida diminua
Adicionar um exemplo ao README para transformar o ponto de código Unicode em caractere Unicode por
Alt+x
Adicione a opção TerminateOrphanedConsoleApps no Windows para acabar com o processo anexado ao console órfão que pode atrapalhar a leitura da entrada do console
PSReadLine 2.2.6
Nesta versão, o recurso Predictive IntelliSense é habilitado por padrão, dependendo das seguintes condições:
- Se houver suporte para o VT (Terminal Virtual) e o PSReadLine estiver em execução no PowerShell 7.2 ou superior, PredictionSource será definido como
HistoryAndPlugin
- Se houver suporte para VT e PSReadLine em execução no PowerShell antes da 7.2, PredictionSource será definido como
History
- Se não houver suporte para VT, PredictionSource será definido como
None
- Se houver suporte para o VT (Terminal Virtual) e o PSReadLine estiver em execução no PowerShell 7.2 ou superior, PredictionSource será definido como
PSReadLine 2.2.5
Versão oficial de manutenção com correções de bug secundárias.
PSReadLine 2.2.2
- O PSReadLine adicionou dois novos recursos preditivos do IntelliSense:
- Adicionado o parâmetro PredictionViewStyle para permitir a seleção do novo
ListView
. - PSReadLine conectado às
CommandPrediction
APIs introduzidas no PowerShell 7.2 para permitir que um usuário possa importar um módulo de preditor que possa renderizar as sugestões de uma fonte personalizada.
- Adicionado o parâmetro PredictionViewStyle para permitir a seleção do novo
- Atualizado para usar a versão 1.0.0 do
Microsoft.PowerShell.Pager
para obter ajuda dinâmica - Melhoramos a eliminação de itens de histórico confidenciais
- Muitas correções de bugs e melhorias menores
- O PSReadLine adicionou dois novos recursos preditivos do IntelliSense:
PSReadLine 2.1.0
Esta versão acumula os seguintes aprimoramentos adicionados desde a versão 2.0.4:
- Adicionar sugestões preditivas do IntelliSense do histórico de comandos
- Muitas correções de bugs e aprimoramentos de API
PSReadLine 2.0.4
Esta versão acumula os seguintes aprimoramentos adicionados desde a versão 2.0.0:
- Adicionado o
-Chord
parâmetro para permitir aGet-PSReadLineKeyHandler
pesquisa de associações de chave específicas
- Adicionado o
Comentários & contribuindo para o PSReadLine
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.