1GIT-GREP(1)                       Git Manual                       GIT-GREP(1)
2
3
4

NAME

6       git-grep - Print lines matching a pattern
7

SYNOPSIS

9       git grep [-a | --text] [-I] [--textconv] [-i | --ignore-case] [-w | --word-regexp]
10                  [-v | --invert-match] [-h|-H] [--full-name]
11                  [-E | --extended-regexp] [-G | --basic-regexp]
12                  [-P | --perl-regexp]
13                  [-F | --fixed-strings] [-n | --line-number] [--column]
14                  [-l | --files-with-matches] [-L | --files-without-match]
15                  [(-O | --open-files-in-pager) [<pager>]]
16                  [-z | --null]
17                  [ -o | --only-matching ] [-c | --count] [--all-match] [-q | --quiet]
18                  [--max-depth <depth>] [--[no-]recursive]
19                  [--color[=<when>] | --no-color]
20                  [--break] [--heading] [-p | --show-function]
21                  [-A <post-context>] [-B <pre-context>] [-C <context>]
22                  [-W | --function-context]
23                  [--threads <num>]
24                  [-f <file>] [-e] <pattern>
25                  [--and|--or|--not|(|)|-e <pattern>...]
26                  [--recurse-submodules] [--parent-basename <basename>]
27                  [ [--[no-]exclude-standard] [--cached | --no-index | --untracked] | <tree>...]
28                  [--] [<pathspec>...]
29

DESCRIPTION

31       Look for specified patterns in the tracked files in the work tree,
32       blobs registered in the index file, or blobs in given tree objects.
33       Patterns are lists of one or more search expressions separated by
34       newline characters. An empty string as search expression matches all
35       lines.
36

CONFIGURATION

38       grep.lineNumber
39           If set to true, enable -n option by default.
40
41       grep.column
42           If set to true, enable the --column option by default.
43
44       grep.patternType
45           Set the default matching behavior. Using a value of basic,
46           extended, fixed, or perl will enable the --basic-regexp,
47           --extended-regexp, --fixed-strings, or --perl-regexp option
48           accordingly, while the value default will return to the default
49           matching behavior.
50
51       grep.extendedRegexp
52           If set to true, enable --extended-regexp option by default. This
53           option is ignored when the grep.patternType option is set to a
54           value other than default.
55
56       grep.threads
57           Number of grep worker threads to use. If unset (or set to 0), Git
58           will use as many threads as the number of logical cores available.
59
60       grep.fullName
61           If set to true, enable --full-name option by default.
62
63       grep.fallbackToNoIndex
64           If set to true, fall back to git grep --no-index if git grep is
65           executed outside of a git repository. Defaults to false.
66

OPTIONS

