Windows PowerShell Select-String

Introduction to Windows PowerShell Select-String

Select-String not only opens a file, but also checks for a word, a phrase, or in fact, any pattern match.

Introduction to: Select-String

The first objective is to set the -pattern parameter, which defines the string we are seeking.  Next comes the -path parameter, and as its name indicates, -path directs select-string to the file's location.

As you are reading this introduction, I expect you are thinking of possible applications for this select-string construction.  Perhaps you wish to discover which documents contain a particular word?  Alternatively, you may be seeking a more complex search-and-replace operation.  My point is that while select-string may be a bit-part in a bigger drama, you still need to master its syntax and switches.

Topics for PowerShell Select-String

• Example 1a Select-String
• Example 1b Select-String using variable $Location
• Example 1c Select-String (Wildcards *.*)
• Example 1d Select-String (Guy's indulgence)
• Traps with Select-String
• Summary of Powershell Select-String

Example 1 Select-String -path -pattern

The key to understanding select-String is studying the two main switches -path and -pattern.  They say to me, 'Where is the input?' and, 'What pattern do you want to match?'.

To ensure that my examples work, you and I need to agree on the file location and the pattern to search.  To be successful you need to embrace one of two tactics, either mimic my folder structure and patterns, or amend my script to fit in with your environment.

My folder happens to be called : D: \powershell\stuff.  My working technique is to navigate in powershell to the folder where I store the files with the cmdlet examples that I am testing.  Then I just issue the .\filename command (.Dot slash followed by the name of cmdlet which stores the PowerShell instructions).

Here are three simple scripts which all produce the same result, but each employs a slightly different method.  By studying all three you will gain both perspective and ideas for the best method to use in your scripts.

Assumptions:
You have a file called gopher.txt. 
In gopher.txt is the word Guido.

Example 1a Select-String

Instructions

1. Create the appropriate file in the appropriate folder, for example gopher.txt in D:\powershell\stuff.
2. Put the word that you wish to search for in gopher.txt.  My word, is 'Guido', and in the script it comes directly after the -pattern parameter.
3. Type this one line at the PowerShell command line:

Note 1: Look closely at the dashes '-' PowerShell's verb-noun (select-string) pair are joined by a dash with no spaces.  The parameters -path and -pattern are introduced by a space dash then the parameter itself.

Example 1b Select-String using variable $Location

This example is more complicated in that we are going to create a cmdlet, copy and paste the code below, then execute the cmdlet from inside PowerShell.

1. Copy the cmdlet, then paste it into notepad, remember to save with a .ps1 extension,
   for example: selectstr.ps1. 
2. Then I navigate in PowerShell to the folder where I saved the file, for example D: \powershell\stuff
3. Issue the command .\selectstr
4. If all else fails copy and paste the two lines into the PowerShell command line, then press 'Enter'.

Expected outcome:
D:\powershell\stuff\gopher.txt:3:Guido is king

:3:  Means line number 3
:Guido is king  Refers to the line where the Pattern "Guido" occurs.

Example 1c Select-String (Wildcards *.*)

It is often useful to search a batch of files.  The simplest method is to use the famous * or *.* wildcard.

Instructions are the same as for example 1a

Example 1d Select-String (Guy's indulgence)

My main idea in Example 1c is to introduce an If... Else clause to cater for instances where the -pattern cannot be found.  To prepare for the 'If' logic I have introduced another variable called $SearchStr.  The second time you run this script you may wish to find and amend the "zzz" to a value that will ensure success.  If you accept my challenge then you can compare the outcome of the 'If' clause with the outcome of the 'Else' clause.

Instructions are the same as for example 1a

Note 1:  Let us study the 'If' test: If ($Sel -eq $null)  What this says if the value returned by Select-String is nothing ($Null).  Incidentally, there are two lls in $null.  Also, the correct syntax is -eq and not plain old =.

Note 2: The purpose of `n is to force a carriage return.

Note 3: Once the script runs successfully, amend $SearchStr ="zzz" to a string that exists in your document.

Footnote - More parameters:

In addition to -pattern and -path, select-string has more parameters; -include and -exclude which are useful for fine tuning the files to be searched.  There is also the -caseSensitive switch to control uppercase and lowercase in the -pattern.  Select-String, like most PowerShell commands, is not case sensitive by default, hence the -caseSensitive parameter.

Traps with Select-String

The biggest trap with all PowerShell's file handling commands is looking for open-file or save-file commands.  They simply don't exist.  What happens is that PowerShell opens, closes and saves files automatically.

A real-life example of Select-String

My practical problem was that I wanted to search for instances a particular string.  If a file had duplicates, then I needed to know.

The PowerShell problem is how to create a stream of the files, then compare each file with my string value.  In the output I needed to know the filename.

To solve the problem, I employed four main commands, which you can see in the following script:

1. get-ChildItem - recurse
2. foreach (loop) {what to do block}
3. if (test) {output block}
4. select-String -pattern to match my string value.

Learning Point

Note 1:  If you want to get the above script to work, focus on the $File and $StringVid variables.  Specifically change their values to match your file location and search pattern.

Note 2: To find out more about the -f formatting switch consult SN4 in the Syntax section.

Summary of PowerShell's Select-String

Select-String is a useful instruction for opening files, and then searching their contents for the phrase specified by the -pattern parameter. My advice is to get into the rhythm of the command: for example: verb-noun then -parameter . For example: Select-String -path -pattern. As expected, you can use wildcards in the path.

Once you have mastered the basic construction look real life tasks where you can employ this technique to find words or phrases that are hiding somewhere within your files.

See more PowerShell syntax

• PowerShell Home  • Syntax  • -f format  • Pipeline  • Quotes  • Format-table  • Group  • Select-String

Please write in if you see errors of any kind.  Please report any factual mistakes, grammatical errors or broken links, I will be happy to not only to correct the fault, but also to give you credit.

 *