Select-String

Select-String
    [-Pattern] <String[]>
    [-Path] <String[]>
    [-Culture <String>]
    [-SimpleMatch]
    [-CaseSensitive]
    [-Quiet]
    [-List]
    [-NoEmphasis]
    [-Include <String[]>]
    [-Exclude <String[]>]
    [-NotMatch]
    [-AllMatches]
    [-Encoding <Encoding>]
    [-Context <Int32[]>]
    [<CommonParameters>]

Select-String
    [-Pattern] <String[]>
    -InputObject <PSObject>
    -Raw
    [-Culture <String>]
    [-SimpleMatch]
    [-CaseSensitive]
    [-List]
    [-NoEmphasis]
    [-Include <String[]>]
    [-Exclude <String[]>]
    [-NotMatch]
    [-AllMatches]
    [-Encoding <Encoding>]
    [-Context <Int32[]>]
    [<CommonParameters>]

Select-String
    [-Pattern] <String[]>
    -InputObject <PSObject>
    [-Culture <String>]
    [-SimpleMatch]
    [-CaseSensitive]
    [-Quiet]
    [-List]
    [-NoEmphasis]
    [-Include <String[]>]
    [-Exclude <String[]>]
    [-NotMatch]
    [-AllMatches]
    [-Encoding <Encoding>]
    [-Context <Int32[]>]
    [<CommonParameters>]

Select-String
    [-Pattern] <String[]>
    [-Path] <String[]>
    -Raw
    [-Culture <String>]
    [-SimpleMatch]
    [-CaseSensitive]
    [-List]
    [-NoEmphasis]
    [-Include <String[]>]
    [-Exclude <String[]>]
    [-NotMatch]
    [-AllMatches]
    [-Encoding <Encoding>]
    [-Context <Int32[]>]
    [<CommonParameters>]

Select-String
    [-Pattern] <String[]>
    -LiteralPath <String[]>
    -Raw
    [-Culture <String>]
    [-SimpleMatch]
    [-CaseSensitive]
    [-List]
    [-NoEmphasis]
    [-Include <String[]>]
    [-Exclude <String[]>]
    [-NotMatch]
    [-AllMatches]
    [-Encoding <Encoding>]
    [-Context <Int32[]>]
    [<CommonParameters>]

Select-String
    [-Pattern] <String[]>
    -LiteralPath <String[]>
    [-Culture <String>]
    [-SimpleMatch]
    [-CaseSensitive]
    [-Quiet]
    [-List]
    [-NoEmphasis]
    [-Include <String[]>]
    [-Exclude <String[]>]
    [-NotMatch]
    [-AllMatches]
    [-Encoding <Encoding>]
    [-Context <Int32[]>]
    [<CommonParameters>]

Select-String コマンドレットは、正規表現の照合を使用して、入力文字列とファイル内のテキスト パターンを検索します。 Unix のgrepや Windows のfindstr.exeと同様のSelect-Stringを使用できます。

Select-String はテキスト行に基づいています。 デフォルトでは、 Select-String は各行で最初の一致を検索し、一致ごとに、一致を含む行のファイル名、行番号、およびすべてのテキストを表示します。 1 行に複数の一致を検索したり、一致の前後にテキストを表示したり、一致が見つかったかどうかを示すブール値 (True または False) を表示したりするように Select-String に指示できます。

Select-String では、すべてのテキスト一致を表示するか、各入力ファイルの最初の一致後に停止できます。 Select-String 指定したパターンに一致しないすべてのテキストを表示するために使用できます。

また、Unicode テキストのファイルを検索する場合など Select-String 特定の文字エンコードを想定するように指定することもできます。 Select-String では、バイトオーダー マーク (BOM) を使用してファイルのエンコード形式を検出します。 ファイルに BOM がない場合は、エンコードが UTF8 であると見なされます。

この例では、パイプラインから Select-String コマンドレットに送信されたテキストの大文字と小文字を区別して照合します。

'Hello', 'HELLO' | Select-String -Pattern 'HELLO' -CaseSensitive -SimpleMatch

テキスト文字列 Hello と HELLO は、パイプライン経由で Select-String コマンドレットに送信されます。 Select-String Pattern パラメータを使用して HELLO を指定します。 CaseSensitive パラメーターは、大文字と小文字が大文字のパターンのみに一致する必要があることを指定します。 SimpleMatch は省略可能なパラメーターであり、パターン内の文字列が正規表現として解釈されないことを指定します。 Select-String PowerShell コンソールに HELLO を表示します。

このコマンドは、現在のディレクトリでファイル名拡張子が .txt すべてのファイルを検索します。 出力には、指定した文字列を含むファイル内の行が表示されます。

Get-Alias | Out-File -FilePath .\Alias.txt
Get-Command | Out-File -FilePath .\Command.txt
Select-String -Path .\*.txt -Pattern 'Get-'

