6 git-for-each-ref - Output information on each ref
11 'git for-each-ref' [--count=<count>] [--shell|--perl|--python|--tcl]
12 [(--sort=<key>)...] [--format=<format>] [<pattern>...]
13 [--points-at <object>] [(--merged | --no-merged) [<object>]]
14 [--contains [<object>]]
19 Iterate over all refs that match `<pattern>` and show them
20 according to the given `<format>`, after sorting them according
21 to the given set of `<key>`. If `<count>` is given, stop after
22 showing that many refs. The interpolated values in `<format>`
23 can optionally be quoted as string literals in the specified
24 host language allowing their direct evaluation in that language.
29 By default the command shows all refs that match
30 `<pattern>`. This option makes it stop after showing
34 A field name to sort on. Prefix `-` to sort in
35 descending order of the value. When unspecified,
36 `refname` is used. You may use the --sort=<key> option
37 multiple times, in which case the last key becomes the primary
41 A string that interpolates `%(fieldname)` from the
42 object pointed at by a ref being shown. If `fieldname`
43 is prefixed with an asterisk (`*`) and the ref points
44 at a tag object, the value for the field in the object
45 tag refers is used. When unspecified, defaults to
46 `%(objectname) SPC %(objecttype) TAB %(refname)`.
47 It also interpolates `%%` to `%`, and `%xx` where `xx`
48 are hex digits interpolates to character with hex code
49 `xx`; for example `%00` interpolates to `\0` (NUL),
50 `%09` to `\t` (TAB) and `%0a` to `\n` (LF).
53 If one or more patterns are given, only refs are shown that
54 match against at least one pattern, either using fnmatch(3) or
55 literally, in the latter case matching completely or from the
56 beginning up to a slash.
62 If given, strings that substitute `%(fieldname)`
63 placeholders are quoted as string literals suitable for
64 the specified host language. This is meant to produce
65 a scriptlet that can directly be `eval`ed.
67 --points-at <object>::
68 Only list refs which points at the given object.
71 Only list refs whose tips are reachable from the
72 specified commit (HEAD if not specified),
73 incompatible with `--no-merged`.
75 --no-merged [<object>]::
76 Only list refs whose tips are not reachable from the
77 specified commit (HEAD if not specified),
78 incompatible with `--merged`.
80 --contains [<object>]::
81 Only list refs which contain the specified commit (HEAD if not
85 Sorting and filtering refs are case insensitive.
90 Various values from structured fields in referenced objects can
91 be used to interpolate into the resulting output, or as sort
94 For all objects, the following names can be used:
97 The name of the ref (the part after $GIT_DIR/).
98 For a non-ambiguous short name of the ref append `:short`.
99 The option core.warnAmbiguousRefs is used to select the strict
100 abbreviation mode. If `lstrip=<N>` (`rstrip=<N>`) is appended, strips `<N>`
101 slash-separated path components from the front (back) of the refname
102 (e.g. `%(refname:lstrip=2)` turns `refs/tags/foo` into `foo` and
103 `%(refname:rstrip=2)` turns `refs/tags/foo` into `refs`).
104 If `<N>` is a negative number, strip as many path components as
105 necessary from the specified end to leave `-<N>` path components
106 (e.g. `%(refname:lstrip=-2)` turns
107 `refs/tags/foo` into `tags/foo` and `%(refname:rstrip=-1)`
108 turns `refs/tags/foo` into `refs`). When the ref does not have
109 enough components, the result becomes an empty string if
110 stripping with positive <N>, or it becomes the full refname if
111 stripping with negative <N>. Neither is an error.
113 `strip` can be used as a synomym to `lstrip`.
116 The type of the object (`blob`, `tree`, `commit`, `tag`).
119 The size of the object (the same as 'git cat-file -s' reports).
122 The object name (aka SHA-1).
123 For a non-ambiguous abbreviation of the object name append `:short`.
124 For an abbreviation of the object name with desired length append
125 `:short=<length>`, where the minimum length is MINIMUM_ABBREV. The
126 length may be exceeded to ensure unique object names.
129 The name of a local ref which can be considered ``upstream''
130 from the displayed ref. Respects `:short`, `:lstrip` and
131 `:rstrip` in the same way as `refname` above. Additionally
132 respects `:track` to show "[ahead N, behind M]" and
133 `:trackshort` to show the terse version: ">" (ahead), "<"
134 (behind), "<>" (ahead and behind), or "=" (in sync). `:track`
135 also prints "[gone]" whenever unknown upstream ref is
136 encountered. Append `:track,nobracket` to show tracking
137 information without brackets (i.e "ahead N, behind M"). Has
138 no effect if the ref does not have tracking information
139 associated with it. All the options apart from `nobracket`
140 are mutually exclusive, but if used together the last option
144 The name of a local ref which represents the `@{push}`
145 location for the displayed ref. Respects `:short`, `:lstrip`,
146 `:rstrip`, `:track`, and `:trackshort` options as `upstream`
147 does. Produces an empty string if no `@{push}` ref is
151 '*' if HEAD matches current ref (the checked out branch), ' '
155 Change output color. Followed by `:<colorname>`, where names
156 are described in `color.branch.*`.
159 Left-, middle-, or right-align the content between
160 %(align:...) and %(end). The "align:" is followed by
161 `width=<width>` and `position=<position>` in any order
162 separated by a comma, where the `<position>` is either left,
163 right or middle, default being left and `<width>` is the total
164 length of the content with alignment. For brevity, the
165 "width=" and/or "position=" prefixes may be omitted, and bare
166 <width> and <position> used instead. For instance,
167 `%(align:<width>,<position>)`. If the contents length is more
168 than the width then no alignment is performed. If used with
169 `--quote` everything in between %(align:...) and %(end) is
170 quoted, but if nested then only the topmost level performs
174 Used as %(if)...%(then)...%(end) or
175 %(if)...%(then)...%(else)...%(end). If there is an atom with
176 value or string literal after the %(if) then everything after
177 the %(then) is printed, else if the %(else) atom is used, then
178 everything after %(else) is printed. We ignore space when
179 evaluating the string before %(then), this is useful when we
180 use the %(HEAD) atom which prints either "*" or " " and we
181 want to apply the 'if' condition only on the 'HEAD' ref.
182 Append ":equals=<string>" or ":notequals=<string>" to compare
183 the value between the %(if:...) and %(then) atoms with the
187 The ref which the given symbolic ref refers to. If not a
188 symbolic ref, nothing is printed. Respects the `:short`,
189 `:lstrip` and `:rstrip` options in the same way as `refname`
192 In addition to the above, for commit and tag objects, the header
193 field names (`tree`, `parent`, `object`, `type`, and `tag`) can
194 be used to specify the value in the header field.
196 For commit and tag objects, the special `creatordate` and `creator`
197 fields will correspond to the appropriate date or name-email-date tuple
198 from the `committer` or `tagger` fields depending on the object type.
199 These are intended for working on a mix of annotated and lightweight tags.
201 Fields that have name-email-date tuple as its value (`author`,
202 `committer`, and `tagger`) can be suffixed with `name`, `email`,
203 and `date` to extract the named component.
205 The complete message in a commit and tag object is `contents`.
206 Its first line is `contents:subject`, where subject is the concatenation
207 of all lines of the commit message up to the first blank line. The next
208 line is 'contents:body', where body is all of the lines after the first
209 blank line. The optional GPG signature is `contents:signature`. The
210 first `N` lines of the message is obtained using `contents:lines=N`.
211 Additionally, the trailers as interpreted by linkgit:git-interpret-trailers[1]
212 are obtained as 'contents:trailers'.
214 For sorting purposes, fields with numeric values sort in numeric order
215 (`objectsize`, `authordate`, `committerdate`, `creatordate`, `taggerdate`).
216 All other fields are used to sort in their byte-value order.
218 There is also an option to sort by versions, this can be done by using
219 the fieldname `version:refname` or its alias `v:refname`.
221 In any case, a field name that refers to a field inapplicable to
222 the object referred by the ref does not cause an error. It
223 returns an empty string instead.
225 As a special case for the date-type fields, you may specify a format for
226 the date by adding `:` followed by date format name (see the
227 values the `--date` option to linkgit:git-rev-list[1] takes).
229 Some atoms like %(align) and %(if) always require a matching %(end).
230 We call them "opening atoms" and sometimes denote them as %($open).
232 When a scripting language specific quoting is in effect, everything
233 between a top-level opening atom and its matching %(end) is evaluated
234 according to the semantics of the opening atom and only its result
235 from the top-level is quoted.
241 An example directly producing formatted text. Show the most recent
247 git for-each-ref --count=3 --sort='-*authordate' \
248 --format='From: %(*authorname) %(*authoremail)
258 A simple example showing the use of shell eval on the output,
259 demonstrating the use of --shell. List the prefixes of all heads:
263 git for-each-ref --shell --format="ref=%(refname)" refs/heads | \
272 A bit more elaborate report on tags, demonstrating that the format
273 may be an entire script:
292 # could be a lightweight tag
294 kind="Lightweight tag"
302 echo "$kind $T points at a $t object $o"
303 if test "z$t" = zcommit
305 echo "The commit was authored by $n $e
310 Its message reads as:
312 echo "$b" | sed -e "s/^/ /"
317 eval=`git for-each-ref --shell --format="$fmt" \
318 --sort='*objecttype' \
325 An example to show the usage of %(if)...%(then)...%(else)...%(end).
326 This prefixes the current branch with a star.
329 git for-each-ref --format="%(if)%(HEAD)%(then)* %(else) %(end)%(refname:short)" refs/heads/
333 An example to show the usage of %(if)...%(then)...%(end).
334 This prints the authorname, if present.
337 git for-each-ref --format="%(refname)%(if)%(authorname)%(then) Authored by: %(authorname)%(end)"
342 linkgit:git-show-ref[1]
346 Part of the linkgit:git[1] suite