{"id":13111,"date":"2011-08-04T00:01:00","date_gmt":"2011-08-04T00:01:00","guid":{"rendered":"https:\/\/blogs.technet.microsoft.com\/heyscriptingguy\/2011\/08\/04\/use-an-easy-powershell-command-to-search-files-for-information\/"},"modified":"2011-08-04T00:01:00","modified_gmt":"2011-08-04T00:01:00","slug":"use-an-easy-powershell-command-to-search-files-for-information","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/scripting\/use-an-easy-powershell-command-to-search-files-for-information\/","title":{"rendered":"Use an Easy PowerShell Command to Search Files for Information"},"content":{"rendered":"

Summary<\/b>: Learn how to use a Windows PowerShell command to search easily for information in a collection of files.<\/p>\n

 <\/p>\n

\"Hey,Hey, Scripting Guy! I need to be able to parse multiple files for text that are in a single folder. I hate to have to write a script for such a common task, but I am afraid I will have to do so. Can you help me?<\/p>\n

—SH<\/p>\n

 <\/p>\n

\"Hey,Hello SH,<\/p>\n

Microsoft Scripting Guy Ed Wilson here. The Scripting Wife and I are trying to get things sorted out this week before we leave for Corpus Christi, Texas, where I will be teaching a Windows PowerShell class. In addition, we will be appearing at the inaugural meeting of the Corpus Christi PowerShell User Group meeting<\/a>. If you will be in South Texas on August 9, 2011, you should come check it out. It should be great fun. Oh, by the way, I am doing a meeting today with Lincoln SQL Server User Group (ssug)<\/a>. The meeting will be available via Live Meeting. It feels like this week started late and will end early. Luckily, SH, the answer to your question is no, you do not have to write a script to parse a folder full of files for a particular string. In fact, it was a topic that was tested in the Beginner Event 6 in the 2011 Scripting Games<\/a>.<\/p>\n

The solution is to use the Select-String<\/b> cmdlet. One thing to keep in mind is that the Select-String<\/b> cmdlet reads text files; it cannot read the more complicated file types such as .doc and .docx files that are generated by Microsoft Word. When I attempted to search a folder containing the Word documents and pictures that make up a typical Hey, Scripting Guy! Blog post, Windows PowerShell displayed a bunch of gibberish in the console, and then locked up. This is shown in the following figure.<\/p>\n

\"Image<\/a><\/p>\n

The easy way to avoid producing gibberish is to specify the file types you want to search. For example, if I want to search all text files in the c:\\fso directory for a pattern of ed <\/i>(such as my first name), I include a wildcard character in my path specification, and choose any file that has the file extension of .txt. <\/i>The nice thing about the Select-String<\/b> cmdlet is that it expects the path<\/i> as well as the pattern <\/i>parameter to be strings, so I do not need to use quotation marks for either the pattern or the path. I can use the following command to search the c:\\fso folder for files that have the .txt <\/i>file extension, and contain a pattern match for ed<\/i>:<\/i><\/p>\n

Select-String -Path c:\\fso\\*.txt -pattern ed<\/p>\n

The command and associated output are shown in the following figure.<\/p>\n

<\/a><\/p>\n

\"Image<\/a><\/p>\n

If I use the Get-Command<\/b> cmdlet (gcm<\/b> is an alias for this cmdlet) to examine the syntax for the Select-String<\/b> cmdlet, I see that both the path <\/i>and the pattern <\/i>parameters will accept an array of strings. This means that I can use the wildcard character trick with the file extensions to look for multiple files at the same time. To examine only the syntax of the Select-String<\/b> cmdlet, I used the Get-Command<\/b> cmdlet and piped the output to the Select-Object<\/b> cmdlet (select<\/b> is an alias). I then chose to expand the definition<\/b> property. The resulting command is shown here:<\/p>\n

gcm select-string | select -expand definition<\/p>\n

The command and associated output are shown in the following figure.<\/p>\n

\"Image<\/a><\/p>\n

Because I can supply an array of strings to the path <\/i>parameter, I can search for both .log <\/i>files and .txt <\/i>files at the same time. In my revised Select-String<\/b> command, I search the c:\\fso folder for both .txt <\/i>and .log <\/i>files. I look inside both types of files for a pattern match of ed.<\/i> The revised command is shown here:<\/p>\n

Select-String -Path c:\\fso\\*.txt, c:\\fso\\*.log -pattern ed<\/b><\/p>\n

The command and associated output are shown in the following figure.<\/p>\n

\"Image<\/a><\/p>\n

Because the pattern <\/i>parameter also accepts an array of strings, I can also search the .txt <\/i>and the .log <\/i>files for both ed<\/i> and teresa <\/i>strings. The command to search the c:\\fso folder for both .txt<\/i> and for .log<\/i> files, and to look for pattern matches with both ed<\/i> and teresa<\/i> is shown in the following figure.<\/p>\n

\"Image<\/a><\/p>\n

In addition to directly using the path <\/i>parameter in the Select-String<\/b> cmdlet, it may be easier to use the Get-Childitem<\/b> cmdlet for more granular control over the files to be parsed. In the following command, I use the dir<\/b> <\/i>command (an alias for the Get-ChildItem<\/b> cmdlet) and provide the path of c:\\fso (the path does not appear in the command because it is the default parameter). I include only .txt <\/i>and .log <\/i>files (I use the –I <\/b>and rely on parameter completion to specify the include<\/i> parameter. I do the same thing with the recurse<\/i> switch (in that I just use the letter r<\/b>). I pipe the results to the Select-String<\/b> cmdlet and look for the pattern fail <\/i>(pattern<\/i> is the default parameter and therefore is omitted in the command). The long version of the command is shown here:<\/p>\n

Get-ChildItem -Path c:\\fso -Include *.txt, *.log -Recurse | Select-String -Pattern fail<\/p>\n

Here is an example of the shorter form of the command.<\/p>\n

dir c:\\fso -I *.txt, *.log -R | Select-String fail<\/p>\n

The command and associated output are shown here.<\/p>\n

\"Image<\/a><\/p>\n

Interestingly enough, the above output displays information from an install.log file, and it shows a bunch of failures. I decide that I would like to see the successes as well as the failures. I modify the command by adding the word success<\/i> to the pattern. The revised command is shown here:<\/p>\n

dir c:\\fso -I *.txt, *.log -R | Select-String fail, success<\/p>\n

\"Image<\/a> <\/p>\n

As I look over the output from the previous command, I see a pattern appearing: on all the servers, the installation failed. On the client computers, the installation was a success. But I am missing my Windows XP computers in the output. I decide to add the word pending<\/i> to my array of search terms. Here is the revised command:<\/p>\n

dir c:\\fso -I *.txt, *.log -R | Select-String fail, success, pending<\/p>\n

The command and associated output are shown in the following figure.<\/p>\n

\"Image<\/a><\/p>\n

 <\/p>\n

Well, SH, thank you for your question. I hope I have encouraged you to spend a bit more time exploring the Select-String<\/b> cmdlet.<\/p>\n

I invite you to follow me on Twitter<\/a> and to join the Scripting Guys on Facebook<\/a>. If you have any questions, send email to me at scripter@microsoft.com<\/a>, or post your questions on the Official Scripting Guys Forum<\/a>. See you tomorrow. Until then, peace.<\/p>\n

Ed Wilson, Microsoft Scripting Guy<\/b><\/p>\n

 <\/p>\n

 <\/p>\n","protected":false},"excerpt":{"rendered":"

Summary: Learn how to use a Windows PowerShell command to search easily for information in a collection of files.   Hey, Scripting Guy! I need to be able to parse multiple files for text that are in a single folder. I hate to have to write a script for such a common task, but I […]<\/p>\n","protected":false},"author":596,"featured_media":87096,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[1],"tags":[3,4,281,21,14,45],"class_list":["post-13111","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-scripting","tag-scripting-guy","tag-scripting-techniques","tag-select-string","tag-string-manipulation","tag-text-files","tag-windows-powershell"],"acf":[],"blog_post_summary":"

Summary: Learn how to use a Windows PowerShell command to search easily for information in a collection of files.   Hey, Scripting Guy! I need to be able to parse multiple files for text that are in a single folder. I hate to have to write a script for such a common task, but I […]<\/p>\n","_links":{"self":[{"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/posts\/13111","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/users\/596"}],"replies":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/comments?post=13111"}],"version-history":[{"count":0,"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/posts\/13111\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/media\/87096"}],"wp:attachment":[{"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/media?parent=13111"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/categories?post=13111"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/tags?post=13111"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}