man1/git-ls-remote.1

   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-02-15
   6 .\"    Manual: Git Manual
   7 .\"    Source: Git 2.44.0.rc1.17.g3e0d3cd5c7
   8 .\"  Language: English
   9 .\"
  10 .TH "GIT\-LS\-REMOTE" "1" "2024\-02\-15" "Git 2\&.44\&.0\&.rc1\&.17\&.g3" "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> [<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 \-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 <patterns>\&...
 116 .RS 4
 117 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
 118 \fBglob\fR
 119 in
 120 \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
 121 \fBrefs/heads/foo\fR
 122 matches) or from a slash separator (so
 123 \fBbar\fR
 124 matches
 125 \fBrefs/heads/bar\fR
 126 but not
 127 \fBrefs/heads/foobar\fR)\&.
 128 .RE
 129 .SH "OUTPUT"
 130 .sp
 131 The output is in the format:
 132 .sp
 133 .if n \{\
 134 .RS 4
 135 .\}
 136 .nf
 137 <oid> TAB <ref> LF
 138 .fi
 139 .if n \{\
 140 .RE
 141 .\}
 142 .sp
 143 .sp
 144 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\&.
 145 .SH "EXAMPLES"
 146 .sp
 147 .RS 4
 148 .ie n \{\
 149 \h'-04'\(bu\h'+03'\c
 150 .\}
 151 .el \{\
 152 .sp -1
 153 .IP \(bu 2.3
 154 .\}
 155 List all references (including symbolics and pseudorefs), peeling tags:
 156 .sp
 157 .if n \{\
 158 .RS 4
 159 .\}
 160 .nf
 161 $ git ls\-remote
 162 27d43aaaf50ef0ae014b88bba294f93658016a2e        HEAD
 163 950264636c68591989456e3ba0a5442f93152c1a        refs/heads/main
 164 d9ab777d41f92a8c1684c91cfb02053d7dd1046b        refs/heads/next
 165 d4ca2e3147b409459955613c152220f4db848ee1        refs/tags/v2\&.40\&.0
 166 73876f4861cd3d187a4682290ab75c9dccadbc56        refs/tags/v2\&.40\&.0^{}
 167 .fi
 168 .if n \{\
 169 .RE
 170 .\}
 171 .sp
 172 .RE
 173 .sp
 174 .RS 4
 175 .ie n \{\
 176 \h'-04'\(bu\h'+03'\c
 177 .\}
 178 .el \{\
 179 .sp -1
 180 .IP \(bu 2.3
 181 .\}
 182 List all references matching given patterns:
 183 .sp
 184 .if n \{\
 185 .RS 4
 186 .\}
 187 .nf
 188 $ git ls\-remote http://www\&.kernel\&.org/pub/scm/git/git\&.git master seen rc
 189 5fe978a5381f1fbad26a80e682ddd2a401966740        refs/heads/master
 190 c781a84b5204fb294c9ccc79f8b3baceeb32c061        refs/heads/seen
 191 .fi
 192 .if n \{\
 193 .RE
 194 .\}
 195 .sp
 196 .RE
 197 .sp
 198 .RS 4
 199 .ie n \{\
 200 \h'-04'\(bu\h'+03'\c
 201 .\}
 202 .el \{\
 203 .sp -1
 204 .IP \(bu 2.3
 205 .\}
 206 List only tags matching a given wildcard pattern:
 207 .sp
 208 .if n \{\
 209 .RS 4
 210 .\}
 211 .nf
 212 $ git ls\-remote \-\-tags http://www\&.kernel\&.org/pub/scm/git/git\&.git v\e*
 213 485a869c64a68cc5795dd99689797c5900f4716d        refs/tags/v2\&.39\&.2
 214 cbf04937d5b9fcf0a76c28f69e6294e9e3ecd7e6        refs/tags/v2\&.39\&.2^{}
 215 d4ca2e3147b409459955613c152220f4db848ee1        refs/tags/v2\&.40\&.0
 216 73876f4861cd3d187a4682290ab75c9dccadbc56        refs/tags/v2\&.40\&.0^{}
 217 .fi
 218 .if n \{\
 219 .RE
 220 .\}
 221 .sp
 222 .RE
 223 .SH "SEE ALSO"
 224 .sp
 225 \fBgit-check-ref-format\fR(1)\&.
 226 .SH "GIT"
 227 .sp
 228 Part of the \fBgit\fR(1) suite