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).
74 --no-merged [<object>]::
75 Only list refs whose tips are not reachable from the
76 specified commit (HEAD if not specified).
78 --contains [<object>]::
79 Only list refs which contain the specified commit (HEAD if not
83 Sorting and filtering refs are case insensitive.
88 Various values from structured fields in referenced objects can
89 be used to interpolate into the resulting output, or as sort
92 For all objects, the following names can be used:
95 The name of the ref (the part after $GIT_DIR/).
96 For a non-ambiguous short name of the ref append `:short`.
97 The option core.warnAmbiguousRefs is used to select the strict
98 abbreviation mode. If `lstrip=<N>` (`rstrip=<N>`) is appended, strips `<N>`
99 slash-separated path components from the front (back) of the refname
100 (e.g. `%(refname:lstrip=2)` turns `refs/tags/foo` into `foo` and
101 `%(refname:rstrip=2)` turns `refs/tags/foo` into `refs`).
102 If `<N>` is a negative number, strip as many path components as
103 necessary from the specified end to leave `-<N>` path components
104 (e.g. `%(refname:lstrip=-2)` turns
105 `refs/tags/foo` into `tags/foo` and `%(refname:rstrip=-1)`
106 turns `refs/tags/foo` into `refs`). When the ref does not have
107 enough components, the result becomes an empty string if
108 stripping with positive <N>, or it becomes the full refname if
109 stripping with negative <N>. Neither is an error.
112 The type of the object (`blob`, `tree`, `commit`, `tag`).
115 The size of the object (the same as 'git cat-file -s' reports).
118 The object name (aka SHA-1).
119 For a non-ambiguous abbreviation of the object name append `:short`.
120 For an abbreviation of the object name with desired length append
121 `:short=<length>`, where the minimum length is MINIMUM_ABBREV. The
122 length may be exceeded to ensure unique object names.
125 The name of a local ref which can be considered ``upstream''
126 from the displayed ref. Respects `:short`, `:lstrip` and
127 `:rstrip` in the same way as `refname` above. Additionally
128 respects `:track` to show "[ahead N, behind M]" and
129 `:trackshort` to show the terse version: ">" (ahead), "<"
130 (behind), "<>" (ahead and behind), or "=" (in sync). `:track`
131 also prints "[gone]" whenever unknown upstream ref is
132 encountered. Append `:track,nobracket` to show tracking
133 information without brackets (i.e "ahead N, behind M"). Has
134 no effect if the ref does not have tracking information
135 associated with it. All the options apart from `nobracket`
136 are mutually exclusive, but if used together the last option
140 The name of a local ref which represents the `@{push}`
141 location for the displayed ref. Respects `:short`, `:lstrip`,
142 `:rstrip`, `:track`, and `:trackshort` options as `upstream`
143 does. Produces an empty string if no `@{push}` ref is
147 '*' if HEAD matches current ref (the checked out branch), ' '
151 Change output color. Followed by `:<colorname>`, where names
152 are described in `color.branch.*`.
155 Left-, middle-, or right-align the content between
156 %(align:...) and %(end). The "align:" is followed by
157 `width=<width>` and `position=<position>` in any order
158 separated by a comma, where the `<position>` is either left,
159 right or middle, default being left and `<width>` is the total
160 length of the content with alignment. For brevity, the
161 "width=" and/or "position=" prefixes may be omitted, and bare
162 <width> and <position> used instead. For instance,
163 `%(align:<width>,<position>)`. If the contents length is more
164 than the width then no alignment is performed. If used with
165 `--quote` everything in between %(align:...) and %(end) is
166 quoted, but if nested then only the topmost level performs
170 Used as %(if)...%(then)...%(end) or
171 %(if)...%(then)...%(else)...%(end). If there is an atom with
172 value or string literal after the %(if) then everything after
173 the %(then) is printed, else if the %(else) atom is used, then
174 everything after %(else) is printed. We ignore space when
175 evaluating the string before %(then), this is useful when we
176 use the %(HEAD) atom which prints either "*" or " " and we
177 want to apply the 'if' condition only on the 'HEAD' ref.
178 Append ":equals=<string>" or ":notequals=<string>" to compare
179 the value between the %(if:...) and %(then) atoms with the
183 The ref which the given symbolic ref refers to. If not a
184 symbolic ref, nothing is printed. Respects the `:short`,
185 `:lstrip` and `:rstrip` options in the same way as `refname`
188 In addition to the above, for commit and tag objects, the header
189 field names (`tree`, `parent`, `object`, `type`, and `tag`) can
190 be used to specify the value in the header field.
192 For commit and tag objects, the special `creatordate` and `creator`
193 fields will correspond to the appropriate date or name-email-date tuple
194 from the `committer` or `tagger` fields depending on the object type.
195 These are intended for working on a mix of annotated and lightweight tags.
197 Fields that have name-email-date tuple as its value (`author`,
198 `committer`, and `tagger`) can be suffixed with `name`, `email`,
199 and `date` to extract the named component.
201 The complete message in a commit and tag object is `contents`.
202 Its first line is `contents:subject`, where subject is the concatenation
203 of all lines of the commit message up to the first blank line. The next
204 line is 'contents:body', where body is all of the lines after the first
205 blank line. The optional GPG signature is `contents:signature`. The
206 first `N` lines of the message is obtained using `contents:lines=N`.
207 Additionally, the trailers as interpreted by linkgit:git-interpret-trailers[1]
208 are obtained as 'contents:trailers'.
210 For sorting purposes, fields with numeric values sort in numeric order
211 (`objectsize`, `authordate`, `committerdate`, `creatordate`, `taggerdate`).
212 All other fields are used to sort in their byte-value order.
214 There is also an option to sort by versions, this can be done by using
215 the fieldname `version:refname` or its alias `v:refname`.
217 In any case, a field name that refers to a field inapplicable to
218 the object referred by the ref does not cause an error. It
219 returns an empty string instead.
221 As a special case for the date-type fields, you may specify a format for
222 the date by adding `:` followed by date format name (see the
223 values the `--date` option to linkgit:git-rev-list[1] takes).
225 Some atoms like %(align) and %(if) always require a matching %(end).
226 We call them "opening atoms" and sometimes denote them as %($open).
228 When a scripting language specific quoting is in effect, everything
229 between a top-level opening atom and its matching %(end) is evaluated
230 according to the semantics of the opening atom and only its result
231 from the top-level is quoted.
237 An example directly producing formatted text. Show the most recent
243 git for-each-ref --count=3 --sort='-*authordate' \
244 --format='From: %(*authorname) %(*authoremail)
254 A simple example showing the use of shell eval on the output,
255 demonstrating the use of --shell. List the prefixes of all heads:
259 git for-each-ref --shell --format="ref=%(refname)" refs/heads | \
268 A bit more elaborate report on tags, demonstrating that the format
269 may be an entire script:
288 # could be a lightweight tag
290 kind="Lightweight tag"
298 echo "$kind $T points at a $t object $o"
299 if test "z$t" = zcommit
301 echo "The commit was authored by $n $e
306 Its message reads as:
308 echo "$b" | sed -e "s/^/ /"
313 eval=`git for-each-ref --shell --format="$fmt" \
314 --sort='*objecttype' \
321 An example to show the usage of %(if)...%(then)...%(else)...%(end).
322 This prefixes the current branch with a star.
325 git for-each-ref --format="%(if)%(HEAD)%(then)* %(else) %(end)%(refname:short)" refs/heads/
329 An example to show the usage of %(if)...%(then)...%(end).
330 This prints the authorname, if present.
333 git for-each-ref --format="%(refname)%(if)%(authorname)%(then) Authored by: %(authorname)%(end)"
338 linkgit:git-show-ref[1]
342 Part of the linkgit:git[1] suite