Alias.txt:8:Alias            cat -> Get-Content
Alias.txt:28:Alias           dir -> Get-ChildItem
Alias.txt:43:Alias           gal -> Get-Alias
Command.txt:966:Cmdlet       Get-Acl
Command.txt:967:Cmdlet       Get-Alias

この例では、 Get-Alias と Get-Command を Out-File コマンドレットと共に使用して、現在のディレクトリに Alias.txt と Command.txtの 2 つのテキスト ファイルを作成します。

Select-String Path パラメータとアスタリスク (*) ワイルドカードを使用して、現在のディレクトリ内のファイル名拡張子が .txt のすべてのファイルを検索します。 Pattern パラメーターは、Get- に一致するテキストを指定します。 Select-String PowerShell コンソールに出力が表示されます。 ファイル名と行番号は、 Pattern パラメーターに一致する内容の各行の前にあります。

この例では、指定したパターンに一致するものを見つけるために、複数のファイルが検索されます。 パターンは正規表現の量指定子を使用します。 詳細については、about_Regular_Expressionsを参照してください。

Select-String -Path "$PSHOME\en-US\*.txt" -Pattern '\?'

C:\Program Files\PowerShell\6\en-US\default.help.txt:27:    beginning at https://go.microsoft.com/fwlink/?LinkID=108518.
C:\Program Files\PowerShell\6\en-US\default.help.txt:50:    or go to: https://go.microsoft.com/fwlink/?LinkID=210614

Select-String コマンドレットでは、Path と Pattern の 2 つのパラメーターを使用します。 Path パラメーターは、PowerShell ディレクトリを指定する変数 $PSHOME を使用します。 パスの残りの部分には、サブディレクトリ (en-US ) が含まれ、ディレクトリ内の各 *.txt ファイルを指定します。 Pattern パラメーターは、各ファイル内の疑問符 (?) と一致するように指定します。 バックスラッシュ (\) はエスケープ文字として使用され、疑問符 (?) は正規表現の量指定子であるため、必要です。 Select-String PowerShell コンソールに出力が表示されます。 ファイル名と行番号は、 Pattern パラメーターに一致する内容の各行の前にあります。

この例では、PowerShell ヘルプ ファイル内のパターンを検索する関数を作成します。 この例では、関数は PowerShell セッションにのみ存在します。 PowerShell セッションが閉じられると、関数は削除されます。 詳細については、about_Functionsを参照してください。

function Search-Help
{
    $PSHelp = "$PSHOME\en-US\*.txt"
    Select-String -Path $PSHelp -Pattern 'About_'
}

Search-Help

C:\Program Files\PowerShell\7\en-US\default.help.txt:67:    The titles of conceptual topics begin with "About_".
C:\Program Files\PowerShell\7\en-US\default.help.txt:70:    Get-Help About_<topic-name>
C:\Program Files\PowerShell\7\en-US\default.help.txt:93:    Get-Help About_Modules : Displays help about PowerShell modules.
C:\Program Files\PowerShell\7\en-US\default.help.txt:97:    about_Updatable_Help

この関数は、PowerShell コマンド ラインで作成されます。 function キーワードは、Search-Helpという名前を使用します。 Enter キーを押して、関数へのステートメントの追加を開始します。 >>プロンプトから、各ステートメントを追加し、例に示すようにEnterキーを押します。 閉じ括弧を追加すると、PowerShell プロンプトに戻ります。

この関数には 2 つのコマンドが含まれています。 $PSHelp 変数には、PowerShell ヘルプ ファイルへのパスが格納されます。 $PSHOMEは、ディレクトリ内の各 ファイルを指定するサブディレクトリ *.txt を持つ PowerShell インストール ディレクトリです。

関数の Select-String コマンドは、 Path パラメータと Pattern パラメータを使用します。 Path パラメーターは、$PSHelp 変数を使用してパスを取得します。 Pattern パラメーターは、検索条件として文字列 About_ を使用します。

関数を実行するには、「 Search-Help」と入力します。 関数の Select-String コマンドは、PowerShell コンソールに出力を表示します。

この例では、Windows イベント ログで文字列を検索します。 変数 $_ は、パイプライン内の現在のオブジェクトを表します。 詳細については、about_Automatic_Variablesを参照してください。

$Events = Get-WinEvent -LogName Application -MaxEvents 50
$Events | Select-String -InputObject {$_.Message} -Pattern 'Failed'

Get-WinEvent コマンドレットは、LogName パラメーターを使用してアプリケーション ログを指定します。 MaxEvents パラメーターは、ログから最新の 50 個のイベントを取得します。 ログの内容は、 $Events という名前の変数に格納されます。

