kw-explore - Explore folder#

SYNOPSIS#

kw (e | explore) [(-l | --log) | (-g | --grep) | (-a | --all) | --verbose]

[(-c | --only-source) | (-H | --only-header)] [(-C[<num>] | --show-context[=<num>])] <expr> [-p] [<dir> | <file>]

DESCRIPTION#

The explore command is, by default, a wrapper to git grep, searching for string matches in files under git control or in the git log messages. Additional parameters extended its behavior to cover all files in a directory (whether or not controlled by git) and also to replace the search tool with the GNU grep utility. Default usage: you can use kw e <function-name> to find <function-name> in the source directory; If your string has spaces in it you have to quote your search (e.g., kw e "<str1> <str2>").

OPTIONS#

-l, --log:

Search the git log history by using --log after the e; for instance, kw e --log <string-match>. Additionally, you can use -p to see the diff in the search.

-g, --grep:

Search for string matches in directory contents using GNU grep tool. For instance, kw e --grep <string-match>. It also covers files inside .git directory.

-a, --all:

Search for string matches in directory contents using Git grep tool. For instance, kw e --all <string-match>. With this, the search ignores files inside .git, except if it is called inside .git directory. In other words, if you use this option you will notice that git grep is used first, and then GNU grep.

-c | --only-source:

With this option, it is possible to show only the results from the source.

-H | --only-header:

With this option, it is possible to show only the results from the header.

-C[<num>] | --show-context[=<num>]:

Show <num> lines of additional context above and below the matched line. If <num> is not specified, the default value of 3 will be used.

--verbose:

Verbose mode allows the user to see the commands executed under the hood.

EXAMPLES#

To show matched line with context using long-form flag:

kw explore --show-context=5 search_string

To show matched line with context using short flag:

kw explore -C5 search_string

Search through all tracked and untracked files, default value of 3 will be used for context:

kw explore -C --all search_string