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

DESCRIPTION

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

ENVIRONMENT VARIABLES

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

ENVIRONMENT VARIABLES PASSED TO COMMAND

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

EXAMPLES

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

GIT

107       Part of the git(1) suite
108
109
110
111Git 2.36.1                        2022-05-05                 GIT-REMOTE-EXT(1)