68       --cached
69           Instead of searching tracked files in the working tree, search
70           blobs registered in the index file.
71
72       --no-index
73           Search files in the current directory that is not managed by Git.
74
75       --untracked
76           In addition to searching in the tracked files in the working tree,
77           search also in untracked files.
78
79       --no-exclude-standard
80           Also search in ignored files by not honoring the .gitignore
81           mechanism. Only useful with --untracked.
82
83       --exclude-standard
84           Do not pay attention to ignored files specified via the .gitignore
85           mechanism. Only useful when searching files in the current
86           directory with --no-index.
87
88       --recurse-submodules
89           Recursively search in each submodule that has been initialized and
90           checked out in the repository. When used in combination with the
91           <tree> option the prefix of all submodule output will be the name
92           of the parent project’s <tree> object. This option has no effect if
93           --no-index is given.
94
95       -a, --text
96           Process binary files as if they were text.
97
98       --textconv
99           Honor textconv filter settings.
100
101       --no-textconv
102           Do not honor textconv filter settings. This is the default.
103
104       -i, --ignore-case
105           Ignore case differences between the patterns and the files.
106
107       -I
108           Don’t match the pattern in binary files.
109
110       --max-depth <depth>
111           For each <pathspec> given on command line, descend at most <depth>
112           levels of directories. A value of -1 means no limit. This option is
113           ignored if <pathspec> contains active wildcards. In other words if
114           "a*" matches a directory named "a*", "*" is matched literally so
115           --max-depth is still effective.
116
117       -r, --recursive
118           Same as --max-depth=-1; this is the default.
119
120       --no-recursive
121           Same as --max-depth=0.
122
123       -w, --word-regexp
124           Match the pattern only at word boundary (either begin at the
125           beginning of a line, or preceded by a non-word character; end at
126           the end of a line or followed by a non-word character).
127
128       -v, --invert-match
129           Select non-matching lines.
130
131       -h, -H
132           By default, the command shows the filename for each match.  -h
133           option is used to suppress this output.  -H is there for
134           completeness and does not do anything except it overrides -h given
135           earlier on the command line.
136
137       --full-name
138           When run from a subdirectory, the command usually outputs paths
139           relative to the current directory. This option forces paths to be
140           output relative to the project top directory.
141
142       -E, --extended-regexp, -G, --basic-regexp
143           Use POSIX extended/basic regexp for patterns. Default is to use
144           basic regexp.
145
146       -P, --perl-regexp
147           Use Perl-compatible regular expressions for patterns.
148
149           Support for these types of regular expressions is an optional
150           compile-time dependency. If Git wasn’t compiled with support for
151           them providing this option will cause it to die.
152
153       -F, --fixed-strings
154           Use fixed strings for patterns (don’t interpret pattern as a
155           regex).
156
157       -n, --line-number
158           Prefix the line number to matching lines.
159
160       --column
161           Prefix the 1-indexed byte-offset of the first match from the start
162           of the matching line.
163
164       -l, --files-with-matches, --name-only, -L, --files-without-match
165           Instead of showing every matched line, show only the names of files
166           that contain (or do not contain) matches. For better compatibility
167           with git diff, --name-only is a synonym for --files-with-matches.
168
169       -O[<pager>], --open-files-in-pager[=<pager>]
170           Open the matching files in the pager (not the output of grep). If
171           the pager happens to be "less" or "vi", and the user specified only
172           one pattern, the first file is positioned at the first match
173           automatically. The pager argument is optional; if specified, it
174           must be stuck to the option without a space. If pager is
175           unspecified, the default pager will be used (see core.pager in git-
176           config(1)).
177
178       -z, --null
179           Output \0 instead of the character that normally follows a file
180           name.
181
182       -o, --only-matching
183           Print only the matched (non-empty) parts of a matching line, with
184           each such part on a separate output line.
185
186       -c, --count
187           Instead of showing every matched line, show the number of lines
188           that match.
189
190       --color[=<when>]
191           Show colored matches. The value must be always (the default),
192           never, or auto.
193
194       --no-color
195           Turn off match highlighting, even when the configuration file gives
196           the default to color output. Same as --color=never.
197
198       --break
199           Print an empty line between matches from different files.
200
201       --heading
202           Show the filename above the matches in that file instead of at the
203           start of each shown line.
204
205       -p, --show-function
206           Show the preceding line that contains the function name of the
207           match, unless the matching line is a function name itself. The name
208           is determined in the same way as git diff works out patch hunk
209           headers (see Defining a custom hunk-header in gitattributes(5)).
210
211       -<num>, -C <num>, --context <num>
212           Show <num> leading and trailing lines, and place a line containing
213           -- between contiguous groups of matches.
214
215       -A <num>, --after-context <num>
216           Show <num> trailing lines, and place a line containing -- between
217           contiguous groups of matches.
218
219       -B <num>, --before-context <num>
220           Show <num> leading lines, and place a line containing -- between
221           contiguous groups of matches.
222
223       -W, --function-context
224           Show the surrounding text from the previous line containing a
225           function name up to the one before the next function name,
226           effectively showing the whole function in which the match was
227           found.
228
229       --threads <num>
230           Number of grep worker threads to use. See grep.threads in
231           CONFIGURATION for more information.
232
233       -f <file>
234           Read patterns from <file>, one per line.
235
236           Passing the pattern via <file> allows for providing a search
237           pattern containing a \0.
238
239           Not all pattern types support patterns containing \0. Git will
240           error out if a given pattern type can’t support such a pattern. The
241           --perl-regexp pattern type when compiled against the PCRE v2
242           backend has the widest support for these types of patterns.
243
244           In versions of Git before 2.23.0 patterns containing \0 would be
245           silently considered fixed. This was never documented, there were
246           also odd and undocumented interactions between e.g. non-ASCII
247           patterns containing \0 and --ignore-case.
248
249           In future versions we may learn to support patterns containing \0
250           for more search backends, until then we’ll die when the pattern
251           type in question doesn’t support them.
252
253       -e
254           The next parameter is the pattern. This option has to be used for
255           patterns starting with - and should be used in scripts passing user
256           input to grep. Multiple patterns are combined by or.
257
258       --and, --or, --not, ( ... )
259           Specify how multiple patterns are combined using Boolean
260           expressions.  --or is the default operator.  --and has higher
261           precedence than --or.  -e has to be used for all patterns.
262
263       --all-match
264           When giving multiple pattern expressions combined with --or, this
265           flag is specified to limit the match to files that have lines to
266           match all of them.
267
268       -q, --quiet
269           Do not output matched lines; instead, exit with status 0 when there
270           is a match and with non-zero status when there isn’t.
271
272       <tree>...
273           Instead of searching tracked files in the working tree, search
274           blobs in the given trees.
275
276       --
277           Signals the end of options; the rest of the parameters are
278           <pathspec> limiters.
279
280       <pathspec>...
281           If given, limit the search to paths matching at least one pattern.
282           Both leading paths match and glob(7) patterns are supported.
283
284           For more details about the <pathspec> syntax, see the pathspec
285           entry in gitglossary(7).
286

EXAMPLES

288       git grep 'time_t' -- '*.[ch]'
289           Looks for time_t in all tracked .c and .h files in the working
290           directory and its subdirectories.
291
292       git grep -e '#define' --and \( -e MAX_PATH -e PATH_MAX \)
293           Looks for a line that has #define and either MAX_PATH or PATH_MAX.
294
295       git grep --all-match -e NODE -e Unexpected
296           Looks for a line that has NODE or Unexpected in files that have
297           lines that match both.
298
299       git grep solution -- :^Documentation
300           Looks for solution, excluding files in Documentation.
301

NOTES ON THREADS

303       The --threads option (and the grep.threads configuration) will be
304       ignored when --open-files-in-pager is used, forcing a single-threaded
305       execution.
306
307       When grepping the object store (with --cached or giving tree objects),
308       running with multiple threads might perform slower than single threaded
309       if --textconv is given and there’re too many text conversions. So if
310       you experience low performance in this case, it might be desirable to
311       use --threads=1.
312

GIT

314       Part of the git(1) suite
315
316
317
318Git 2.26.2                        2020-04-20                       GIT-GREP(1)
Impressum