| Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 1 | git-ls-remote(1) |
| 2 | ================ |
| 3 | |
| 4 | NAME |
| 5 | ---- |
| Junio C Hamano | 6b2cee1 | 2006-08-26 08:43:31 | [diff] [blame] | 6 | git-ls-remote - List references in a remote repository |
| Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 7 | |
| 8 | |
| 9 | SYNOPSIS |
| 10 | -------- |
| Junio C Hamano | 6b2cee1 | 2006-08-26 08:43:31 | [diff] [blame] | 11 | [verse] |
| Junio C Hamano | ffe10ca | 2016-02-04 00:44:23 | [diff] [blame] | 12 | 'git ls-remote' [--heads] [--tags] [--refs] [--upload-pack=<exec>] |
| 13 | [-q | --quiet] [--exit-code] [--get-url] |
| 14 | [--symref] [<repository> [<refs>...]] |
| Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 15 | |
| 16 | DESCRIPTION |
| 17 | ----------- |
| Junio C Hamano | 6b2cee1 | 2006-08-26 08:43:31 | [diff] [blame] | 18 | Displays references available in a remote repository along with the associated |
| 19 | commit IDs. |
| Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 20 | |
| 21 | |
| 22 | OPTIONS |
| 23 | ------- |
| Junio C Hamano | eb41599 | 2008-06-08 22:49:47 | [diff] [blame] | 24 | -h:: |
| 25 | --heads:: |
| 26 | -t:: |
| 27 | --tags:: |
| Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 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. |
| 32 | |
| Junio C Hamano | ffe10ca | 2016-02-04 00:44:23 | [diff] [blame] | 33 | --refs:: |
| 34 | Do not show peeled tags or pseudorefs like HEAD in the output. |
| 35 | |
| 36 | -q:: |
| 37 | --quiet:: |
| 38 | Do not print remote URL to stderr. |
| 39 | |
| Junio C Hamano | eb41599 | 2008-06-08 22:49:47 | [diff] [blame] | 40 | --upload-pack=<exec>:: |
| Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 41 | Specify the full path of 'git-upload-pack' on the remote |
| Junio C Hamano | 6b2cee1 | 2006-08-26 08:43:31 | [diff] [blame] | 42 | host. This allows listing references from repositories accessed via |
| Junio C Hamano | f9771f6 | 2007-01-17 17:42:30 | [diff] [blame] | 43 | SSH and where the SSH daemon does not use the PATH configured by the |
| Junio C Hamano | 1fbbbc1 | 2007-12-18 07:01:27 | [diff] [blame] | 44 | user. |
| Junio C Hamano | 6b2cee1 | 2006-08-26 08:43:31 | [diff] [blame] | 45 | |
| Junio C Hamano | 2a294cd | 2011-05-23 23:06:31 | [diff] [blame] | 46 | --exit-code:: |
| 47 | Exit with status "2" when no matching refs are found in the remote |
| 48 | repository. Usually the command exits with status "0" to indicate |
| 49 | it successfully talked with the remote repository, whether it |
| 50 | found any matching refs. |
| 51 | |
| Junio C Hamano | f76c10b | 2012-09-14 20:11:04 | [diff] [blame] | 52 | --get-url:: |
| 53 | Expand the URL of the given remote repository taking into account any |
| 54 | "url.<base>.insteadOf" config setting (See linkgit:git-config[1]) and |
| 55 | exit without talking to the remote. |
| 56 | |
| Junio C Hamano | ffe10ca | 2016-02-04 00:44:23 | [diff] [blame] | 57 | --symref:: |
| 58 | In addition to the object pointed by it, show the underlying |
| 59 | ref pointed by it when showing a symbolic ref. Currently, |
| 60 | upload-pack only shows the symref HEAD, so it will be the only |
| 61 | one shown by ls-remote. |
| 62 | |
| Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 63 | <repository>:: |
| Junio C Hamano | a195230 | 2013-07-01 21:31:18 | [diff] [blame] | 64 | The "remote" repository to query. This parameter can be |
| 65 | either a URL or the name of a remote (see the GIT URLS and |
| 66 | REMOTES sections of linkgit:git-fetch[1]). |
| Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 67 | |
| 68 | <refs>...:: |
| 69 | When unspecified, all references, after filtering done |
| 70 | with --heads and --tags, are shown. When <refs>... are |
| 71 | specified, only references matching the given patterns |
| 72 | are displayed. |
| 73 | |
| 74 | EXAMPLES |
| 75 | -------- |
| 76 | |
| 77 | $ git ls-remote --tags ./. |
| 78 | d6602ec5194c87b0fc87103ca4d67251c76f233a refs/tags/v0.99 |
| 79 | f25a265a342aed6041ab0cc484224d9ca54b6f41 refs/tags/v0.99.1 |
| 80 | 7ceca275d047c90c0c7d5afb13ab97efdf51bd6e refs/tags/v0.99.3 |
| 81 | c5db5456ae3b0873fc659c19fafdde22313cc441 refs/tags/v0.99.2 |
| 82 | 0918385dbd9656cab0d1d81ba7453d49bbc16250 refs/tags/junio-gpg-pub |
| 83 | $ git ls-remote http://www.kernel.org/pub/scm/git/git.git master pu rc |
| 84 | 5fe978a5381f1fbad26a80e682ddd2a401966740 refs/heads/master |
| 85 | c781a84b5204fb294c9ccc79f8b3baceeb32c061 refs/heads/pu |
| Junio C Hamano | a195230 | 2013-07-01 21:31:18 | [diff] [blame] | 86 | $ git remote add korg http://www.kernel.org/pub/scm/git/git.git |
| 87 | $ git ls-remote --tags korg v\* |
| Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 88 | d6602ec5194c87b0fc87103ca4d67251c76f233a refs/tags/v0.99 |
| 89 | f25a265a342aed6041ab0cc484224d9ca54b6f41 refs/tags/v0.99.1 |
| 90 | c5db5456ae3b0873fc659c19fafdde22313cc441 refs/tags/v0.99.2 |
| 91 | 7ceca275d047c90c0c7d5afb13ab97efdf51bd6e refs/tags/v0.99.3 |
| 92 | |
| Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 93 | GIT |
| 94 | --- |
| Junio C Hamano | f7c042d | 2008-06-06 22:50:53 | [diff] [blame] | 95 | Part of the linkgit:git[1] suite |
