Text of kernel.org › pub › software › scm › git › docs › git-for-each-ref.html as Styx crawled it on Nov 19, 2026. The page may have changed since. Only its words are kept, without pictures or layout, and only the first part of a long page.

Open the live page

git-for-each-ref(1)

git-for-each-ref(1) Manual Page NAME git-for-each-ref - Output information on each ref SYNOPSIS git for-each-ref [ --count= <count> ] [ --shell | --perl | --python | --tcl ] [( --sort= <key> )…​] [ --format= <format> ] [ --include-root-refs ] [ --points-at= <object> ] [ --merged [ = <object> ]] [ --no-merged [ = <object> ]] [ --contains [ = <object> ]] [ --no-contains [ = <object> ]] [( --exclude= <pattern> )…​] [ --start-after= <marker> ] [ --stdin | ( <pattern> ... )] DESCRIPTION Iterate over all refs that match <pattern> and show them according to the given <format> , after sorting them according to the given set of <key> .

If <count> is given, stop after showing that many refs. The interpolated values in <format> can optionally be quoted as string literals in the specified host language allowing their direct evaluation in that language. OPTIONS <pattern> ... If one or more <pattern> parameters are given, only refs are shown that match against at least one pattern, either using fnmatch (3) or literally, in the latter case matching completely or from the beginning up to a slash. --stdin The list of patterns is read from standard input instead of from the argument list. --count= <count> Stop after showing <count> refs. --sort= <key> Sort on the field name <key> .

Prefix - to sort in descending order of the value. When unspecified, refname is used. You may use the --sort= <key> option multiple times, in which case the last key becomes the primary key. --format [ = <format> ] A string that interpolates % ( fieldname ) from a ref being shown and the object it points at. In addition, the string literal %% renders as % and %xx - where xx are hex digits - renders as the character with hex code xx .

For example, %00 interpolates to \0 ( NUL ), %09 to \t ( TAB ), and %0a to \n ( LF ). When unspecified, <format> defaults to % ( objectname ) SPC % ( objecttype ) TAB % ( refname ). --color [ = <when> ] Respect any colors specified in the --format option. The <when> field must be one of always , never , or auto (if <when> is absent, behave as if always was given). --shell --perl --python --tcl If given, strings that substitute % ( fieldname ) placeholders are quoted as string literals suitable for the specified host language.

This is meant to produce a scriptlet that can directly be "eval"ed. --points-at= <object> Only list refs which points at the given object. --merged [ = <object> ] Only list refs whose tips are reachable from the specified commit ( HEAD if not specified). --no-merged [ = <object> ] Only list refs whose tips are not reachable from <object> ( HEAD if not specified). --contains [ = <object> ] Only list refs which contain <object> ( HEAD if not specified). --no-contains [ = <object> ] Only list refs which don’t contain <object> ( HEAD if not specified). --ignore-case Sorting and filtering refs are case insensitive. --omit-empty Do not print a newline after formatted refs where the format expands to the empty string. --exclude= <excluded-pattern> If one or more --exclude options are given, only refs which do not match any <excluded-pattern> parameters are shown.

Matching is done using the same rules as <pattern> above. --include-root-refs List root refs ( HEAD and pseudorefs) apart from regular refs. --start-after= <marker> Allows paginating the output by skipping references up to and including the specified marker. When paging, it should be noted that references may be deleted, modified or added between invocations. Output will only yield those references which follow the marker lexicographically.

Output begins from the first reference that would come after the marker alphabetically. Cannot be used with --sort= <key> or --stdin options, or the <pattern> argument(s) to limit the refs. FIELD NAMES Various values from structured fields in referenced objects can be used to interpolate into the resulting output, or as sort keys. For all objects, the following names can be used: refname The name of the ref (the part after $GIT_DIR/ ).

For a non-ambiguous short name of the ref append :short . The option core.warnAmbiguousRefs is used to select the strict abbreviation mode. If lstrip= <n> ( rstrip= <n> ) is appended, strip <n> slash-separated path components from the front (back) of the refname (e.g. % ( refname:lstrip=2 ) turns refs/tags/foo into foo and % ( refname:rstrip=2 ) turns refs/tags/foo into refs ). If <n> is a negative number, strip as many path components as necessary from the specified end to leave - <n> path components (e.g. % ( refname:lstrip=-2 ) turns refs/tags/foo into tags/foo and % ( refname:rstrip=-1 ) turns refs/tags/foo into refs ).

When the ref does not have enough components, the result becomes an empty string if stripping with positive <n> , or it becomes the full refname if stripping with negative <N> . Neither is an error. strip can be used as a synonym to lstrip . objecttype The type of the object ( blob , tree , commit , tag ). objectsize The size of the object (the same as git cat-file -s reports). Append :disk to get the size, in bytes, that the object takes up on disk.

See the note about on-disk sizes in the CAVEATS section below. objectname The object name (aka SHA-1). For a non-ambiguous abbreviation of the object name append :short . For an abbreviation of the object name with desired length append :short= <length> , where the minimum length is MINIMUM_ABBREV . The length may be exceeded to ensure unique object names. deltabase This expands to the object name of the delta base for the given object, if it is stored as a delta.

Otherwise it expands to the null object name (all zeroes). upstream The name of a local ref which can be considered “upstream” from the displayed ref. Respects :short , :lstrip and :rstrip in the same way as refname above. Additionally respects :track to show "[ahead N, behind M]" and :trackshort to show the terse version: ">" (ahead), "<" (behind), "<>" (ahead and behind), or "=" (in sync). :track also prints "[gone]" whenever unknown upstream ref is encountered.

Append :track,nobracket to show tracking information without brackets (i.e "ahead N, behind M"). For any remote-tracking branch % ( upstream ), % ( upstream:remotename ) and % ( upstream:remoteref ) refer to the name of the remote and the name of the tracked remote ref, respectively. In other words, the remote-tracking branch can be updated explicitly and individually by using the refspec % ( upstream:remoteref ) :% ( upstream ) to fetch from % ( upstream:remotename ).

Has no effect if the ref does not have tracking information associated with it. All the options apart from nobracket are mutually exclusive, but if used together the last option is selected. push The name of a local ref which represents the @ {push} location for the displayed ref. Respects :short , :lstrip , :rstrip , :track , :trackshort , :remotename , and :remoteref options as upstream does. Produces an empty string if no @ {push} ref is configured.

HEAD * if HEAD matches current ref (the checked out branch), ' ' otherwise. color Change output color. Followed by : <colorname> , where color names are described under Values in the "CONFIGURATION FILE" section of git-config(1) . For example, % ( color:bold red ). align Left-, middle-, or right-align the content between % ( align: ... ) and % ( end ). The " align: " is followed by width= <width> and position= <position> in any order separated by a comma, where the <position> is either left , right or middle , default being left and <width> is the total length of the content with alignment.

For brevity, the "width=" and/or "position=" prefixes may be omitted, and bare <width> and <position> used instead. For instance, % ( align: <width> , <position> ). If the contents length is more than the width then no alignment is performed. If used with --quote everything in between % ( align: ... ) and % ( end ) is quoted, but if nested then only the topmost level performs quoting. if Used as % ( if ) ... % ( then )

The rest of this page is on the live site.