| blob | 8f20b333f6b66155527962f4db389e8607fc0af6 |
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: 10/07/2022
6 .\" Manual: Git Manual
7 .\" Source: Git 2.38.0.15.gbbe21b64a0
8 .\" Language: English
9 .\"
10 .TH "GIT\-LS\-REMOTE" "1" "10/07/2022" "Git 2\&.38\&.0\&.15\&.gbbe21b6" "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 [\-\-heads] [\-\-tags] [\-\-refs] [\-\-upload\-pack=<exec>]
36 [\-q | \-\-quiet] [\-\-exit\-code] [\-\-get\-url] [\-\-sort=<key>]
37 [\-\-symref] [<repository> [<refs>\&...]]
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 \-h, \-\-heads, \-t, \-\-tags
46 .RS 4
47 Limit to only refs/heads and refs/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 \fBgit ls\-remote \-h\fR
51 used without anything else on the command line gives help, consistent with other git subcommands\&.
52 .RE
53 .PP
54 \-\-refs
55 .RS 4
56 Do not show peeled tags or pseudorefs like
57 \fBHEAD\fR
58 in the output\&.
59 .RE
60 .PP
61 \-q, \-\-quiet
62 .RS 4
63 Do not print remote URL to stderr\&.
64 .RE
65 .PP
66 \-\-upload\-pack=<exec>
67 .RS 4
68 Specify the full path of
69 \fIgit\-upload\-pack\fR
70 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\&.
71 .RE
72 .PP
73 \-\-exit\-code
74 .RS 4
75 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\&.
76 .RE
77 .PP
78 \-\-get\-url
79 .RS 4
80 Expand the URL of the given remote repository taking into account any "url\&.<base>\&.insteadOf" config setting (See
81 \fBgit-config\fR(1)) and exit without talking to the remote\&.
82 .RE
83 .PP
84 \-\-symref
85 .RS 4
86 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\&.
87 .RE
88 .PP
89 \-\-sort=<key>
90 .RS 4
91 Sort based on the key given\&. Prefix
92 \fB\-\fR
93 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
94 \fBgit-for-each-ref\fR(1)
95 for more sort options, but be aware keys like
96 \fBcommitterdate\fR
97 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
98 \fBmissing object\fR
99 error\&.
100 .RE
101 .PP
102 \-o <option>, \-\-server\-option=<option>
103 .RS 4
104 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
105 \fB\-\-server\-option=<option>\fR
106 are given, they are all sent to the other side in the order listed on the command line\&.
107 .RE
108 .PP
109 <repository>
110 .RS 4
111 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
112 \fBgit-fetch\fR(1))\&.
113 .RE
114 .PP
115 <refs>\&...
116 .RS 4
117 When unspecified, all references, after filtering done with \-\-heads and \-\-tags, are shown\&. When <refs>\&... are specified, only references matching the given patterns are displayed\&.
118 .RE
119 .SH "EXAMPLES"
120 .sp
121 .if n \{\
122 .RS 4
123 .\}
124 .nf
125 $ git ls\-remote \-\-tags \&./\&.
126 d6602ec5194c87b0fc87103ca4d67251c76f233a refs/tags/v0\&.99
127 f25a265a342aed6041ab0cc484224d9ca54b6f41 refs/tags/v0\&.99\&.1
128 7ceca275d047c90c0c7d5afb13ab97efdf51bd6e refs/tags/v0\&.99\&.3
129 c5db5456ae3b0873fc659c19fafdde22313cc441 refs/tags/v0\&.99\&.2
130 0918385dbd9656cab0d1d81ba7453d49bbc16250 refs/tags/junio\-gpg\-pub
131 $ git ls\-remote http://www\&.kernel\&.org/pub/scm/git/git\&.git master seen rc
132 5fe978a5381f1fbad26a80e682ddd2a401966740 refs/heads/master
133 c781a84b5204fb294c9ccc79f8b3baceeb32c061 refs/heads/seen
134 $ git remote add korg http://www\&.kernel\&.org/pub/scm/git/git\&.git
135 $ git ls\-remote \-\-tags korg v\e*
136 d6602ec5194c87b0fc87103ca4d67251c76f233a refs/tags/v0\&.99
137 f25a265a342aed6041ab0cc484224d9ca54b6f41 refs/tags/v0\&.99\&.1
138 c5db5456ae3b0873fc659c19fafdde22313cc441 refs/tags/v0\&.99\&.2
139 7ceca275d047c90c0c7d5afb13ab97efdf51bd6e refs/tags/v0\&.99\&.3
140 .fi
141 .if n \{\
142 .RE
143 .\}
144 .sp
145 .SH "SEE ALSO"
146 .sp
147 \fBgit-check-ref-format\fR(1)\&.
148 .SH "GIT"
149 .sp
150 Part of the \fBgit\fR(1) suite