lsremote

Documentation

Overview

Package lsremote git-ls-remote - List references in a remote repository.

SYNOPSIS

Reference: https://git-scm.com/docs/git-ls-remote

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.

Index

• func ExitCode(g *types.Cmd)
• func GetUrl(g *types.Cmd)
• func Heads(g *types.Cmd)
• func Patterns(patterns ...string) func(*types.Cmd)
• func Quiet(g *types.Cmd)
• func Refs(g *types.Cmd)
• func Repository(url string) func(*types.Cmd)
• func ServerOption(option string) func(*types.Cmd)
• func Sort(key string) func(*types.Cmd)
• func Symref(g *types.Cmd)
• func UploadPack(exec string) func(*types.Cmd)

Functions

func ExitCode

func ExitCode(g *types.Cmd)

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

func GetUrl

func GetUrl(g *types.Cmd)

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

func Heads

func Heads(g *types.Cmd)

Heads 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. -h, --heads

func Patterns

func Patterns(patterns ...string) func(*types.Cmd)

patterns [<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 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).

func Quiet

func Quiet(g *types.Cmd)

Quiet Do not print remote URL to stderr. -q, --quiet

func Refs

func Refs(g *types.Cmd)

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

func Repository

func Repository(url string) func(*types.Cmd)

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

func ServerOption

func ServerOption(option string) func(*types.Cmd)

ServerOption 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. -o <option>, --server-option=<option>

func Sort

func Sort(key string) func(*types.Cmd)

Sort 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 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. --sort=<key>

func Symref

func Symref(g *types.Cmd)

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

func UploadPack

func UploadPack(exec string) func(*types.Cmd)

UploadPack 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. --upload-pack=<exec>