Google Git
Sign in
chromium / external / gitster / git-htmldocs / ccb8252b46bfba5daf0cfcedaf0f9d2e14ba356f / . / git-ls-remote.txt
blob: 6ad1e34afca4cd569798bfcbae9f99d038693b64 [file] [log] [blame]
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]1git-ls-remote(1)
2================
3
4NAME
5----
Junio C Hamano6b2cee12006-08-26 08:43:31[diff] [blame]6git-ls-remote - List references in a remote repository
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]7
8
9SYNOPSIS
10--------
Junio C Hamano6b2cee12006-08-26 08:43:31[diff] [blame]11[verse]
Junio C Hamanoffe10ca2016-02-04 00:44:23[diff] [blame]12'git ls-remote' [--heads] [--tags] [--refs] [--upload-pack=<exec>]
Junio C Hamanoccb82522018-05-08 07:52:09[diff] [blame^]13 [-q | --quiet] [--exit-code] [--get-url] [--sort=<key>]
Junio C Hamanoffe10ca2016-02-04 00:44:23[diff] [blame]14 [--symref] [<repository> [<refs>...]]
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]15
16DESCRIPTION
17-----------
Junio C Hamano6b2cee12006-08-26 08:43:31[diff] [blame]18Displays references available in a remote repository along with the associated
19commit IDs.
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]20
21
22OPTIONS
23-------
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]24-h::
25--heads::
26-t::
27--tags::
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]28Limit to only refs/heads and refs/tags, respectively.
29These options are _not_ mutually exclusive; when given
30both, references stored in refs/heads and refs/tags are
31displayed.
32
Junio C Hamanoffe10ca2016-02-04 00:44:23[diff] [blame]33--refs::
34Do not show peeled tags or pseudorefs like HEAD in the output.
35
36-q::
37--quiet::
38Do not print remote URL to stderr.
39
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]40--upload-pack=<exec>::
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]41Specify the full path of 'git-upload-pack' on the remote
Junio C Hamano6b2cee12006-08-26 08:43:31[diff] [blame]42host. This allows listing references from repositories accessed via
Junio C Hamanof9771f62007-01-17 17:42:30[diff] [blame]43SSH and where the SSH daemon does not use the PATH configured by the
Junio C Hamano1fbbbc12007-12-18 07:01:27[diff] [blame]44user.
Junio C Hamano6b2cee12006-08-26 08:43:31[diff] [blame]45
Junio C Hamano2a294cd2011-05-23 23:06:31[diff] [blame]46--exit-code::
47Exit with status "2" when no matching refs are found in the remote
48repository. Usually the command exits with status "0" to indicate
49it successfully talked with the remote repository, whether it
50found any matching refs.
51
Junio C Hamanof76c10b2012-09-14 20:11:04[diff] [blame]52--get-url::
53Expand the URL of the given remote repository taking into account any
54"url.<base>.insteadOf" config setting (See linkgit:git-config[1]) and
55exit without talking to the remote.
56
Junio C Hamanoffe10ca2016-02-04 00:44:23[diff] [blame]57--symref::
58In addition to the object pointed by it, show the underlying
59ref pointed by it when showing a symbolic ref. Currently,
60upload-pack only shows the symref HEAD, so it will be the only
61one shown by ls-remote.
62
Junio C Hamanoccb82522018-05-08 07:52:09[diff] [blame^]63--sort=<key>::
64Sort based on the key given. Prefix `-` to sort in descending order
65of the value. Supports "version:refname" or "v:refname" (tag names
66are treated as versions). The "version:refname" sort order can also
67be affected by the "versionsort.suffix" configuration variable.
68See linkgit:git-for-each-ref[1] for more sort options, but be aware
69keys like `committerdate` that require access to the objects
70themselves will not work for refs whose objects have not yet been
71fetched from the remote, and will give a `missing object` error.
72
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]73<repository>::
Junio C Hamanoa1952302013-07-01 21:31:18[diff] [blame]74The "remote" repository to query. This parameter can be
75either a URL or the name of a remote (see the GIT URLS and
76REMOTES sections of linkgit:git-fetch[1]).
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]77
78<refs>...::
79When unspecified, all references, after filtering done
80with --heads and --tags, are shown. When <refs>... are
81specified, only references matching the given patterns
82are displayed.
83
84EXAMPLES
85--------
86
87$ git ls-remote --tags ./.
88d6602ec5194c87b0fc87103ca4d67251c76f233a refs/tags/v0.99
89f25a265a342aed6041ab0cc484224d9ca54b6f41 refs/tags/v0.99.1
907ceca275d047c90c0c7d5afb13ab97efdf51bd6e refs/tags/v0.99.3
91c5db5456ae3b0873fc659c19fafdde22313cc441 refs/tags/v0.99.2
920918385dbd9656cab0d1d81ba7453d49bbc16250 refs/tags/junio-gpg-pub
93$ git ls-remote http://www.kernel.org/pub/scm/git/git.git master pu rc
945fe978a5381f1fbad26a80e682ddd2a401966740 refs/heads/master
95c781a84b5204fb294c9ccc79f8b3baceeb32c061 refs/heads/pu
Junio C Hamanoa1952302013-07-01 21:31:18[diff] [blame]96$ git remote add korg http://www.kernel.org/pub/scm/git/git.git
97$ git ls-remote --tags korg v\*
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]98d6602ec5194c87b0fc87103ca4d67251c76f233a refs/tags/v0.99
99f25a265a342aed6041ab0cc484224d9ca54b6f41 refs/tags/v0.99.1
100c5db5456ae3b0873fc659c19fafdde22313cc441 refs/tags/v0.99.2
1017ceca275d047c90c0c7d5afb13ab97efdf51bd6e refs/tags/v0.99.3
102
Junio C Hamanoccb82522018-05-08 07:52:09[diff] [blame^]103SEE ALSO
104--------
105linkgit:git-check-ref-format[1].
106
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]107GIT
108---
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]109Part of the linkgit:git[1] suite