about_PSReadLine

  • Artikel

Kurze Beschreibung:

PSReadLine bietet eine verbesserte Befehlszeilenbearbeitung in der PowerShell-Konsole.

Es gibt viele Updates für PSReadLine seit der Version, die in Windows PowerShell 5.1 enthalten ist.

  • v2.3.5 wurde erstmals in PowerShell 7.4.2 und 7.5.0-preview.3 ausgeliefert.
  • v2.3.4 wurde erstmals in PowerShell 7.4.0-rc.1 ausgeliefert
  • v2.2.6 wurde erstmals in PowerShell 7.3.0 ausgeliefert
  • v2.1.0 wurde erstmals in PowerShell 7.2.5 ausgeliefert
  • v2.0.4 wurde erstmals in PowerShell 7.0.11 ausgeliefert
  • v2.0.0 im Lieferumfang von Windows PowerShell 5.1

Weitere Informationen zu Versionsunterschieden finden Sie unter about_PSReadLine_Release_Notes.

Lange Beschreibung

Die aktuelle Version von PSReadLine kann unter Windows PowerShell 5.1 und höher installiert und verwendet werden. Für einige Features müssen Sie PowerShell 7.2 oder höher ausführen.

PSReadLine bietet eine leistungsstarke Befehlszeilenbearbeitung für die PowerShell-Konsole. Sie bietet:

  • Syntaxfarbe der Befehlszeile
  • Ein visueller Hinweis auf Syntaxfehler
  • Eine bessere mehrzeilige Erfahrung (sowohl Bearbeiten als auch Verlauf)
  • Anpassbare Tastenbindungen
  • Cmd- und Emacs-Modi
  • Viele Konfigurationsoptionen
  • Abschluss der Bash-Formatvorlage (optional im Cmd-Modus, Standard im Emacs-Modus)
  • Emacs yank/kill-ring
  • PowerShell-Tokenbasierte "Wort"-Bewegung und -Löschung
  • Predictive IntelliSense
  • Dynamische Anzeige der Hilfe in der Konsole, ohne ihre Position in der Befehlszeile zu verlieren

PSReadLine erfordert PowerShell 5.1 oder höher. PSReadLine funktioniert mit dem standardmäßigen Windows-Konsolenhost, Windows-Terminal und Visual Studio Code. Es funktioniert nicht in der Windows PowerShell ISE.

PSReadLine kann über die PowerShell-Katalog installiert werden. Führen Sie den folgenden Befehl aus, um PSReadLine in einer unterstützten Version von PowerShell zu installieren.

Install-Module -Name PSReadLine -AllowClobber -Force

Hinweis

Ab PowerShell 7.0 überspringt PowerShell das automatische Laden von PSReadLine unter Windows, wenn ein Sprachausgabeprogramm erkannt wird. Derzeit funktioniert PSReadLine nicht gut mit den Bildschirmsprachausgaben. Das standardmäßige Rendering und die Formatierung von PowerShell 7.0 unter Windows funktioniert ordnungsgemäß. Sie können das Modul bei Bedarf manuell laden.

Predictive IntelliSense

Predictive IntelliSense ist eine Ergänzung zum Konzept des Abschlusses der Registerkarte, die den Benutzer bei der erfolgreichen Durchführung von Befehlen unterstützt. Es ermöglicht Benutzern, vollständige Befehle basierend auf übereinstimmenden Vorhersagen aus dem Verlauf des Benutzers und zusätzlichen domänenspezifischen Plug-Ins zu ermitteln, zu bearbeiten und auszuführen.

Aktivieren von Predictive IntelliSense

Predictive IntelliSense ist standardmäßig deaktiviert. Um Vorhersagen zu aktivieren, führen Sie einfach den folgenden Befehl aus:

Set-PSReadLineOption -PredictionSource History

Der Parameter "PredictionSource " kann auch Plug-Ins für domänenspezifische und benutzerdefinierte Anforderungen akzeptieren.

Um Predictive IntelliSense zu deaktivieren, führen Sie einfach Folgendes aus:

Set-PSReadLineOption -PredictionSource None

Benutzerdefinierte Schlüsselbindungen

PSReadLine unterstützt benutzerdefinierte Schlüsselbindungen mithilfe des Set-PSReadLineKeyHandler Cmdlets. Die meisten benutzerdefinierten Schlüsselbindungen rufen beispielsweise eine der bindbaren Funktionen auf.

Set-PSReadLineKeyHandler -Key UpArrow -Function HistorySearchBackward

Sie können ein ScriptBlock an einen Schlüssel binden. Der ScriptBlock kann ziemlich alles tun, was Sie wollen. Einige nützliche Beispiele sind:

  • Bearbeiten der Befehlszeile
  • Öffnen eines neuen Fensters (z. B. Hilfe)
  • Verzeichnisse ändern, ohne die Befehlszeile zu ändern

