Set-PSReadLineOption

構文

Default (既定)

Set-PSReadLineOption
    [-EditMode <EditMode>]
    [-ContinuationPrompt <string>]
    [-HistoryNoDuplicates]
    [-AddToHistoryHandler <Func[string,Object]>]
    [-CommandValidationHandler <Action[CommandAst]>]
    [-HistorySearchCursorMovesToEnd]
    [-MaximumHistoryCount <int>]
    [-MaximumKillRingCount <int>]
    [-ShowToolTips]
    [-ExtraPromptLineCount <int>]
    [-DingTone <int>]
    [-DingDuration <int>]
    [-BellStyle <BellStyle>]
    [-CompletionQueryItems <int>]
    [-WordDelimiters <string>]
    [-HistorySearchCaseSensitive]
    [-HistorySaveStyle <HistorySaveStyle>]
    [-HistorySavePath <string>]
    [-AnsiEscapeTimeout <int>]
    [-PromptText <string[]>]
    [-ViModeIndicator <ViModeStyle>]
    [-ViModeChangeHandler <scriptblock>]
    [-PredictionSource <PredictionSource>]
    [-PredictionViewStyle <PredictionViewStyle>]
    [-Colors <hashtable>]
    [-TerminateOrphanedConsoleApps]
    [<CommonParameters>]

説明

例

例 1: 前景色と背景色を設定する

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

例 2: ベル スタイルを設定する

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

例 3: 複数のオプションを設定する

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

例 4: 複数のカラー オプションを設定する

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

例 5: 複数のタイプの色の値を設定する

Set-PSReadLineOption -Colors @{
 # Use a ConsoleColor enum
 "Error" = [ConsoleColor]::DarkRed

 # 24 bit color escape sequence
 "String" = "$([char]0x1b)[38;5;100m"

 # RGB value
 "Command" = "#8181f7"
}

例 6: ViModeChangeHandler を使用して Vi モードの変更を表示する

function OnViModeChange {
    if ($args[0] -eq 'Command') {
        # Set the cursor to a blinking block.
        Write-Host -NoNewline "`e[1 q"
    } else {
        # Set the cursor to a blinking line.
        Write-Host -NoNewline "`e[5 q"
    }
}
Set-PSReadLineOption -ViModeIndicator Script -ViModeChangeHandler $Function:OnViModeChange

例 7: HistoryHandler を使用して履歴に追加されたコマンドをフィルター処理する

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

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

Set-PSReadLineOption -AddToHistoryHandler $ScriptBlock

例 8: CommandValidationHandler を使用して、実行前にコマンドを検証する

# Load the namespace so you can use the [CommandAst] object type
using namespace System.Management.Automation.Language

Set-PSReadLineOption -CommandValidationHandler {
    param([CommandAst]$CommandAst)

    switch ($CommandAst.GetCommandName()) {
        'git' {
            $gitCmd = $CommandAst.CommandElements[1].Extent
            switch ($gitCmd.Text) {
                'cmt' {
                    [Microsoft.PowerShell.PSConsoleReadLine]::Replace(
                        $gitCmd.StartOffset, $gitCmd.EndOffset - $gitCmd.StartOffset, 'commit')
                }
            }
        }
    }
}
# This checks the validation script when you hit enter
Set-PSReadLineKeyHandler -Chord Enter -Function ValidateAndAcceptLine

例 9: PromptText パラメーターの使用

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

パラメーター

-AddToHistoryHandler

PSReadLine 履歴にコマンドを追加する方法を制御する ScriptBlock を指定します。

ScriptBlock は、コマンド ラインを入力として受け取ります。

ScripBlock は、AddToHistoryOption 列挙型のメンバー、それらのメンバーの 1 つの文字列名、またはブール値を返す必要があります。 次の一覧では、使用可能な値とその効果について説明します。

• - コマンドを履歴ファイルと現在のセッションに追加します。
• - 現在のセッションのみの履歴にコマンドを追加します。
• - 現在のセッションの履歴ファイルにコマンドを追加しないでください。
• - 値が された場合と同じです。
• - 値が された場合と同じです。

パラメーターのプロパティ

パラメーター セット

-AnsiEscapeTimeout

このオプションは、入力がリダイレクトされるときにWindowsに固有です (たとえば、tmux または screen で実行する場合)。

