Grepo

grepo is an implementation of the Unix command grep in Go. grep is a tool used for searching files or input streams for lines that match a specified pattern.

Features

• search in provided file
• search in directory
• performs case sensitive,case insensitive, exact matches
• stores output in given file path
• output match count, lines after and before match

How to use

• clone this repository [git clone https://github.com/PratikJethe/grepo.git]
• run go build in root of the project
• execute binary with appropriate flags [./grepo.exe -f filename.txt -s search_word]

Flags

grepo supports various flags. multiple flags can be combined to generate desired output

flag	desrcription	datatype
-f	accepts file/dir path where search is to be done	string
-s	accepts search query	string
-i	performs case insensitive search	bool
-e	performs exact matching search	bool
-o	accepts output file path to store output	string
-c	show only count of matches	bool
-a	display lines after match	bool
-b	display lines before match	bool

Examples

Note: Test data used for examples is taken from test folder in repository

1. Simple search in given file

$ ./grepo.exe -f test/test_data.txt -s test
Match in file: test/test_data.txt  line  1:0 "test line for one occurrencein single line"
Match in file: test/test_data.txt  line  2:0 "test for multiple occurences in single line test test"
Match in file: test/test_data.txt  line  2:44 "test for multiple occurences in single line test test"
Match in file: test/test_data.txt  line  2:49 "test for multiple occurences in single line test test"

2. Case insensitive search in given file

$ ./grepo.exe -f test/test_data.txt -s test -i
Match in file: test/test_data.txt  line  1:0 "test line for one occurrencein single line"
Match in file: test/test_data.txt  line  2:0 "test for multiple occurences in single line test test"
Match in file: test/test_data.txt  line  2:44 "test for multiple occurences in single line test test"
Match in file: test/test_data.txt  line  2:49 "test for multiple occurences in single line test test"
Match in file: test/test_data.txt  line  4:0 "Test for case-insensitive "
Match in file: test/test_data.txt  line  5:0 "Testing for excat match"

3. Exact matching search in given file

$ ./grepo.exe -f test/test_data.txt -s Testing  -e
Match in file: test/test_data.txt  line  5:0 "Testing for excat match"

4. -i -e flags combined

$ ./grepo.exe -f test/test_data.txt -s testing  -e -i
Match in file: test/test_data.txt  line  5:0 "Testing for excat match"

5. Accept input from user

$ ./grepo.exe -s lorem test testing tested lorem ipsum
Match found: lorem

6. Accept input from user with -i and -e flag

$ ./grepo.exe  -s test -i -e lorem testing Testing test Test
Match found: test
Match found: Test

7. Store output in given filepath

$ ./grepo.exe -f test/test_data.txt -s test -o output.txt
output stored into output.txt
$ cat output.txt 
Match in file: test/test_data.txt  line  1:0 "test line for one occurrencein single line"
Match in file: test/test_data.txt  line  2:0 "test for multiple occurences in single line test test"
Match in file: test/test_data.txt  line  2:44 "test for multiple occurences in single line test test"
Match in file: test/test_data.txt  line  2:49 "test for multiple occurences in single line test test"

8. Search in all text files of a given directory

 ./grepo.exe -s test -f test
Match in file: test\before_after.txt  line  4:0 "test line here"
Match in file: test\directory_one\test_data_dir_1.txt  line  1:0 "test data in directory one"
Match in file: test\test_json.json  line  2:5 "    "test":"can serach in files other than txt""
Match in file: test\test_data.txt  line  1:0 "test line for one occurrencein single line"
Match in file: test\test_data.txt  line  2:0 "test for multiple occurences in single line test test"
Match in file: test\test_data.txt  line  2:44 "test for multiple occurences in single line test test"
Match in file: test\test_data.txt  line  2:49 "test for multiple occurences in single line test test"
Match in file: test\directory_two\test_data_dir_2.txt  line  1:0 "test data in directory one

9. Show only count of matches

$ ./grepo.exe -f test -s  test -c
Number of matches : 8

10. Show lines before match

$ ./grepo.exe -s test  -f test/before_after.txt  -b
line number 1 above match 
line number 2 above match
line number 3 above match

11. Show lines after match

$ ./grepo.exe -s test  -f test/before_after.txt   -a
line number 1 after match 
line number 2 after match
line number 3 after match

12. Show lines after and before match

$ ./grepo.exe -s test  -f test/before_after.txt   -a -b
line number 1 before match 
line number 2 before match
line number 3 before match
line number 1 after match
line number 2 after match
line number 3 after match