$Events 変数は、パイプラインから Select-String コマンドレットに送信されます。 Select-String InputObject パラメータを使用します。 $_変数は現在のオブジェクトを表し、Messageはイベントのプロパティです。 Pattern パラメーターは、失敗した文字列を指定し、$_.Messageで一致を検索します。 Select-String PowerShell コンソールに出力が表示されます。

この例では、ディレクトリとそのすべてのサブディレクトリで特定のテキスト文字列を検索します。

Get-ChildItem -Path C:\Windows\System32\*.txt -Recurse |
    Select-String -Pattern 'Microsoft' -CaseSensitive

Get-ChildItem Path パラメーターを使用して C:\Windows\System32*.txtを指定します。 Recurse パラメーターには、サブディレクトリが含まれます。 オブジェクトはパイプラインを通ってSelect-Stringに送られます。

Select-String Pattern パラメーターを使用し、文字列 Microsoft を指定します。 CaseSensitive パラメーターは、文字列の大文字と小文字を正確に一致させるために使用されます。 Select-String PowerShell コンソールに出力が表示されます。

この例では、パターンに一致しないデータ行を除外する方法を示します。

Get-Command | Out-File -FilePath .\Command.txt
Select-String -Path .\Command.txt -Pattern 'Get', 'Set'  -NotMatch

Get-Command コマンドレットは、オブジェクトをパイプラインから Out-File に送信し、現在のディレクトリに Command.txtID ファイルを作成します。 Select-String は Path パラメータを使用して Command.txt ファイルを指定します。 Pattern パラメーターは、検索パターンとして Get と Set を指定します。 NotMatch パラメーターは、結果から Get と Set を除外します。 Select-String PowerShell コンソールに Get または Set を含まない出力を表示します。

この例では、一致したパターンの前後の行を取得する方法を示します。

Get-Command | Out-File -FilePath .\Command.txt
Select-String -Path .\Command.txt -Pattern 'Get-Computer' -Context 2, 3

  Command.txt:986:Cmdlet          Get-CmsMessage           6.1.0.0    Microsoft.PowerShell.Security
  Command.txt:987:Cmdlet          Get-Command              6.1.2.0    Microsoft.PowerShell.Core
> Command.txt:988:Cmdlet          Get-ComputerInfo         6.1.0.0    Microsoft.PowerShell.Management
  Command.txt:990:Cmdlet          Get-Content              6.1.0.0    Microsoft.PowerShell.Management
  Command.txt:991:Cmdlet          Get-ControlPanelItem     3.1.0.0    Microsoft.PowerShell.Management
  Command.txt:992:Cmdlet          Get-Credential           6.1.0.0    Microsoft.PowerShell.Security

Get-Command コマンドレットは、オブジェクトをパイプラインから Out-File に送信し、現在のディレクトリに Command.txtID ファイルを作成します。 Select-String は Path パラメータを使用して Command.txt ファイルを指定します。 Pattern パラメーターは、検索パターンとしてGet-Computerを指定します。 Context パラメーターは、before と after の 2 つの値を使用し、出力のパターン一致を山かっこ (>) でマークします。 Context パラメータは、最初のパターン一致の前の 2 行と最後のパターン一致の 3 行を出力します。

この例では、 AllMatches パラメーターがテキスト行内の各パターン一致を検索する方法を示します。 デフォルトでは、 Select-String はテキスト行内で最初に出現するパターンのみを検索します。 この例では、 Get-Member コマンドレットで見つかったオブジェクト プロパティを使用します。

$A = Get-ChildItem -Path "$PSHOME\en-US\*.txt" | Select-String -Pattern 'PowerShell'
$A

C:\Program Files\PowerShell\7\en-US\default.help.txt:3:    PowerShell Help System
C:\Program Files\PowerShell\7\en-US\default.help.txt:6:    Displays help about PowerShell cmdlets and concepts.
C:\Program Files\PowerShell\7\en-US\default.help.txt:9:    PowerShell Help describes PowerShell cmdlets

$A.Matches

Groups   : {0}
Success  : True
Name     : 0
Captures : {0}
Index    : 4
Length   : 10
Value    : PowerShell

$A.Matches.Length

8

$B = Get-ChildItem -Path "$PSHOME\en-US\*.txt" | Select-String -Pattern 'PowerShell' -AllMatches
$B.Matches.Length

9

Get-ChildItem コマンドレットは Path パラメーターを使用します。 Path パラメーターは、PowerShell ディレクトリを指定する変数 $PSHOME を使用します。 パスの残りの部分には、サブディレクトリ (en-US ) が含まれ、ディレクトリ内の各 *.txt ファイルを指定します。 Get-ChildItemオブジェクトは $A 変数に格納されます。 $A 変数は、パイプラインから Select-String コマンドレットに送信されます。 Select-String Pattern パラメーターを使用して、各ファイルで文字列 PowerShell を検索します。

PowerShell コマンド ラインから、 $A 変数の内容が表示されます。 文字列 PowerShell の 2 つの出現を含む行があります。