Windows でリダイレクトされた入力では、多くのキーがエスケープ文字で始まる文字のシーケンスとして送信されます。 1 つのエスケープ文字の後にさらに多くの文字が続くことと、有効なエスケープ シーケンスを区別することは不可能です。

これは、端末がユーザーが入力するよりも速く文字を送信できることを前提としています。 PSReadLine は、このタイムアウトを待ってから、完全なエスケープ シーケンスを受信したと結論付けます。

入力時にランダムまたは予期しない文字が表示される場合は、このタイムアウトを調整できます。

パラメーターのプロパティ

パラメーター セット

-BellStyle

PSReadLine がさまざまなエラーやあいまいな条件に応答する方法を指定します。

有効な値は次のとおりです。

• : 短いビープ音。
• : テキストが短時間点滅します。
• : フィードバックはありません。

パラメーターのプロパティ

パラメーター セット

-Colors

Colors パラメーターは、PSReadLine で使用されるさまざまな色を指定します。

引数はハッシュ テーブルで、キーは要素を指定し、値は色を指定します。 詳細については、「about_Hash_Tables」 を参照してください。

色は、 ConsoleColor の値 ( など) または有効な ANSI エスケープ シーケンスのいずれかです。 有効なエスケープ・シーケンスは、端末によって異なります。 PowerShell 5.0 では、赤いテキストのエスケープ シーケンスの例が です。 PowerShell 6 以降では、同じエスケープ シーケンスが 。 次のタイプを含む他のエスケープシーケンスを指定できます。

PSReadLine 2.2.0 の のカスタマイズをサポートするために、次の 2 つの色設定が追加されました。

• - 先頭の 文字と末尾のソース名 ( など) の色を設定します。 既定では、前景色として が使用されます。

• - リスト アイテムが選択されていることを示す色を設定します。 既定では、背景色として が使用されます。

• 256カラー

• 24 ビットカラー

• 前景、背景、またはその両方

• 逆、太字

ANSI カラー コードの詳細については、Wikipedia の記事 「ANSI エスケープ コード」を参照してください。

有効なキーは次のとおりです。

• : 継続プロンプトの色。
• :強調の色。 たとえば、履歴を検索するときに一致するテキストなどです。
• : エラーの色。 たとえば、プロンプトで。
• :メニュー選択または選択したテキストを強調表示する色。
• : 既定のトークンの色。
• : コメント トークンの色。
• : キーワード トークンの色。
• : 文字列トークンの色。
• : 演算子トークンの色。
• : 可変トークンの色。
• : コマンド トークンの色。
• : パラメーター トークンの色。
• : 型トークンの色。
• : 番号トークンの色。
• : メンバー名トークンの色。
• : 予測候補のインライン ビューの色。
• : 先頭の 文字と予測ソース名の色。
• : リスト ビューで選択した予測の色。

パラメーターのプロパティ

パラメーター セット

-CommandValidationHandler

ValidateAndAcceptLineから呼び出される ScriptBlock 指定します。 例外がスローされた場合、検証は失敗し、エラーが報告されます。

例外をスローする前に、検証ハンドラーはエラーの時点にカーソルを置いて、修正を容易にすることができます。 検証ハンドラーは、コマンド ラインを変更して、一般的な文字体裁エラーを修正することもできます。

ValidateAndAcceptLine は、機能しないコマンドで履歴が乱雑にならないようにするために使用されます。

パラメーターのプロパティ

パラメーター セット

-CompletionQueryItems

プロンプトなしで表示される完了項目の最大数を指定します。

表示する項目の数がこの値より大きい場合、 PSReadLine は完了項目を表示する前に yes/no を求めます。

パラメーターのプロパティ

パラメーター セット

-ContinuationPrompt

複数行の入力が入力されたときに、後続の行の先頭に表示される文字列を指定します。 既定値は、二重より大きい記号 () です。 空の文字列が有効です。

パラメーターのプロパティ

パラメーター セット

-DingDuration

BellStyle が に設定されている場合のビープ音の継続時間を指定します。

パラメーターのプロパティ

パラメーター セット

-DingTone

BellStyle が >に設定されている場合のビープ音の音色を Hertz (Hz) で指定します。

パラメーターのプロパティ

パラメーター セット

-EditMode

コマンド ライン編集モードを指定します。 このパラメーターを使用すると、によって設定されたすべてのキー バインドがリセットされます。

有効な値は次のとおりです。

