Documentation/git-remote-helpers.txt

   1 git-remote-helpers(1)
   2 =====================
   3
   4 NAME
   5 ----
   6 git-remote-helpers - Helper programs to interact with remote repositories
   7
   8 SYNOPSIS
   9 --------
  10 'git remote-<transport>' <repository> [<URL>]
  11
  12 DESCRIPTION
  13 -----------
  14
  15 Remote helper programs are normally not used directly by end users,
  16 but they are invoked by git when it needs to interact with remote
  17 repositories git does not support natively.  A given helper will
  18 implement a subset of the capabilities documented here. When git
  19 needs to interact with a repository using a remote helper, it spawns
  20 the helper as an independent process, sends commands to the helper's
  21 standard input, and expects results from the helper's standard
  22 output. Because a remote helper runs as an independent process from
  23 git, there is no need to re-link git to add a new helper, nor any
  24 need to link the helper with the implementation of git.
  25
  26 Every helper must support the "capabilities" command, which git will
  27 use to determine what other commands the helper will accept.  Other
  28 commands generally concern facilities like discovering and updating
  29 remote refs, transporting objects between the object database and
  30 the remote repository, and updating the local object store.
  31
  32 Helpers supporting the 'fetch' capability can discover refs from the
  33 remote repository and transfer objects reachable from those refs to
  34 the local object store. Helpers supporting the 'push' capability can
  35 transfer local objects to the remote repository and update remote refs.
  36
  37 Git comes with a "curl" family of remote helpers, that handle various
  38 transport protocols, such as 'git-remote-http', 'git-remote-https',
  39 'git-remote-ftp' and 'git-remote-ftps'. They implement the capabilities
  40 'fetch', 'option', and 'push'.
  41
  42 INVOCATION
  43 ----------
  44
  45 Remote helper programs are invoked with one or (optionally) two
  46 arguments. The first argument specifies a remote repository as in git;
  47 it is either the name of a configured remote or a URL. The second
  48 argument specifies a URL of the form '<transport>://<address>' or
  49 '<transport>::<address>', where '<address>' may be an arbitrary
  50 string.
  51
  52 When git encounters a URL of the form '<transport>://<address>', where
  53 '<transport>' is a protocol that it cannot handle natively, it
  54 automatically invokes 'git remote-<transport>' with the full URL as
  55 the second argument. If such a URL is encountered directly on the
  56 command line, the first argument is the same as the second, and if it
  57 is encountered in a configured remote, the first argument is the name
  58 of that remote.
  59
  60 A URL of the form '<transport>::<address>' explicitly instructs git to
  61 invoke 'git remote-<transport>' with '<address>' as the second
  62 argument. If such a URL is encountered directly on the command line,
  63 the first argument is '<address>', and if it is encountered in a
  64 configured remote, the first argument is the name of that remote.
  65
  66 Additionally, when a configured remote has 'remote.<name>.vcs' set to
  67 '<transport>', git explicitly invokes 'git remote-<transport>' with
  68 '<name>' as the first argument. If set, the second argument is
  69 'remote.<name>.url'; otherwise, the second argument is omitted.
  70
  71 COMMANDS
  72 --------
  73
  74 Commands are given by the caller on the helper's standard input, one per line.
  75
  76 'capabilities'::
  77         Lists the capabilities of the helper, one per line, ending
  78         with a blank line. Each capability may be preceded with '*'.
  79         This marks them mandatory for git version using the remote
  80         helper to understand (unknown mandatory capability is fatal
  81         error).
  82
  83 'list'::
  84         Lists the refs, one per line, in the format "<value> <name>
  85         [<attr> ...]". The value may be a hex sha1 hash, "@<dest>" for
  86         a symref, or "?" to indicate that the helper could not get the
  87         value of the ref. A space-separated list of attributes follows
  88         the name; unrecognized attributes are ignored. After the
  89         complete list, outputs a blank line.
  90 +
  91 If 'push' is supported this may be called as 'list for-push'
  92 to obtain the current refs prior to sending one or more 'push'
  93 commands to the helper.
  94
  95 'option' <name> <value>::
  96         Set the transport helper option <name> to <value>.  Outputs a
  97         single line containing one of 'ok' (option successfully set),
  98         'unsupported' (option not recognized) or 'error <msg>'
  99         (option <name> is supported but <value> is not correct
 100         for it).  Options should be set before other commands,
 101         and may how those commands behave.
 102 +
 103 Supported if the helper has the "option" capability.
 104
 105 'fetch' <sha1> <name>::
 106         Fetches the given object, writing the necessary objects
 107         to the database.  Fetch commands are sent in a batch, one
 108         per line, and the batch is terminated with a blank line.
 109         Outputs a single blank line when all fetch commands in the
 110         same batch are complete. Only objects which were reported
 111         in the ref list with a sha1 may be fetched this way.
 112 +
 113 Optionally may output a 'lock <file>' line indicating a file under
 114 GIT_DIR/objects/pack which is keeping a pack until refs can be
 115 suitably updated.
 116 +
 117 Supported if the helper has the "fetch" capability.
 118
 119 'push' +<src>:<dst>::
 120         Pushes the given <src> commit or branch locally to the
 121         remote branch described by <dst>.  A batch sequence of
 122         one or more push commands is terminated with a blank line.
 123 +
 124 Zero or more protocol options may be entered after the last 'push'
 125 command, before the batch's terminating blank line.
 126 +
 127 When the push is complete, outputs one or more 'ok <dst>' or
 128 'error <dst> <why>?' lines to indicate success or failure of
 129 each pushed ref.  The status report output is terminated by
 130 a blank line.  The option field <why> may be quoted in a C
 131 style string if it contains an LF.
 132 +
 133 Supported if the helper has the "push" capability.
 134
 135 'import' <name>::
 136         Produces a fast-import stream which imports the current value
 137         of the named ref. It may additionally import other refs as
 138         needed to construct the history efficiently. The script writes
 139         to a helper-specific private namespace. The value of the named
 140         ref should be written to a location in this namespace derived
 141         by applying the refspecs from the "refspec" capability to the
 142         name of the ref.
 143 +
 144 Supported if the helper has the "import" capability.
 145
 146 'connect' <service>::
 147         Connects to given service. Standard input and standard output
 148         of helper are connected to specified service (git prefix is
 149         included in service name so e.g. fetching uses 'git-upload-pack'
 150         as service) on remote side. Valid replies to this command are
 151         empty line (connection established), 'fallback' (no smart
 152         transport support, fall back to dumb transports) and just
 153         exiting with error message printed (can't connect, don't
 154         bother trying to fall back). After line feed terminating the
 155         positive (empty) response, the output of service starts. After
 156         the connection ends, the remote helper exits.
 157 +
 158 Supported if the helper has the "connect" capability.
 159
 160 If a fatal error occurs, the program writes the error message to
 161 stderr and exits. The caller should expect that a suitable error
 162 message has been printed if the child closes the connection without
 163 completing a valid response for the current command.
 164
 165 Additional commands may be supported, as may be determined from
 166 capabilities reported by the helper.
 167
 168 CAPABILITIES
 169 ------------
 170
 171 'fetch'::
 172         This helper supports the 'fetch' command.
 173
 174 'option'::
 175         This helper supports the option command.
 176
 177 'push'::
 178         This helper supports the 'push' command.
 179
 180 'import'::
 181         This helper supports the 'import' command.
 182
 183 'refspec' 'spec'::
 184         When using the import command, expect the source ref to have
 185         been written to the destination ref. The earliest applicable
 186         refspec takes precedence. For example
 187         "refs/heads/*:refs/svn/origin/branches/*" means that, after an
 188         "import refs/heads/name", the script has written to
 189         refs/svn/origin/branches/name. If this capability is used at
 190         all, it must cover all refs reported by the list command; if
 191         it is not used, it is effectively "*:*"
 192
 193 'connect'::
 194         This helper supports the 'connect' command.
 195
 196 REF LIST ATTRIBUTES
 197 -------------------
 198
 199 'for-push'::
 200         The caller wants to use the ref list to prepare push
 201         commands.  A helper might chose to acquire the ref list by
 202         opening a different type of connection to the destination.
 203
 204 'unchanged'::
 205         This ref is unchanged since the last import or fetch, although
 206         the helper cannot necessarily determine what value that produced.
 207
 208 OPTIONS
 209 -------
 210 'option verbosity' <N>::
 211         Change the level of messages displayed by the helper.
 212         When N is 0 the end-user has asked the process to be
 213         quiet, and the helper should produce only error output.
 214         N of 1 is the default level of verbosity, higher values
 215         of N correspond to the number of -v flags passed on the
 216         command line.
 217
 218 'option progress' \{'true'|'false'\}::
 219         Enable (or disable) progress messages displayed by the
 220         transport helper during a command.
 221
 222 'option depth' <depth>::
 223         Deepen the history of a shallow repository.
 224
 225 'option followtags' \{'true'|'false'\}::
 226         If enabled the helper should automatically fetch annotated
 227         tag objects if the object the tag points at was transferred
 228         during the fetch command.  If the tag is not fetched by
 229         the helper a second fetch command will usually be sent to
 230         ask for the tag specifically.  Some helpers may be able to
 231         use this option to avoid a second network connection.
 232
 233 'option dry-run' \{'true'|'false'\}:
 234         If true, pretend the operation completed successfully,
 235         but don't actually change any repository data.  For most
 236         helpers this only applies to the 'push', if supported.
 237
 238 'option servpath <c-style-quoted-path>'::
 239         Set service path (--upload-pack, --receive-pack etc.) for
 240         next connect. Remote helper MAY support this option. Remote
 241         helper MUST NOT rely on this option being set before
 242         connect request occurs.
 243
 244 SEE ALSO
 245 --------
 246 linkgit:git-remote[1]
 247
 248 Documentation
 249 -------------
 250 Documentation by Daniel Barkalow and Ilari Liusvaara
 251
 252 GIT
 253 ---
 254 Part of the linkgit:git[1] suite