git-remote-ext(1)

1GIT-REMOTE-EXT(1)                 Git Manual                 GIT-REMOTE-EXT(1)
2
3
4

NAME

6       git-remote-ext - Bridge smart transport to external command.
7

SYNOPSIS

9       git remote add <nick> "ext::<command>[ <arguments>...]"
10
11

DESCRIPTION

13       This remote helper uses the specified <command> to connect to a remote
14       Git server.
15
16       Data written to stdin of the specified <command> is assumed to be sent
17       to a git:// server, git-upload-pack, git-receive-pack or
18       git-upload-archive (depending on situation), and data read from stdout
19       of <command> is assumed to be received from the same service.
20
21       Command and arguments are separated by an unescaped space.
22
23       The following sequences have a special meaning:
24
25       '% '
26           Literal space in command or argument.
27
28       %%
29           Literal percent sign.
30
31       %s
32           Replaced with name (receive-pack, upload-pack, or upload-archive)
33           of the service Git wants to invoke.
34
35       %S
36           Replaced with long name (git-receive-pack, git-upload-pack, or
37           git-upload-archive) of the service Git wants to invoke.
38
39       %G (must be the first characters in an argument)
40           This argument will not be passed to <command>. Instead, it will
41           cause the helper to start by sending git:// service requests to the
42           remote side with the service field set to an appropriate value and
43           the repository field set to rest of the argument. Default is not to
44           send such a request.
45
46           This is useful if remote side is git:// server accessed over some
47           tunnel.
48
49       %V (must be first characters in argument)
50           This argument will not be passed to <command>. Instead it sets the
51           vhost field in the git:// service request (to rest of the
52           argument). Default is not to send vhost in such request (if sent).
53

ENVIRONMENT VARIABLES

55       GIT_TRANSLOOP_DEBUG
56           If set, prints debugging information about various reads/writes.
57

ENVIRONMENT VARIABLES PASSED TO COMMAND

59       GIT_EXT_SERVICE
60           Set to long name (git-upload-pack, etc...) of service helper needs
61           to invoke.
62
63       GIT_EXT_SERVICE_NOPREFIX
64           Set to long name (upload-pack, etc...) of service helper needs to
65           invoke.
66

EXAMPLES

68       This remote helper is transparently used by Git when you use commands
69       such as "git fetch <URL>", "git clone <URL>", , "git push <URL>" or
70       "git remote add <nick> <URL>", where <URL> begins with ext::. Examples:
71
72       "ext::ssh -i /home/foo/.ssh/somekey user@host.example %S foo/repo"
73           Like host.example:foo/repo, but use /home/foo/.ssh/somekey as
74           keypair and user as user on remote side. This avoids needing to
75           edit .ssh/config.
76
77       "ext::socat -t3600 - ABSTRACT-CONNECT:/git-server %G/somerepo"
78           Represents repository with path /somerepo accessible over git
79           protocol at abstract namespace address /git-server.
80
81       "ext::git-server-alias foo %G/repo"
82           Represents a repository with path /repo accessed using the helper
83           program "git-server-alias foo". The path to the repository and type
84           of request are not passed on the command line but as part of the
85           protocol stream, as usual with git:// protocol.
86
87       "ext::git-server-alias foo %G/repo %Vfoo"
88           Represents a repository with path /repo accessed using the helper
89           program "git-server-alias foo". The hostname for the remote server
90           passed in the protocol stream will be "foo" (this allows multiple
91           virtual Git servers to share a link-level address).
92
93       "ext::git-server-alias foo %G/repo% with% spaces %Vfoo"
94           Represents a repository with path /repo with spaces accessed using
95           the helper program "git-server-alias foo". The hostname for the
96           remote server passed in the protocol stream will be "foo" (this
97           allows multiple virtual Git servers to share a link-level address).
98
99       "ext::git-ssl foo.example /bar"
100           Represents a repository accessed using the helper program "git-ssl
101           foo.example /bar". The type of request can be determined by the
102           helper using environment variables (see above).
103

GIT

108       Part of the git(1) suite
109
110
111
112Git 2.24.1                        12/10/2019                 GIT-REMOTE-EXT(1)