• Windows: キー バインドは、PowerShell、cmd、およびVisual Studioをエミュレートします。 (Windows の既定値)
• : キー バインディングは Bash または Emacs をエミュレートします。 ( プラットフォームでは既定値)
• : キー バインドは Vi をエミュレートします。

を使用して、現在構成されている EditMode のキー バインディングを確認します。

パラメーターのプロパティ

パラメーター セット

-ExtraPromptLineCount

余分な行の数を指定します。

プロンプトが複数行にまたがる場合は、このパラメーターの値を指定します。 このオプションは、出力を表示した後に PSReadLine がプロンプトを表示するときに追加の行を使用できるようにする場合に使用します。 たとえば、 PSReadLine は入力候補の一覧を返します。

このオプションは、 以前のバージョンの PSReadLine よりも必要が少なくなっていますが、 関数を使用する場合に便利です。

パラメーターのプロパティ

パラメーター セット

-HistoryNoDuplicates

このオプションは、取り消し動作を制御します。 重複するコマンドは履歴ファイルに引き続き追加されます。 このオプションを設定すると、コマンドを呼び出すときに最新の呼び出しのみが表示されます。 繰り返しコマンドが履歴に追加され、呼び戻し中の順序が保持されます。 ただし、通常、履歴を呼び出したり検索したりするときに、コマンドを複数回表示する必要はありません。

既定では、グローバル PSConsoleReadLineOptions オブジェクトの HistoryNoDuplicates プロパティは に設定されています。 プロパティ値を変更するには、 SwitchParameter の値を次のように指定する必要があります。 。 の SwitchParameter のみを使用して、に戻すことができます。

次のコマンドを使用して、プロパティ値を直接設定できます。

(Get-PSReadLineOption).HistoryNoDuplicates = $false

パラメーターのプロパティ

パラメーター セット

-HistorySavePath

履歴を保存するファイルへのパスを指定します。 Windows または Windows プラットフォームを実行しているコンピューターは、ファイルを別の場所に格納します。 ファイル名は、変数 ( など) に格納されます。

このパラメーターを使用しない場合、既定のパスは次のようになります。

Windows

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

non-Windows

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

パラメーターのプロパティ

パラメーター セット

-HistorySaveStyle

PSReadLine が履歴を保存する方法を指定します。

有効な値は次のとおりです。

• : 各コマンドの実行後に履歴を保存し、PowerShell の複数のインスタンス間で共有します。
• : PowerShell の終了時に履歴ファイルを追加します。
• : 履歴ファイルは使用しないでください。

パラメーターのプロパティ

パラメーター セット

-HistorySearchCaseSensitive

reverseSearchHistory や HistorySearchBackwardなどの関数では、履歴検索で大文字と小文字が区別されることを指定します。

既定では、グローバル PSConsoleReadLineOptions オブジェクトの HistorySearchCaseSensitive プロパティは に設定されています。 この SwitchParameter を使用すると、プロパティ値が に設定されます。 プロパティ値を元に戻すには、 SwitchParameter の値を次のように指定する必要があります。 。

次のコマンドを使用して、プロパティ値を直接設定できます。

(Get-PSReadLineOption).HistorySearchCaseSensitive = $false

パラメーターのプロパティ

パラメーター セット

-HistorySearchCursorMovesToEnd

検索を使用して履歴から読み込むコマンドの末尾にカーソルが移動することを示します。 このパラメーターを に設定すると、カーソルは上矢印または下矢印を押したときの位置に残ります。

既定では、グローバル PSConsoleReadLineOptions オブジェクトの HistorySearchCursorMovesToEnd プロパティは に設定されています。 この SwitchParameter を使用して、プロパティ値を に設定します。 プロパティ値を元に戻すには、 SwitchParameter の値を次のように指定する必要があります。 。

次のコマンドを使用して、プロパティ値を直接設定できます。

(Get-PSReadLineOption).HistorySearchCursorMovesToEnd = $false

パラメーターのプロパティ

パラメーター セット

-MaximumHistoryCount

PSReadLine 履歴に保存するコマンドの最大数を指定します。

PSReadLine の履歴は、PowerShell の履歴とは別のものです。

パラメーターのプロパティ

パラメーター セット

-MaximumKillRingCount

キル リングに格納されるアイテムの最大数を指定します。

パラメーターのプロパティ

パラメーター セット

-PredictionSource

予測候補を取得する PSReadLine のソースを指定します。

有効な値は次のとおりです。

