1GIT-SHOW-REF(1) Git Manual GIT-SHOW-REF(1)
2
3
4
6 git-show-ref - List references in a local repository
7
9 git-show-ref [-q|--quiet] [--verify] [-h|--head] [-d|--dereference]
10 [-s|--hash] [--abbrev] [--tags] [--heads] [--] <pattern>...
11 git-show-ref --exclude-existing[=pattern]
12
14 Displays references available in a local repository along with the
15 associated commit IDs. Results can be filtered using a pattern and tags
16 can be dereferenced into object IDs. Additionally, it can be used to
17 test whether a particular ref exists.
18
19 The --exclude-existing form is a filter that does the inverse, it shows
20 the refs from stdin that don´t exist in the local repository.
21
22 Use of this utility is encouraged in favor of directly accessing files
23 under in the .git directory.
24
26 -h, --head
27 Show the HEAD reference.
28
29 --tags, --heads
30 Limit to only "refs/heads" and "refs/tags", respectively. These
31 options are not mutually exclusive; when given both, references
32 stored in "refs/heads" and "refs/tags" are displayed.
33
34 -d, --dereference
35 Dereference tags into object IDs as well. They will be shown with
36 "^{}" appended.
37
38 -s, --hash
39 Only show the SHA1 hash, not the reference name. When also using
40 --dereference the dereferenced tag will still be shown after the
41 SHA1.
42
43 --verify
44 Enable stricter reference checking by requiring an exact ref path.
45 Aside from returning an error code of 1, it will also print an
46 error message if --quiet was not specified.
47
48 --abbrev, --abbrev=len
49 Abbreviate the object name. When using --hash, you do not have to
50 say --hash --abbrev; --hash=len would do.
51
52 -q, --quiet
53 Do not print any results to stdout. When combined with --verify
54 this can be used to silently check if a reference exists.
55
56 --exclude-existing, --exclude-existing=pattern
57 Make git-show-ref act as a filter that reads refs from stdin of the
58 form "(?:<anything>\s)?<refname>(?:\{})?$" and performs the
59 following actions on each: (1) strip "^{}" at the end of line if
60 any; (2) ignore if pattern is provided and does not head-match
61 refname; (3) warn if refname is not a well-formed refname and skip;
62 (4) ignore if refname is a ref that exists in the local repository;
63 (5) otherwise output the line.
64
65 <pattern>
66 Show references matching one or more patterns.
67
69 The output is in the format: <SHA-1 ID> <space> <reference name>.
70
71
72
73 $ git show-ref --head --dereference
74 832e76a9899f560a90ffd62ae2ce83bbeff58f54 HEAD
75 832e76a9899f560a90ffd62ae2ce83bbeff58f54 refs/heads/master
76 832e76a9899f560a90ffd62ae2ce83bbeff58f54 refs/heads/origin
77 3521017556c5de4159da4615a39fa4d5d2c279b5 refs/tags/v0.99.9c
78 6ddc0964034342519a87fe013781abf31c6db6ad refs/tags/v0.99.9c^{}
79 055e4ae3ae6eb344cbabf2a5256a49ea66040131 refs/tags/v1.0rc4
80 423325a2d24638ddcc82ce47be5e40be550f4507 refs/tags/v1.0rc4^{}
81
82 When using --hash (and not --dereference) the output format is: <SHA-1
83 ID>
84
85
86
87 $ git show-ref --heads --hash
88 2e3ba0114a1f52b47df29743d6915d056be13278
89 185008ae97960c8d551adcd9e23565194651b5d1
90 03adf42c988195b50e1a1935ba5fcbc39b2b029b
91
92
94 To show all references called "master", whether tags or heads or
95 anything else, and regardless of how deep in the reference naming
96 hierarchy they are, use:
97
98
99
100 git show-ref master
101
102 This will show "refs/heads/master" but also
103 "refs/remote/other-repo/master", if such references exists.
104
105 When using the --verify flag, the command requires an exact path:
106
107
108
109 git show-ref --verify refs/heads/master
110
111 will only match the exact branch called "master".
112
113 If nothing matches, git-show-ref(1) will return an error code of 1, and
114 in the case of verification, it will show an error message.
115
116 For scripting, you can ask it to be quiet with the "--quiet" flag,
117 which allows you to do things like
118
119
120
121 git-show-ref --quiet --verify -- "refs/heads/$headname" ||
122 echo "$headname is not a valid branch"
123
124 to check whether a particular branch exists or not (notice how we don´t
125 actually want to show any results, and we want to use the full refname
126 for it in order to not trigger the problem with ambiguous partial
127 matches).
128
129 To show only tags, or only proper branch heads, use "--tags" and/or
130 "--heads" respectively (using both means that it shows tags and heads,
131 but not other random references under the refs/ subdirectory).
132
133 To do automatic tag object dereferencing, use the "-d" or
134 "--dereference" flag, so you can do
135
136
137
138 git show-ref --tags --dereference
139
140 to get a listing of all tags together with what they dereference.
141
143 git-ls-remote(1), git-peek-remote(1)
144
146 Written by Linus Torvalds <torvalds@osdl.org>. Man page by Jonas
147 Fonseca <fonseca@diku.dk>.
148
150 Part of the git(7) suite
151
152
153
154
155Git 1.5.3.3 10/09/2007 GIT-SHOW-REF(1)