Interface GrepOptions

GrepOptions defines the supported options for the Git grep command.

Hierarchy

  • GrepOptions

Properties

--after-context? --all-match? --before-context? --break? --cached? --column? --context? --count? --exclude-standard? --files-with-matches? --files-without-match? --fixed-strings? --function-context? --heading? --ignore-case? --invert-match? --line-number? --max-count? --max-depth? --no-exclude-standard? --no-index? --no-recursive? --no-textconv? --only-matching? --quiet? --recurse-submodules? --recursive? --show-function? --text? --textconv? --threads? --untracked? --word-regexp? -I? -e? -h? -z?

Properties

Optional --after-context

--after-context?: string | number

Shows the specified number of trailing lines, and places a line containing -- between contiguous groups of matches. See also --before-context and --context.

Optional --all-match

--all-match?: null

When multiple pattern expressions are combined with or, this flag limits the match to files that have lines to match all of them.

Optional --before-context

--before-context?: string | number

Shows the specified number of leading lines, and places a line containing -- between contiguous groups of matches. See also --after-context and --context.

Optional --break

--break?: null

Prints an empty line between matches from different files.

Optional --cached

--cached?: null

Searches blobs in the index.

Optional --column

--column?: null

Prefixes the 1-indexed byte-offset of the first match from the start of the matching line.

Optional --context

--context?: string | number

Shows the specified number of leading and trailing lines, and places a line containing -- between contiguous groups of matches. See also --after-context and --before-context.

Optional --count

--count?: null

Shows the number of lines that match, instead of showing every matched line.

Optional --exclude-standard

--exclude-standard?: null

Does not pay attention to ignored files specified via the .gitignore mechanism. Only useful with --no-index. See also --no-exclude-standard.

Optional --files-with-matches

--files-with-matches?: null

Shows only the names of files that contain matches. See also --files-without-match.

Optional --files-without-match

--files-without-match?: null

Shows only the names of files that do not contain matches. See also --files-with-matches.

Optional --fixed-strings

--fixed-strings?: null

Doesn’t interpret the pattern as a regex.

Optional --function-context

--function-context?: null

Shows the surrounding text from the previous line containing a function name up to the one before the next function name, effectively showing the whole function in which the match was found.

Optional --heading

--heading?: null

Shows the filename above the matches in that file instead of at the start of each shown line.

Optional --ignore-case

--ignore-case?: null

Ignores case differences between the patterns and the files.

Optional --invert-match

--invert-match?: null

Selects non-matching lines.

Optional --line-number

--line-number?: null

Prefixes the line number to matching lines.

Optional --max-count

--max-count?: string | number

Limits the number of matches per file.

Optional --max-depth

--max-depth?: string | number

Descends at most the specified number of directory levels. A value of -1 means no limit.

Optional --no-exclude-standard

--no-exclude-standard?: null

Searches ignored files by not honoring the .gitignore mechanism. Only useful with --untracked. See also --exclude-standard.

Optional --no-index

--no-index?: null

Searches files in the current directory that is not managed by Git.

Optional --no-recursive

--no-recursive?: null

Same as --max-depth=0. See also --recursive.

Optional --no-textconv

--no-textconv?: null

Does not honor textconv filter settings. See also --textconv.

Optional --only-matching

--only-matching?: null

Prints only the matched (non-empty) parts of a matching line, with each such part on a separate output line.

Optional --quiet

--quiet?: null

Does not output matched lines; instead, exits with status 0 when there is a match and with non-zero status when there isn’t.

Optional --recurse-submodules

--recurse-submodules?: null

Recursively searches in each submodule that is active and checked out in the repository.

Optional --recursive

--recursive?: null

Same as --max-depth=-1; this is the default. See also --no-recursive.

Optional --show-function

--show-function?: null

Shows the preceding line that contains the function name of the match, unless the matching line is a function name itself.

Optional --text

--text?: null

Processes binary files as if they were text.

Optional --textconv

--textconv?: null

Honors textconv filter settings. See also --no-textconv.

Optional --threads

--threads?: string | number

Specifies the number of grep worker threads to use.

Optional --untracked

--untracked?: null

Searches also in untracked files.

Optional --word-regexp

--word-regexp?: null

Matches the pattern only at word boundary.

Optional -I

-I?: null

Doesn’t match the pattern in binary files.

Optional -e

-e?: string | string[]

Specifies the pattern. Multiple patterns are combined by or. See also --all-match.

Optional -h

-h?: null

Suppresses the output of the filename for each match.

Optional -z

-z?: null

Usees \0 as the delimiter for pathnames in the output and prints them verbatim.

Settings

Member Visibility

Theme

On This Page