• - 予測 IntelliSense 機能を無効にします (既定)。
• - 予測 IntelliSense 機能を有効にし、PSReadLine 履歴を唯一のソースとして使用します。
• - 予測 IntelliSense 機能を有効にし、唯一のソースとしてプラグイン () を使用します。 この値は PSReadLine 2.2.0 で追加されました
• - 予測 IntelliSense 機能を有効にし、履歴とプラグインの両方をソースとして使用します。 この値は PSReadLine 2.2.0 で追加されました

パラメーターのプロパティ

パラメーター セット

-PredictionViewStyle

予測テキストの表示スタイルを設定します。 既定値は、 です。

• - フィッシュシェルやzshと同様に、現在のスタイル。 (default)
• - 候補はドロップダウン リストに表示され、ユーザーは UpArrow と DownArrow を使用して選択できます。

このパラメーターは PSReadLine 2.2.0 で追加されました

パラメーターのプロパティ

パラメーター セット

-PromptText

このパラメーターは 、PromptText プロパティの値を設定します。 既定値は です。

PSReadLine は、プロンプト関数を分析して、プロンプトの一部の色のみを変更する方法を決定します。 この分析は 100% 信頼性ではありません。 このオプションは、PSReadLine が予期しない方法でプロンプトを変更する場合に使用します。 末尾の空白を含めます。

このパラメーターの値には、1 つの文字列または 2 つの文字列の配列を指定できます。 最初の文字列は、解析エラーが発生したときに赤に変更するプロンプト文字列の部分です。 2 番目の文字列は、解析エラーが発生したときに使用する代替文字列です。

パラメーターのプロパティ

パラメーター セット

-ShowToolTips

可能な入力候補を表示すると、入力候補の一覧にヒントが表示されます。

このオプションは既定で有効になっています。 このオプションは、以前のバージョンの PSReadLine では既定で有効になっていませんでした。 無効にするには、このオプションを に設定します。

このパラメーターとオプションは PSReadLine 2.3.4 で追加されました。

既定では、グローバル PSConsoleReadLineOptions オブジェクトの ShowToolTips プロパティは に設定されています。 この SwitchParameter を使用すると、プロパティ値が に設定されます。 プロパティ値を変更するには、 SwitchParameter の値を次のように指定する必要があります。 。

次のコマンドを使用して、プロパティ値を直接設定できます。

(Get-PSReadLineOption).ShowToolTips = $false

パラメーターのプロパティ

パラメーター セット

-TerminateOrphanedConsoleApps

このパラメーターは、 TerminateOrphanedConsoleApps オプションを に設定します。

Windows では、Ctrl+c を押してプロセスを終了すると、コンソールにアタッチされた各プロセスはアクティブシェルではなく終了シグナルを受け取ります。 シェルが子プロセスの大きなツリーを起動した場合 (ビルド システムなど)、一部のプロセスが終了し、複数のプロセスが同時にコンソール入力を使用しようとする場合があります。

TerminateOrphanedConsoleApps オプションを に設定すると、PSReadLine は現在コンソールにアタッチされているプロセスの一覧を記録します。 その後、PSReadLine が実行されるたびに、コンソールにアタッチされたプロセスの新しい一覧が取得され、元のリストにないプロセスが終了します。

このパラメーターとオプションは PSReadLine 2.3.4 で追加されました。

パラメーターのプロパティ

パラメーター セット

-ViModeChangeHandler

ViModeIndicator が に設定されている場合、指定されたスクリプト ブロックはモードが変更されるたびに呼び出されます。 scriptblock には、 型の引数が 1 つ用意されています。

このパラメーターは PowerShell 7 で導入されました。

パラメーターのプロパティ

パラメーター セット

-ViModeIndicator

このオプションは、現在の モードのビジュアル インジケーターを設定します。 挿入モードまたはコマンド・モードのいずれかです。

有効な値は次のとおりです。

• : インジケーターはありません。
• : プロンプトの色が変更されます。
• : カーソルのサイズが変更されます。
• : ユーザー指定のテキストが出力されます。

パラメーターのプロパティ

パラメーター セット

-WordDelimiters

ForwardWord や KillWordなどの関数の単語を区切る文字を指定します。

パラメーターのプロパティ

パラメーター セット

CommonParameters

入力

None

出力

None

関連リンク

• PSReadLineについて
• Get-PSReadLineKeyHandler
• Get-PSReadLineOption
• Remove-PSReadLineKeyHandler
• Set-PSReadLineKeyHandler