[thirdparty/git.git] / Documentation / git-ls-remote.txt

git-ls-remote(1)
================

NAME
----
git-ls-remote - List references in a remote repository


SYNOPSIS
--------
[verse]
'git ls-remote' [--heads] [--tags] [--refs] [--upload-pack=<exec>]
	      [-q | --quiet] [--exit-code] [--get-url] [--sort=<key>]
	      [--symref] [<repository> [<patterns>...]]

DESCRIPTION
-----------
Displays references available in a remote repository along with the associated
commit IDs.


OPTIONS
-------
-h::
--heads::
-t::
--tags::
	Limit to only refs/heads and refs/tags, respectively.
	These options are _not_ mutually exclusive; when given
	both, references stored in refs/heads and refs/tags are
	displayed.  Note that `git ls-remote -h` used without
	anything else on the command line gives help, consistent
	with other git subcommands.

--refs::
	Do not show peeled tags or pseudorefs like `HEAD` in the output.

-q::
--quiet::
	Do not print remote URL to stderr.

--upload-pack=<exec>::
	Specify the full path of 'git-upload-pack' 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.

--exit-code::
	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.

--get-url::
	Expand the URL of the given remote repository taking into account any
	"url.<base>.insteadOf" config setting (See linkgit:git-config[1]) and
	exit without talking to the remote.

--symref::
	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.

--sort=<key>::
	Sort based on the key given. Prefix `-` 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 linkgit:git-for-each-ref[1] for more sort options, but be aware
	keys like `committerdate` 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 `missing object` error.

-o <option>::
--server-option=<option>::
	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 `--server-option=<option>` are given, they are all
	sent to the other side in the order listed on the command line.

<repository>::
	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 linkgit:git-fetch[1]).

<patterns>...::
	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 `glob` in linkgit:gitglossary[7]) which is matched against
	the "tail" of a ref, starting either from the start of the ref
	(so a full name like `refs/heads/foo` matches) or from a slash
	separator (so `bar` matches `refs/heads/bar` but not
	`refs/heads/foobar`).

EXAMPLES
--------

* List all references matching given patterns:
+
----
$ git ls-remote http://www.kernel.org/pub/scm/git/git.git master seen rc
5fe978a5381f1fbad26a80e682ddd2a401966740	refs/heads/master
c781a84b5204fb294c9ccc79f8b3baceeb32c061	refs/heads/seen
----

* List only tags matching a given wildcard pattern:
+
----
$ git ls-remote --tags http://www.kernel.org/pub/scm/git/git.git v\*
485a869c64a68cc5795dd99689797c5900f4716d	refs/tags/v2.39.2
cbf04937d5b9fcf0a76c28f69e6294e9e3ecd7e6	refs/tags/v2.39.2^{}
d4ca2e3147b409459955613c152220f4db848ee1	refs/tags/v2.40.0
73876f4861cd3d187a4682290ab75c9dccadbc56	refs/tags/v2.40.0^{}
----

SEE ALSO
--------
linkgit:git-check-ref-format[1].

GIT
---
Part of the linkgit:git[1] suite
Commit	Line	Data
215a7ad1 JH	1	git-ls-remote(1)
215a7ad1 JH	2	================
972b6fe7 JH	3
	4	NAME
	5	----
0dde6899	6	git-ls-remote - List references in a remote repository
972b6fe7 JH	7
	8
	9	SYNOPSIS
	10	--------
0dde6899	11	[verse]
40a88529	12	'git ls-remote' [--heads] [--tags] [--refs] [--upload-pack=<exec>]
1fb20dfd	13	[-q \| --quiet] [--exit-code] [--get-url] [--sort=<key>]
d9ec3b0d	14	[--symref] [<repository> [<patterns>...]]
972b6fe7 JH	15
	16	DESCRIPTION
	17	-----------
0dde6899 JF	18	Displays references available in a remote repository along with the associated
0dde6899 JF	19	commit IDs.
972b6fe7 JH	20
	21
	22	OPTIONS
	23	-------
3240240f SB	24	-h::
	25	--heads::
	26	-t::
	27	--tags::
972b6fe7 JH	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
1ff466c0 JH	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.
972b6fe7	34
40a88529	35	--refs::
8d75a1d1	36	Do not show peeled tags or pseudorefs like `HEAD` in the output.
40a88529	37
54813bdd TG	38	-q::
	39	--quiet::
	40	Do not print remote URL to stderr.
	41
3240240f	42	--upload-pack=<exec>::
ba020ef5	43	Specify the full path of 'git-upload-pack' on the remote
0dde6899	44	host. This allows listing references from repositories accessed via
23bfbb81	45	SSH and where the SSH daemon does not use the PATH configured by the
f0294272	46	user.
0dde6899	47
a8724773 MS	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
2303cad2 SN	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
99c08d4e TG	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
1fb20dfd HN	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
ff473221 BW	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
972b6fe7	83	<repository>::
88e36141 RR	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]).
972b6fe7	87
d9ec3b0d	88	<patterns>...::
972b6fe7	89	When unspecified, all references, after filtering done
d9ec3b0d JK	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`).
972b6fe7 JH	98
	99	EXAMPLES
	100	--------
	101
a5b07632 SA	102	* List all references matching given patterns:
a5b07632 SA	103	+
53718137	104	----
828197de	105	$ git ls-remote http://www.kernel.org/pub/scm/git/git.git master seen rc
53718137	106	5fe978a5381f1fbad26a80e682ddd2a401966740 refs/heads/master
828197de	107	c781a84b5204fb294c9ccc79f8b3baceeb32c061 refs/heads/seen
a5b07632	108	----
baebde7d	109
a5b07632 SA	110	* List only tags matching a given wildcard pattern:
	111	+
	112	----
	113	$ git ls-remote --tags http://www.kernel.org/pub/scm/git/git.git v\*
e959fa45 SA	114	485a869c64a68cc5795dd99689797c5900f4716d refs/tags/v2.39.2
	115	cbf04937d5b9fcf0a76c28f69e6294e9e3ecd7e6 refs/tags/v2.39.2^{}
	116	d4ca2e3147b409459955613c152220f4db848ee1 refs/tags/v2.40.0
	117	73876f4861cd3d187a4682290ab75c9dccadbc56 refs/tags/v2.40.0^{}
53718137	118	----
972b6fe7	119
1fb20dfd HN	120	SEE ALSO
	121	--------
	122	linkgit:git-check-ref-format[1].
	123
972b6fe7 JH	124	GIT
972b6fe7 JH	125	---
9e1f0a85	126	Part of the linkgit:git[1] suite