| blob | e131cffcc7fa82a70790fba3c72bfebfbe35da0c |
1 '\" t
2 .\" Title: git-ls-remote
3 .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
4 .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
5 .\" Date: 2024-06-20
6 .\" Manual: Git Manual
7 .\" Source: Git 2.45.2.606.g9005149a4a
8 .\" Language: English
9 .\"
10 .TH "GIT\-LS\-REMOTE" "1" "2024\-06\-20" "Git 2\&.45\&.2\&.606\&.g900514" "Git Manual"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18 .ie \n(.g .ds Aq \(aq
19 .el .ds Aq '
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
24 .nh
25 .\" disable justification (adjust text to left margin only)
26 .ad l
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
30 .SH "NAME"
31 git-ls-remote \- List references in a remote repository
32 .SH "SYNOPSIS"
33 .sp
34 .nf
35 \fIgit ls\-remote\fR [\-\-branches] [\-\-tags] [\-\-refs] [\-\-upload\-pack=<exec>]
36 [\-q | \-\-quiet] [\-\-exit\-code] [\-\-get\-url] [\-\-sort=<key>]
37 [\-\-symref] [<repository> [<patterns>\&...]]
38 .fi
39 .sp
40 .SH "DESCRIPTION"
41 .sp
42 Displays references available in a remote repository along with the associated commit IDs\&.
43 .SH "OPTIONS"
44 .PP
45 \-b, \-\-branches, \-t, \-\-tags
46 .RS 4
47 Limit to only local branches and local tags, respectively\&. These options are
48 \fInot\fR
49 mutually exclusive; when given both, references stored in refs/heads and refs/tags are displayed\&. Note that
50 \fB\-\-heads\fR
51 and
52 \fB\-h\fR
53 are deprecated synonyms for
54 \fB\-\-branches\fR
55 and
56 \fB\-b\fR
57 and may be removed in the future\&. Also note that
58 \fBgit ls\-remote \-h\fR
59 used without anything else on the command line gives help, consistent with other git subcommands\&.
60 .RE
61 .PP
62 \-\-refs
63 .RS 4
64 Do not show peeled tags or pseudorefs like
65 \fBHEAD\fR
66 in the output\&.
67 .RE
68 .PP
69 \-q, \-\-quiet
70 .RS 4
71 Do not print remote URL to stderr\&.
72 .RE
73 .PP
74 \-\-upload\-pack=<exec>
75 .RS 4
76 Specify the full path of
77 \fIgit\-upload\-pack\fR
78 on the remote host\&. This allows listing references from repositories accessed via SSH and where the SSH daemon does not use the PATH configured by the user\&.
79 .RE
80 .PP
81 \-\-exit\-code
82 .RS 4
83 Exit with status "2" when no matching refs are found in the remote repository\&. Usually the command exits with status "0" to indicate it successfully talked with the remote repository, whether it found any matching refs\&.
84 .RE
85 .PP
86 \-\-get\-url
87 .RS 4
88 Expand the URL of the given remote repository taking into account any "url\&.<base>\&.insteadOf" config setting (See
89 \fBgit-config\fR(1)) and exit without talking to the remote\&.
90 .RE
91 .PP
92 \-\-symref
93 .RS 4
94 In addition to the object pointed by it, show the underlying ref pointed by it when showing a symbolic ref\&. Currently, upload\-pack only shows the symref HEAD, so it will be the only one shown by ls\-remote\&.
95 .RE
96 .PP
97 \-\-sort=<key>
98 .RS 4
99 Sort based on the key given\&. Prefix
100 \fB\-\fR
101 to sort in descending order of the value\&. Supports "version:refname" or "v:refname" (tag names are treated as versions)\&. The "version:refname" sort order can also be affected by the "versionsort\&.suffix" configuration variable\&. See
102 \fBgit-for-each-ref\fR(1)
103 for more sort options, but be aware keys like
104 \fBcommitterdate\fR
105 that require access to the objects themselves will not work for refs whose objects have not yet been fetched from the remote, and will give a
106 \fBmissing object\fR
107 error\&.
108 .RE
109 .PP
110 \-o <option>, \-\-server\-option=<option>
111 .RS 4
112 Transmit the given string to the server when communicating using protocol version 2\&. The given string must not contain a NUL or LF character\&. When multiple
113 \fB\-\-server\-option=<option>\fR
114 are given, they are all sent to the other side in the order listed on the command line\&.
115 .RE
116 .PP
117 <repository>
118 .RS 4
119 The "remote" repository to query\&. This parameter can be either a URL or the name of a remote (see the GIT URLS and REMOTES sections of
120 \fBgit-fetch\fR(1))\&.
121 .RE
122 .PP
123 <patterns>\&...
124 .RS 4
125 When unspecified, all references, after filtering done with \-\-heads and \-\-tags, are shown\&. When <patterns>\&... are specified, only references matching one or more of the given patterns are displayed\&. Each pattern is interpreted as a glob (see
126 \fBglob\fR
127 in
128 \fBgitglossary\fR(7)) which is matched against the "tail" of a ref, starting either from the start of the ref (so a full name like
129 \fBrefs/heads/foo\fR
130 matches) or from a slash separator (so
131 \fBbar\fR
132 matches
133 \fBrefs/heads/bar\fR
134 but not
135 \fBrefs/heads/foobar\fR)\&.
136 .RE
137 .SH "OUTPUT"
138 .sp
139 The output is in the format:
140 .sp
141 .if n \{\
142 .RS 4
143 .\}
144 .nf
145 <oid> TAB <ref> LF
146 .fi
147 .if n \{\
148 .RE
149 .\}
150 .sp
151 .sp
152 When showing an annotated tag, unless \fB\-\-refs\fR is given, two such lines are shown: one with the refname for the tag itself as \fB<ref>\fR, and another with \fB<ref>\fR followed by \fB^{}\fR\&. The \fB<oid>\fR on the latter line shows the name of the object the tag points at\&.
153 .SH "EXAMPLES"
154 .sp
155 .RS 4
156 .ie n \{\
157 \h'-04'\(bu\h'+03'\c
158 .\}
159 .el \{\
160 .sp -1
161 .IP \(bu 2.3
162 .\}
163 List all references (including symbolics and pseudorefs), peeling tags:
164 .sp
165 .if n \{\
166 .RS 4
167 .\}
168 .nf
169 $ git ls\-remote
170 27d43aaaf50ef0ae014b88bba294f93658016a2e HEAD
171 950264636c68591989456e3ba0a5442f93152c1a refs/heads/main
172 d9ab777d41f92a8c1684c91cfb02053d7dd1046b refs/heads/next
173 d4ca2e3147b409459955613c152220f4db848ee1 refs/tags/v2\&.40\&.0
174 73876f4861cd3d187a4682290ab75c9dccadbc56 refs/tags/v2\&.40\&.0^{}
175 .fi
176 .if n \{\
177 .RE
178 .\}
179 .sp
180 .RE
181 .sp
182 .RS 4
183 .ie n \{\
184 \h'-04'\(bu\h'+03'\c
185 .\}
186 .el \{\
187 .sp -1
188 .IP \(bu 2.3
189 .\}
190 List all references matching given patterns:
191 .sp
192 .if n \{\
193 .RS 4
194 .\}
195 .nf
196 $ git ls\-remote http://www\&.kernel\&.org/pub/scm/git/git\&.git master seen rc
197 5fe978a5381f1fbad26a80e682ddd2a401966740 refs/heads/master
198 c781a84b5204fb294c9ccc79f8b3baceeb32c061 refs/heads/seen
199 .fi
200 .if n \{\
201 .RE
202 .\}
203 .sp
204 .RE
205 .sp
206 .RS 4
207 .ie n \{\
208 \h'-04'\(bu\h'+03'\c
209 .\}
210 .el \{\
211 .sp -1
212 .IP \(bu 2.3
213 .\}
214 List only tags matching a given wildcard pattern:
215 .sp
216 .if n \{\
217 .RS 4
218 .\}
219 .nf
220 $ git ls\-remote \-\-tags http://www\&.kernel\&.org/pub/scm/git/git\&.git v\e*
221 485a869c64a68cc5795dd99689797c5900f4716d refs/tags/v2\&.39\&.2
222 cbf04937d5b9fcf0a76c28f69e6294e9e3ecd7e6 refs/tags/v2\&.39\&.2^{}
223 d4ca2e3147b409459955613c152220f4db848ee1 refs/tags/v2\&.40\&.0
224 73876f4861cd3d187a4682290ab75c9dccadbc56 refs/tags/v2\&.40\&.0^{}
225 .fi
226 .if n \{\
227 .RE
228 .\}
229 .sp
230 .RE
231 .SH "SEE ALSO"
232 .sp
233 \fBgit-check-ref-format\fR(1)\&.
234 .SH "GIT"
235 .sp
236 Part of the \fBgit\fR(1) suite