ScriptBlock empfängt zwei Argumente:

  • $key - Ein [ConsoleKeyInfo] -Objekt, das den Schlüssel darstellt, der die benutzerdefinierte Bindung ausgelöst hat. Wenn Sie denselben ScriptBlock an mehrere Schlüssel binden und je nach Schlüssel unterschiedliche Aktionen ausführen müssen, können Sie überprüfen $key. Viele benutzerdefinierte Bindungen ignorieren dieses Argument.

  • $arg - Ein beliebiges Argument. Meistens wäre dies ein ganzzahliges Argument, das der Benutzer aus den Schlüsselbindungen DigitArgument übergibt. Wenn Ihre Bindung keine Argumente akzeptiert, ist es sinnvoll, dieses Argument zu ignorieren.

Sehen wir uns ein Beispiel an, in dem dem Verlauf eine Befehlszeile hinzugefügt wird, ohne sie auszuführen. Dies ist nützlich, wenn Sie feststellen, dass Sie etwas vergessen haben, aber nicht erneut die Befehlszeile eingeben möchten, die Sie bereits eingegeben haben.

$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

Sie können viele weitere Beispiele in der Datei SamplePSReadLineProfile.ps1sehen, die im Ordner " PSReadLine-Modul " installiert ist.

Die meisten Tastenbindungen verwenden einige Hilfsfunktionen zum Bearbeiten der Befehlszeile. Diese APIs sind in about_PSReadLine_Functions dokumentiert.

Hinweise

Befehlsverlauf

PSReadLine verwaltet eine Verlaufsdatei mit allen Befehlen und Daten, die Sie über die Befehlszeile eingegeben haben. Die Verlaufsdateien sind eine Datei mit dem Namen $($host.Name)_history.txt. Auf Windows-Systemen wird die Verlaufsdatei unter $env:APPDATA\Microsoft\Windows\PowerShell\PSReadLine. Auf Nicht-Windows-Systemen werden die Verlaufsdateien unter $env:XDG_DATA_HOME/powershell/PSReadLine oder $env:HOME/.local/share/powershell/PSReadLine.

Der Verlauf kann vertrauliche Daten einschließlich Kennwörtern enthalten. PSReadLine versucht, vertrauliche Informationen herauszufiltern. Alle Befehlszeilen, die die folgenden Zeichenfolgen enthalten, werden nicht in die Verlaufsdatei geschrieben.

  • password
  • asplaintext
  • token
  • apikey
  • secret

PSReadLine 2.2.0 verbessert die Filterung vertraulicher Daten

  • Verwendet die abstrakte PowerShell-Syntaxstruktur (AST) der analysierten Befehlszeile, um nach vertraulichen Daten zu suchen.
  • Verwendet eine Zulassungsliste sicherer Cmdlets aus dem SecretManagement-Modul , damit diese Befehle dem Verlauf hinzugefügt werden können. Die Zulassungsliste enthält:
    • Get-Secret
    • Get-SecretInfo
    • Get-SecretVault
    • Register-SecretVault
    • Remove-Secret
    • Set-SecretInfo
    • Set-SecretVaultDefault
    • Test-SecretVault
    • Unlock-SecretVault
    • Unregister-SecretVault

Beispielsweise dürfen die folgenden Befehle in die Verlaufsdatei geschrieben werden:

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

Die folgenden Befehle werden nicht in die Verlaufsdatei geschrieben:

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

Wenn es andere Befehle gibt, die Sie nicht in die Verlaufsdateien schreiben möchten, können Sie den AddToHistoryHandler-Parameter des Set-PSReadLineOption Cmdlets verwenden. Ein Beispiel für die Verwendung von AddToHistoryHandler finden Sie unter Beispiel 7 von Set-PSReadLineOption.

PSReadLine 2.3.4 verbessert die Filterung vertraulicher Daten.

Das Standardmäßige Berbern vertraulicher Historien wurde verbessert, um dem Verlauf den Zugriff auf sichere Eigenschaften zu ermöglichen.

Wenn die vertrauliche Zeichenfolge Teil eines Eigenschaftenzugriffs ist:

  • Wenn dieser Mitgliedszugriffsvorgang nicht Teil einer Aufgabe ist, betrachten wir ihn als sicher.
  • Andernfalls gilt folgendes: Wenn es sich bei der rechten Seite um eine Pipeline oder eine Variable handelt, sollten wir sie auch als sicher betrachten.

Die folgenden Anwendungsfälle gelten beispielsweise als sicher und können im Verlauf gespeichert werden.

$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

Die Version hat auch das Berbern des vertraulichen Verlaufs verbessert, um das Abrufen von Token mithilfe der azBefehlszeilentools gcloudund kubectl der Befehlszeilentools zu ermöglichen.

Die folgenden Anwendungsfälle gelten beispielsweise als sicher und können im Verlauf gespeichert werden.

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

Feedback und Beitrag zu PSReadLine

PSReadLine auf GitHub

Sie können eine Pull-Anforderung senden oder Feedback auf der GitHub-Seite senden.

Weitere Informationen

  • PSReadLine wird stark von der GNU Readline-Bibliothek beeinflusst.