git-show-ref(1)

1GIT-SHOW-REF(1)                   Git Manual                   GIT-SHOW-REF(1)
2
3
4

NAME

6       git-show-ref - List references in a local repository
7

SYNOPSIS

9       git show-ref [-q|--quiet] [--verify] [--head] [-d|--dereference]
10                    [-s|--hash[=<n>]] [--abbrev[=<n>]] [--tags]
11                    [--heads] [--] [<pattern>...]
12       git show-ref --exclude-existing[=<pattern>] < ref-list
13
14

DESCRIPTION

16       Displays references available in a local repository along with the
17       associated commit IDs. Results can be filtered using a pattern and tags
18       can be dereferenced into object IDs. Additionally, it can be used to
19       test whether a particular ref exists.
20
21       The --exclude-existing form is a filter that does the inverse, it shows
22       the refs from stdin that don’t exist in the local repository.
23
24       Use of this utility is encouraged in favor of directly accessing files
25       under the .git directory.
26

OPTIONS

28       --head
29           Show the HEAD reference.
30
31       --tags, --heads
32           Limit to only "refs/heads" and "refs/tags", respectively. These
33           options are not mutually exclusive; when given both, references
34           stored in "refs/heads" and "refs/tags" are displayed.
35
36       -d, --dereference
37           Dereference tags into object IDs as well. They will be shown with
38           "^{}" appended.
39
40       -s, --hash[=<n>]
41           Only show the SHA-1 hash, not the reference name. When combined
42           with --dereference the dereferenced tag will still be shown after
43           the SHA-1.
44
45       --verify
46           Enable stricter reference checking by requiring an exact ref path.
47           Aside from returning an error code of 1, it will also print an
48           error message if --quiet was not specified.
49
50       --abbrev[=<n>]
51           Abbreviate the object name. When using --hash, you do not have to
52           say --hash --abbrev; --hash=n would do.
53
54       -q, --quiet
55           Do not print any results to stdout. When combined with --verify
56           this can be used to silently check if a reference exists.
57
58       --exclude-existing[=<pattern>]
59           Make git show-ref act as a filter that reads refs from stdin of the
60           form "^(?:<anything>\s)?<refname>(?:\^{})?$" and performs the
61           following actions on each: (1) strip "^{}" at the end of line if
62           any; (2) ignore if pattern is provided and does not head-match
63           refname; (3) warn if refname is not a well-formed refname and skip;
64           (4) ignore if refname is a ref that exists in the local repository;
65           (5) otherwise output the line.
66
67       <pattern>...
68           Show references matching one or more patterns. Patterns are matched
69           from the end of the full name, and only complete parts are matched,
70           e.g.  master matches refs/heads/master, refs/remotes/origin/master,
71           refs/tags/jedi/master but not refs/heads/mymaster nor
72           refs/remotes/master/jedi.
73

OUTPUT

75       The output is in the format: <SHA-1 ID> <space> <reference name>.
76
77           $ git show-ref --head --dereference
78           832e76a9899f560a90ffd62ae2ce83bbeff58f54 HEAD
79           832e76a9899f560a90ffd62ae2ce83bbeff58f54 refs/heads/master
80           832e76a9899f560a90ffd62ae2ce83bbeff58f54 refs/heads/origin
81           3521017556c5de4159da4615a39fa4d5d2c279b5 refs/tags/v0.99.9c
82           6ddc0964034342519a87fe013781abf31c6db6ad refs/tags/v0.99.9c^{}
83           055e4ae3ae6eb344cbabf2a5256a49ea66040131 refs/tags/v1.0rc4
84           423325a2d24638ddcc82ce47be5e40be550f4507 refs/tags/v1.0rc4^{}
85           ...
86
87
88       When using --hash (and not --dereference) the output format is: <SHA-1
89       ID>
90
91           $ git show-ref --heads --hash
92           2e3ba0114a1f52b47df29743d6915d056be13278
93           185008ae97960c8d551adcd9e23565194651b5d1
94           03adf42c988195b50e1a1935ba5fcbc39b2b029b
95           ...
96
97

EXAMPLE

99       To show all references called "master", whether tags or heads or
100       anything else, and regardless of how deep in the reference naming
101       hierarchy they are, use:
102
103                   git show-ref master
104
105
106       This will show "refs/heads/master" but also
107       "refs/remote/other-repo/master", if such references exists.
108
109       When using the --verify flag, the command requires an exact path:
110
111                   git show-ref --verify refs/heads/master
112
113
114       will only match the exact branch called "master".
115
116       If nothing matches, git show-ref will return an error code of 1, and in
117       the case of verification, it will show an error message.
118
119       For scripting, you can ask it to be quiet with the "--quiet" flag,
120       which allows you to do things like
121
122                   git show-ref --quiet --verify -- "refs/heads/$headname" ||
123                           echo "$headname is not a valid branch"
124
125
126       to check whether a particular branch exists or not (notice how we don’t
127       actually want to show any results, and we want to use the full refname
128       for it in order to not trigger the problem with ambiguous partial
129       matches).
130
131       To show only tags, or only proper branch heads, use "--tags" and/or
132       "--heads" respectively (using both means that it shows tags and heads,
133       but not other random references under the refs/ subdirectory).
134
135       To do automatic tag object dereferencing, use the "-d" or
136       "--dereference" flag, so you can do
137
138                   git show-ref --tags --dereference
139
140
141       to get a listing of all tags together with what they dereference.
142

FILES

144       .git/refs/*, .git/packed-refs
145

GIT

150       Part of the git(1) suite
151
152
153
154Git 1.8.3.1                       11/19/2018                   GIT-SHOW-REF(1)