Documentation/git-ls-remote.txt

   1 git-ls-remote(1)
   2 ================
   3
   4 NAME
   5 ----
   6 git-ls-remote - List references in a remote repository
   7
   8
   9 SYNOPSIS
  10 --------
  11 [verse]
  12 'git ls-remote' [--heads] [--tags] [--refs] [--upload-pack=<exec>]
  13               [-q | --quiet] [--exit-code] [--get-url] [--sort=<key>]
  14               [--symref] [<repository> [<patterns>...]]
  15
  16 DESCRIPTION
  17 -----------
  18 Displays references available in a remote repository along with the associated
  19 commit IDs.
  20
  21
  22 OPTIONS
  23 -------
  24 -h::
  25 --heads::
  26 -t::
  27 --tags::
  28         Limit to only refs/heads and refs/tags, respectively.
  29         These options are _not_ mutually exclusive; when given
  30         both, references stored in refs/heads and refs/tags are
  31         displayed.  Note that `git ls-remote -h` used without
  32         anything else on the command line gives help, consistent
  33         with other git subcommands.
  34
  35 --refs::
  36         Do not show peeled tags or pseudorefs like `HEAD` in the output.
  37
  38 -q::
  39 --quiet::
  40         Do not print remote URL to stderr.
  41
  42 --upload-pack=<exec>::
  43         Specify the full path of 'git-upload-pack' on the remote
  44         host. This allows listing references from repositories accessed via
  45         SSH and where the SSH daemon does not use the PATH configured by the
  46         user.
  47
  48 --exit-code::
  49         Exit with status "2" when no matching refs are found in the remote
  50         repository. Usually the command exits with status "0" to indicate
  51         it successfully talked with the remote repository, whether it
  52         found any matching refs.
  53
  54 --get-url::
  55         Expand the URL of the given remote repository taking into account any
  56         "url.<base>.insteadOf" config setting (See linkgit:git-config[1]) and
  57         exit without talking to the remote.
  58
  59 --symref::
  60         In addition to the object pointed by it, show the underlying
  61         ref pointed by it when showing a symbolic ref.  Currently,
  62         upload-pack only shows the symref HEAD, so it will be the only
  63         one shown by ls-remote.
  64
  65 --sort=<key>::
  66         Sort based on the key given. Prefix `-` to sort in descending order
  67         of the value. Supports "version:refname" or "v:refname" (tag names
  68         are treated as versions). The "version:refname" sort order can also
  69         be affected by the "versionsort.suffix" configuration variable.
  70         See linkgit:git-for-each-ref[1] for more sort options, but be aware
  71         keys like `committerdate` that require access to the objects
  72         themselves will not work for refs whose objects have not yet been
  73         fetched from the remote, and will give a `missing object` error.
  74
  75 -o <option>::
  76 --server-option=<option>::
  77         Transmit the given string to the server when communicating using
  78         protocol version 2.  The given string must not contain a NUL or LF
  79         character.
  80         When multiple `--server-option=<option>` are given, they are all
  81         sent to the other side in the order listed on the command line.
  82
  83 <repository>::
  84         The "remote" repository to query.  This parameter can be
  85         either a URL or the name of a remote (see the GIT URLS and
  86         REMOTES sections of linkgit:git-fetch[1]).
  87
  88 <patterns>...::
  89         When unspecified, all references, after filtering done
  90         with --heads and --tags, are shown.  When <patterns>... are
  91         specified, only references matching one or more of the given
  92         patterns are displayed. Each pattern is interpreted as a glob
  93         (see `glob` in linkgit:gitglossary[7]) which is matched against
  94         the "tail" of a ref, starting either from the start of the ref
  95         (so a full name like `refs/heads/foo` matches) or from a slash
  96         separator (so `bar` matches `refs/heads/bar` but not
  97         `refs/heads/foobar`).
  98
  99 OUTPUT
 100 ------
 101
 102 The output is in the format:
 103
 104 ------------
 105 <oid> TAB <ref> LF
 106 ------------
 107
 108 When showing an annotated tag, unless `--refs` is given, two such
 109 lines are shown: one with the refname for the tag itself as `<ref>`,
 110 and another with `<ref>` followed by `^{}`. The `<oid>` on the latter
 111 line shows the name of the object the tag points at.
 112
 113 EXAMPLES
 114 --------
 115
 116 * List all references (including symbolics and pseudorefs), peeling
 117   tags:
 118 +
 119 ----
 120 $ git ls-remote
 121 27d43aaaf50ef0ae014b88bba294f93658016a2e        HEAD
 122 950264636c68591989456e3ba0a5442f93152c1a        refs/heads/main
 123 d9ab777d41f92a8c1684c91cfb02053d7dd1046b        refs/heads/next
 124 d4ca2e3147b409459955613c152220f4db848ee1        refs/tags/v2.40.0
 125 73876f4861cd3d187a4682290ab75c9dccadbc56        refs/tags/v2.40.0^{}
 126 ----
 127
 128 * List all references matching given patterns:
 129 +
 130 ----
 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 ----
 135
 136 * List only tags matching a given wildcard pattern:
 137 +
 138 ----
 139 $ git ls-remote --tags http://www.kernel.org/pub/scm/git/git.git v\*
 140 485a869c64a68cc5795dd99689797c5900f4716d        refs/tags/v2.39.2
 141 cbf04937d5b9fcf0a76c28f69e6294e9e3ecd7e6        refs/tags/v2.39.2^{}
 142 d4ca2e3147b409459955613c152220f4db848ee1        refs/tags/v2.40.0
 143 73876f4861cd3d187a4682290ab75c9dccadbc56        refs/tags/v2.40.0^{}
 144 ----
 145
 146 SEE ALSO
 147 --------
 148 linkgit:git-check-ref-format[1].
 149
 150 GIT
 151 ---
 152 Part of the linkgit:git[1] suite