$A.Matches プロパティには、各行に PowerShell パターンが最初に出現する箇所が一覧表示されます。

$A.Matches.Length プロパティは、各行でパターン PowerShell が最初に出現する回数をカウントします。

$B 変数は、同じ Get-ChildItem コマンドレットと Select-String コマンドレットを使用しますが、AllMatches パラメーターを追加します。 AllMatches は、各行で パターン PowerShell の各出現箇所を検索します。 $A変数と$B変数に格納されるオブジェクトは同じです。

$B.Matches.Length プロパティは、各行でパターン PowerShell のすべての出現がカウントされるため、増加します。

パイプされたオブジェクトの ToString() 結果は、PowerShell の書式設定システムによって生成されるリッチ文字列表現と同じではありません。 そのため、オブジェクトをパイプ処理して最初に Out-String する必要がある場合があります。

Out-Stringへのパイプ処理は、書式設定された出力を単一の複数行の文字列オブジェクトに変換します。 つまり、 Select-String が一致するものを見つけると、複数行の文字列全体が出力されます。

PS> $hash = @{
    Name = 'foo'
    Category = 'bar'
}

# !! NO output, due to .ToString() conversion
$hash | Select-String -Pattern 'foo'

# Out-String converts the output to a single multi-line string object
PS> $hash | Out-String | Select-String -Pattern 'foo'

Name                           Value
----                           -----
Name                           foo
Category                       bar

# Out-String -Stream converts the output to a multiple single-line string objects
PS> $hash | Out-String -Stream | Select-String -Pattern 'foo'

Name                           foo

Out-String -Streamへのパイプ処理は、書式設定された出力を複数の単一行文字列オブジェクトに変換します。 つまり、 Select-String が一致するものを見つけると、一致する行のみが出力されます。

このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParametersを参照してください。

ToString() メソッドを持つ任意のオブジェクトをこのコマンドレットにパイプできます。

既定では、このコマンドレットは見つかった各一致に対して MatchInfo オブジェクトを返します。

Quiet パラメーターを使用すると、パターンが見つかったかどうかを示すブール値が返されます。

Raw パラメーターを使用すると、このコマンドレットはパターンに一致する文字列オブジェクトのセットを返します。

PowerShell には、Select-Stringの次のエイリアスが含まれています。

• すべてのプラットフォーム:
  • sls

Select-String は、Unix の grep や Windows の findstr.exe に似ています。

Select-String コマンドレットのslsエイリアスは、PowerShell 3.0 で導入されました。

オブジェクトをパイプ処理して Select-Stringする場合:

• FileInfo オブジェクトは、ファイルへのパスとして扱われます。 ファイル パスを指定すると、 Select-String はオブジェクトの ToString() 表現ではなく、ファイルの内容を検索します。
• パイプされたオブジェクトの ToString() 結果は、PowerShell の書式設定システムによって生成されるリッチ文字列表現と同じではありません。 そのため、オブジェクトをパイプ処理して最初に Out-String する必要がある場合があります。 詳細については、「例 10」を参照してください。

Select-Stringを使用するには、検索するテキストを Pattern パラメーターの値として入力します。 検索するテキストを指定するには、次の条件を使用します。

• 引用符で囲まれた文字列にテキストを入力し、 Select-Stringにパイプします。
• テキスト文字列を変数に格納し、その変数を InputObject パラメーターの値として指定します。
• テキストがファイルに格納されている場合は、 Path パラメーターを使用してファイルへのパスを指定します。

デフォルトでは、 Select-String は Pattern パラメータの値を正規表現として解釈します。 詳細については、about_Regular_Expressionsを参照してください。 SimpleMatch パラメーターを使用して、正規表現の一致をオーバーライドできます。 SimpleMatch パラメーターは、入力内の Pattern パラメーターの値のインスタンスを検索します。

Select-String のデフォルト出力は MatchInfo オブジェクトで、これには一致に関する詳細情報が含まれています。 オブジェクト内の情報は、ファイル内のテキストを検索するときに便利です。 これは、MatchInfo オブジェクトには Filename や Line などのプロパティがあるためです。 入力がファイルからのものでない場合、これらのパラメーターの値は InputStream です。

MatchInfo オブジェクトの情報が必要ない場合は、Quiet パラメータを使用します。 Quiet パラメータは、MatchInfo オブジェクトではなく、一致が見つかったかどうかを示すブール値 (True または False) を返します。

語句を一致させるとき、 Select-String はシステムに設定されている現在のカルチャを使用します。 現在のカルチャを検索するには、 Get-Culture コマンドレットを使用します。

MatchInfo オブジェクトのプロパティを検索するには、次のコマンドを入力します。

Select-String -Path test.txt -Pattern 'test' | Get-Member | Format-List -Property *