Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
MrAliSalehi authored Jun 19, 2023
1 parent 05a847a commit b6212d6
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,22 @@
# simple-grip
simple `grip-like` program that allows you to search files/directories with a specific pattern


# use
```
<PATH> base path to search
<PATTERN> regex pattern, its recommended to wrap it around single quotes(')
Options:
-r, --reverse show anything that doesnt match the patterns
-s <TARGET> search target, can either be name of the files/directories or file contents [default: names] [possible values: names, contents]
-t <MAX_THREAD> set max thread count [default: 0]
-d <MAX_DEPTH> max directory depth to search [default: 3]
-h, --help Print help
-V, --version Print version
```
- for example:

`simple-grip /path/to/dir 'pattern\+' -s names -t 3 -d 4`

will go in `/path/to/dir` and search for the files/directories that matches the `'pattern\+' ` with maximum 3 threads and `tree-depth` of 3

0 comments on commit b6212d6

Please sign in to comment.