]>
Commit | Line | Data |
---|---|---|
439cc746 | 1 | gitremote-helpers(7) |
bd4a3d61 | 2 | ==================== |
6eb996b5 DB |
3 | |
4 | NAME | |
5 | ---- | |
bd4a3d61 | 6 | gitremote-helpers - Helper programs to interact with remote repositories |
6eb996b5 DB |
7 | |
8 | SYNOPSIS | |
9 | -------- | |
7791a1d9 | 10 | [verse] |
b6c8d2d6 | 11 | 'git remote-<transport>' <repository> [<URL>] |
6eb996b5 DB |
12 | |
13 | DESCRIPTION | |
14 | ----------- | |
15 | ||
00b84e9d | 16 | Remote helper programs are normally not used directly by end users, |
2de9b711 TA |
17 | but they are invoked by Git when it needs to interact with remote |
18 | repositories Git does not support natively. A given helper will | |
19 | implement a subset of the capabilities documented here. When Git | |
00b84e9d RR |
20 | needs to interact with a repository using a remote helper, it spawns |
21 | the helper as an independent process, sends commands to the helper's | |
22 | standard input, and expects results from the helper's standard | |
23 | output. Because a remote helper runs as an independent process from | |
2de9b711 TA |
24 | Git, there is no need to re-link Git to add a new helper, nor any |
25 | need to link the helper with the implementation of Git. | |
00b84e9d | 26 | |
2de9b711 | 27 | Every helper must support the "capabilities" command, which Git |
b4fc8d6a JN |
28 | uses to determine what other commands the helper will accept. Those |
29 | other commands can be used to discover and update remote refs, | |
30 | transport objects between the object database and the remote repository, | |
31 | and update the local object store. | |
00b84e9d RR |
32 | |
33 | Git comes with a "curl" family of remote helpers, that handle various | |
34 | transport protocols, such as 'git-remote-http', 'git-remote-https', | |
35 | 'git-remote-ftp' and 'git-remote-ftps'. They implement the capabilities | |
36 | 'fetch', 'option', and 'push'. | |
6eb996b5 | 37 | |
f829a9ea MH |
38 | INVOCATION |
39 | ---------- | |
40 | ||
41 | Remote helper programs are invoked with one or (optionally) two | |
2de9b711 | 42 | arguments. The first argument specifies a remote repository as in Git; |
f829a9ea MH |
43 | it is either the name of a configured remote or a URL. The second |
44 | argument specifies a URL; it is usually of the form | |
45 | '<transport>://<address>', but any arbitrary string is possible. | |
eee7f4a2 | 46 | The `GIT_DIR` environment variable is set up for the remote helper |
f829a9ea | 47 | and can be used to determine where to store additional data or from |
2de9b711 | 48 | which directory to invoke auxiliary Git commands. |
f829a9ea | 49 | |
2de9b711 | 50 | When Git encounters a URL of the form '<transport>://<address>', where |
f829a9ea MH |
51 | '<transport>' is a protocol that it cannot handle natively, it |
52 | automatically invokes 'git remote-<transport>' with the full URL as | |
53 | the second argument. If such a URL is encountered directly on the | |
54 | command line, the first argument is the same as the second, and if it | |
55 | is encountered in a configured remote, the first argument is the name | |
56 | of that remote. | |
57 | ||
2de9b711 | 58 | A URL of the form '<transport>::<address>' explicitly instructs Git to |
f829a9ea MH |
59 | invoke 'git remote-<transport>' with '<address>' as the second |
60 | argument. If such a URL is encountered directly on the command line, | |
61 | the first argument is '<address>', and if it is encountered in a | |
62 | configured remote, the first argument is the name of that remote. | |
63 | ||
ae9f6311 | 64 | Additionally, when a configured remote has `remote.<name>.vcs` set to |
2de9b711 | 65 | '<transport>', Git explicitly invokes 'git remote-<transport>' with |
f829a9ea | 66 | '<name>' as the first argument. If set, the second argument is |
ae9f6311 | 67 | `remote.<name>.url`; otherwise, the second argument is omitted. |
f829a9ea | 68 | |
b4fc8d6a JN |
69 | INPUT FORMAT |
70 | ------------ | |
71 | ||
72 | Git sends the remote helper a list of commands on standard input, one | |
73 | per line. The first command is always the 'capabilities' command, in | |
74 | response to which the remote helper must print a list of the | |
75 | capabilities it supports (see below) followed by a blank line. The | |
76 | response to the capabilities command determines what commands Git uses | |
77 | in the remainder of the command stream. | |
78 | ||
79 | The command stream is terminated by a blank line. In some cases | |
80 | (indicated in the documentation of the relevant commands), this blank | |
81 | line is followed by a payload in some other protocol (e.g., the pack | |
82 | protocol), while in others it indicates the end of input. | |
83 | ||
84 | Capabilities | |
85 | ~~~~~~~~~~~~ | |
86 | ||
87 | Each remote helper is expected to support only a subset of commands. | |
2de9b711 | 88 | The operations a helper supports are declared to Git in the response |
b4fc8d6a JN |
89 | to the `capabilities` command (see COMMANDS, below). |
90 | ||
0673bb28 MH |
91 | In the following, we list all defined capabilities and for |
92 | each we list which commands a helper with that capability | |
93 | must provide. | |
b4b106e5 | 94 | |
b4fc8d6a | 95 | Capabilities for Pushing |
0673bb28 | 96 | ^^^^^^^^^^^^^^^^^^^^^^^^ |
b4fc8d6a JN |
97 | 'connect':: |
98 | Can attempt to connect to 'git receive-pack' (for pushing), | |
0673bb28 MH |
99 | 'git upload-pack', etc for communication using |
100 | git's native packfile protocol. This | |
101 | requires a bidirectional, full-duplex connection. | |
b4fc8d6a JN |
102 | + |
103 | Supported commands: 'connect'. | |
104 | ||
edc9caf7 BW |
105 | 'stateless-connect':: |
106 | Experimental; for internal use only. | |
107 | Can attempt to connect to a remote server for communication | |
108 | using git's wire-protocol version 2. See the documentation | |
109 | for the stateless-connect command for more information. | |
110 | + | |
111 | Supported commands: 'stateless-connect'. | |
112 | ||
b4fc8d6a JN |
113 | 'push':: |
114 | Can discover remote refs and push local commits and the | |
115 | history leading up to them to new or existing remote refs. | |
116 | + | |
117 | Supported commands: 'list for-push', 'push'. | |
118 | ||
b4b106e5 MH |
119 | 'export':: |
120 | Can discover remote refs and push specified objects from a | |
121 | fast-import stream to remote refs. | |
122 | + | |
123 | Supported commands: 'list for-push', 'export'. | |
124 | ||
2de9b711 | 125 | If a helper advertises 'connect', Git will use it if possible and |
b4b106e5 MH |
126 | fall back to another capability if the helper requests so when |
127 | connecting (see the 'connect' command under COMMANDS). | |
2de9b711 | 128 | When choosing between 'push' and 'export', Git prefers 'push'. |
b4b106e5 MH |
129 | Other frontends may have some other order of preference. |
130 | ||
597b831a MM |
131 | 'no-private-update':: |
132 | When using the 'refspec' capability, git normally updates the | |
133 | private ref on successful push. This update is disabled when | |
134 | the remote-helper declares the capability 'no-private-update'. | |
135 | ||
b4fc8d6a JN |
136 | |
137 | Capabilities for Fetching | |
0673bb28 | 138 | ^^^^^^^^^^^^^^^^^^^^^^^^^ |
b4fc8d6a JN |
139 | 'connect':: |
140 | Can try to connect to 'git upload-pack' (for fetching), | |
141 | 'git receive-pack', etc for communication using the | |
2de9b711 | 142 | Git's native packfile protocol. This |
0673bb28 | 143 | requires a bidirectional, full-duplex connection. |
b4fc8d6a JN |
144 | + |
145 | Supported commands: 'connect'. | |
146 | ||
edc9caf7 BW |
147 | 'stateless-connect':: |
148 | Experimental; for internal use only. | |
149 | Can attempt to connect to a remote server for communication | |
150 | using git's wire-protocol version 2. See the documentation | |
151 | for the stateless-connect command for more information. | |
152 | + | |
153 | Supported commands: 'stateless-connect'. | |
154 | ||
b4fc8d6a JN |
155 | 'fetch':: |
156 | Can discover remote refs and transfer objects reachable from | |
157 | them to the local object store. | |
158 | + | |
159 | Supported commands: 'list', 'fetch'. | |
160 | ||
161 | 'import':: | |
162 | Can discover remote refs and output objects reachable from | |
163 | them as a stream in fast-import format. | |
164 | + | |
165 | Supported commands: 'list', 'import'. | |
166 | ||
9ba38048 NTND |
167 | 'check-connectivity':: |
168 | Can guarantee that when a clone is requested, the received | |
169 | pack is self contained and is connected. | |
170 | ||
b5624a44 DS |
171 | 'get':: |
172 | Can use the 'get' command to download a file from a given URI. | |
173 | ||
2de9b711 | 174 | If a helper advertises 'connect', Git will use it if possible and |
b4fc8d6a JN |
175 | fall back to another capability if the helper requests so when |
176 | connecting (see the 'connect' command under COMMANDS). | |
2de9b711 | 177 | When choosing between 'fetch' and 'import', Git prefers 'fetch'. |
b4fc8d6a JN |
178 | Other frontends may have some other order of preference. |
179 | ||
0673bb28 MH |
180 | Miscellaneous capabilities |
181 | ^^^^^^^^^^^^^^^^^^^^^^^^^^ | |
182 | ||
183 | 'option':: | |
184 | For specifying settings like `verbosity` (how much output to | |
185 | write to stderr) and `depth` (how much history is wanted in the | |
186 | case of a shallow clone) that affect how other commands are | |
187 | carried out. | |
188 | ||
b4fc8d6a | 189 | 'refspec' <refspec>:: |
bb0a5cc9 FC |
190 | For remote helpers that implement 'import' or 'export', this capability |
191 | allows the refs to be constrained to a private namespace, instead of | |
192 | writing to refs/heads or refs/remotes directly. | |
0673bb28 | 193 | It is recommended that all importers providing the 'import' |
21610d82 | 194 | capability use this. It's mandatory for 'export'. |
b4fc8d6a | 195 | + |
0673bb28 | 196 | A helper advertising the capability |
6cf378f0 | 197 | `refspec refs/heads/*:refs/svn/origin/branches/*` |
0673bb28 MH |
198 | is saying that, when it is asked to `import refs/heads/topic`, the |
199 | stream it outputs will update the `refs/svn/origin/branches/topic` | |
200 | ref. | |
b4fc8d6a JN |
201 | + |
202 | This capability can be advertised multiple times. The first | |
203 | applicable refspec takes precedence. The left-hand of refspecs | |
204 | advertised with this capability must cover all refs reported by | |
7a43c554 FC |
205 | the list command. If no 'refspec' capability is advertised, |
206 | there is an implied `refspec *:*`. | |
3f36eb43 MM |
207 | + |
208 | When writing remote-helpers for decentralized version control | |
209 | systems, it is advised to keep a local copy of the repository to | |
210 | interact with, and to let the private namespace refs point to this | |
211 | local repository, while the refs/remotes namespace is used to track | |
212 | the remote repository. | |
b4fc8d6a | 213 | |
0673bb28 MH |
214 | 'bidi-import':: |
215 | This modifies the 'import' capability. | |
216 | The fast-import commands 'cat-blob' and 'ls' can be used by remote-helpers | |
217 | to retrieve information about blobs and trees that already exist in | |
218 | fast-import's memory. This requires a channel from fast-import to the | |
219 | remote-helper. | |
2de9b711 | 220 | If it is advertised in addition to "import", Git establishes a pipe from |
0673bb28 | 221 | fast-import to the remote-helper's stdin. |
2de9b711 TA |
222 | It follows that Git and fast-import are both connected to the |
223 | remote-helper's stdin. Because Git can send multiple commands to | |
0673bb28 MH |
224 | the remote-helper it is required that helpers that use 'bidi-import' |
225 | buffer all 'import' commands of a batch before sending data to fast-import. | |
226 | This is to prevent mixing commands and fast-import responses on the | |
227 | helper's stdin. | |
228 | ||
229 | 'export-marks' <file>:: | |
2de9b711 | 230 | This modifies the 'export' capability, instructing Git to dump the |
0673bb28 | 231 | internal marks table to <file> when complete. For details, |
bcf9626a | 232 | read up on `--export-marks=<file>` in linkgit:git-fast-export[1]. |
0673bb28 MH |
233 | |
234 | 'import-marks' <file>:: | |
2de9b711 | 235 | This modifies the 'export' capability, instructing Git to load the |
0673bb28 | 236 | marks specified in <file> before processing any input. For details, |
bcf9626a | 237 | read up on `--import-marks=<file>` in linkgit:git-fast-export[1]. |
0673bb28 | 238 | |
0d957a4d JK |
239 | 'signed-tags':: |
240 | This modifies the 'export' capability, instructing Git to pass | |
bcf9626a MM |
241 | `--signed-tags=verbatim` to linkgit:git-fast-export[1]. In the |
242 | absence of this capability, Git will use `--signed-tags=warn-strip`. | |
0673bb28 | 243 | |
452e3568 | 244 | 'object-format':: |
245 | This indicates that the helper is able to interact with the remote | |
246 | side using an explicit hash algorithm extension. | |
0673bb28 MH |
247 | |
248 | ||
6eb996b5 DB |
249 | COMMANDS |
250 | -------- | |
251 | ||
252 | Commands are given by the caller on the helper's standard input, one per line. | |
253 | ||
254 | 'capabilities':: | |
255 | Lists the capabilities of the helper, one per line, ending | |
d43427d3 | 256 | with a blank line. Each capability may be preceded with '*', |
2de9b711 | 257 | which marks them mandatory for Git versions using the remote |
b20c457a MH |
258 | helper to understand. Any unknown mandatory capability is a |
259 | fatal error. | |
754cb1ae MH |
260 | + |
261 | Support for this command is mandatory. | |
6eb996b5 DB |
262 | |
263 | 'list':: | |
264 | Lists the refs, one per line, in the format "<value> <name> | |
265 | [<attr> ...]". The value may be a hex sha1 hash, "@<dest>" for | |
452e3568 | 266 | a symref, ":<keyword> <value>" for a key-value pair, or |
267 | "?" to indicate that the helper could not get the value of the | |
268 | ref. A space-separated list of attributes follows the name; | |
269 | unrecognized attributes are ignored. The list ends with a | |
270 | blank line. | |
ae4efe19 | 271 | + |
9ec8bcda | 272 | See REF LIST ATTRIBUTES for a list of currently defined attributes. |
452e3568 | 273 | See REF LIST KEYWORDS for a list of currently defined keywords. |
9ec8bcda | 274 | + |
754cb1ae MH |
275 | Supported if the helper has the "fetch" or "import" capability. |
276 | ||
277 | 'list for-push':: | |
278 | Similar to 'list', except that it is used if and only if | |
279 | the caller wants to the resulting ref list to prepare | |
280 | push commands. | |
281 | A helper supporting both push and fetch can use this | |
282 | to distinguish for which operation the output of 'list' | |
283 | is going to be used, possibly reducing the amount | |
284 | of work that needs to be performed. | |
285 | + | |
286 | Supported if the helper has the "push" or "export" capability. | |
6eb996b5 | 287 | |
ef08ef9e | 288 | 'option' <name> <value>:: |
d43427d3 | 289 | Sets the transport helper option <name> to <value>. Outputs a |
ef08ef9e SP |
290 | single line containing one of 'ok' (option successfully set), |
291 | 'unsupported' (option not recognized) or 'error <msg>' | |
d43427d3 | 292 | (option <name> is supported but <value> is not valid |
ef08ef9e | 293 | for it). Options should be set before other commands, |
d43427d3 | 294 | and may influence the behavior of those commands. |
ef08ef9e | 295 | + |
9ec8bcda MH |
296 | See OPTIONS for a list of currently defined options. |
297 | + | |
ef08ef9e | 298 | Supported if the helper has the "option" capability. |
6eb996b5 DB |
299 | |
300 | 'fetch' <sha1> <name>:: | |
292ce46b SP |
301 | Fetches the given object, writing the necessary objects |
302 | to the database. Fetch commands are sent in a batch, one | |
d43427d3 | 303 | per line, terminated with a blank line. |
292ce46b SP |
304 | Outputs a single blank line when all fetch commands in the |
305 | same batch are complete. Only objects which were reported | |
9ec8bcda | 306 | in the output of 'list' with a sha1 may be fetched this way. |
292ce46b | 307 | + |
0a8bc706 DT |
308 | Optionally may output a 'lock <file>' line indicating the full path of |
309 | a file under `$GIT_DIR/objects/pack` which is keeping a pack until | |
310 | refs can be suitably updated. The path must end with `.keep`. This is | |
311 | a mechanism to name a <pack,idx,keep> tuple by giving only the keep | |
312 | component. The kept pack will not be deleted by a concurrent repack, | |
313 | even though its objects may not be referenced until the fetch completes. | |
314 | The `.keep` file will be deleted at the conclusion of the fetch. | |
6eb996b5 | 315 | + |
9ba38048 NTND |
316 | If option 'check-connectivity' is requested, the helper must output |
317 | 'connectivity-ok' if the clone is self-contained and connected. | |
318 | + | |
6eb996b5 DB |
319 | Supported if the helper has the "fetch" capability. |
320 | ||
ae4efe19 | 321 | 'push' +<src>:<dst>:: |
d43427d3 | 322 | Pushes the given local <src> commit or branch to the |
ae4efe19 | 323 | remote branch described by <dst>. A batch sequence of |
960e3114 MM |
324 | one or more 'push' commands is terminated with a blank line |
325 | (if there is only one reference to push, a single 'push' command | |
326 | is followed by a blank line). For example, the following would | |
327 | be two batches of 'push', the first asking the remote-helper | |
328 | to push the local ref 'master' to the remote ref 'master' and | |
661c3e9b | 329 | the local `HEAD` to the remote 'branch', and the second |
960e3114 MM |
330 | asking to push ref 'foo' to ref 'bar' (forced update requested |
331 | by the '+'). | |
332 | + | |
333 | ------------ | |
334 | push refs/heads/master:refs/heads/master | |
335 | push HEAD:refs/heads/branch | |
336 | \n | |
337 | push +refs/heads/foo:refs/heads/bar | |
338 | \n | |
339 | ------------ | |
ae4efe19 SP |
340 | + |
341 | Zero or more protocol options may be entered after the last 'push' | |
342 | command, before the batch's terminating blank line. | |
343 | + | |
344 | When the push is complete, outputs one or more 'ok <dst>' or | |
345 | 'error <dst> <why>?' lines to indicate success or failure of | |
346 | each pushed ref. The status report output is terminated by | |
347 | a blank line. The option field <why> may be quoted in a C | |
348 | style string if it contains an LF. | |
349 | + | |
350 | Supported if the helper has the "push" capability. | |
351 | ||
e65e91ed DB |
352 | 'import' <name>:: |
353 | Produces a fast-import stream which imports the current value | |
354 | of the named ref. It may additionally import other refs as | |
72ff8943 DB |
355 | needed to construct the history efficiently. The script writes |
356 | to a helper-specific private namespace. The value of the named | |
357 | ref should be written to a location in this namespace derived | |
358 | by applying the refspecs from the "refspec" capability to the | |
359 | name of the ref. | |
e65e91ed | 360 | + |
d43427d3 RR |
361 | Especially useful for interoperability with a foreign versioning |
362 | system. | |
363 | + | |
960e3114 MM |
364 | Just like 'push', a batch sequence of one or more 'import' is |
365 | terminated with a blank line. For each batch of 'import', the remote | |
366 | helper should produce a fast-import stream terminated by a 'done' | |
367 | command. | |
368 | + | |
271bfd67 FA |
369 | Note that if the 'bidi-import' capability is used the complete batch |
370 | sequence has to be buffered before starting to send data to fast-import | |
371 | to prevent mixing of commands and fast-import responses on the helper's | |
372 | stdin. | |
373 | + | |
754cb1ae | 374 | Supported if the helper has the "import" capability. |
e65e91ed | 375 | |
b4b106e5 MH |
376 | 'export':: |
377 | Instructs the remote helper that any subsequent input is | |
378 | part of a fast-import stream (generated by 'git fast-export') | |
379 | containing objects which should be pushed to the remote. | |
380 | + | |
381 | Especially useful for interoperability with a foreign versioning | |
382 | system. | |
383 | + | |
384 | The 'export-marks' and 'import-marks' capabilities, if specified, | |
385 | affect this command in so far as they are passed on to 'git | |
386 | fast-export', which then will load/store a table of marks for | |
387 | local objects. This can be used to implement for incremental | |
388 | operations. | |
389 | + | |
754cb1ae | 390 | Supported if the helper has the "export" capability. |
b4b106e5 | 391 | |
fa8c097c IL |
392 | 'connect' <service>:: |
393 | Connects to given service. Standard input and standard output | |
394 | of helper are connected to specified service (git prefix is | |
395 | included in service name so e.g. fetching uses 'git-upload-pack' | |
396 | as service) on remote side. Valid replies to this command are | |
397 | empty line (connection established), 'fallback' (no smart | |
398 | transport support, fall back to dumb transports) and just | |
399 | exiting with error message printed (can't connect, don't | |
400 | bother trying to fall back). After line feed terminating the | |
401 | positive (empty) response, the output of service starts. After | |
402 | the connection ends, the remote helper exits. | |
403 | + | |
404 | Supported if the helper has the "connect" capability. | |
405 | ||
edc9caf7 BW |
406 | 'stateless-connect' <service>:: |
407 | Experimental; for internal use only. | |
408 | Connects to the given remote service for communication using | |
409 | git's wire-protocol version 2. Valid replies to this command | |
410 | are empty line (connection established), 'fallback' (no smart | |
411 | transport support, fall back to dumb transports) and just | |
412 | exiting with error message printed (can't connect, don't bother | |
413 | trying to fall back). After line feed terminating the positive | |
414 | (empty) response, the output of the service starts. Messages | |
415 | (both request and response) must consist of zero or more | |
b0df0c16 DL |
416 | PKT-LINEs, terminating in a flush packet. Response messages will |
417 | then have a response end packet after the flush packet to | |
418 | indicate the end of a response. The client must not | |
edc9caf7 BW |
419 | expect the server to store any state in between request-response |
420 | pairs. After the connection ends, the remote helper exits. | |
421 | + | |
422 | Supported if the helper has the "stateless-connect" capability. | |
423 | ||
b5624a44 DS |
424 | 'get' <uri> <path>:: |
425 | Downloads the file from the given `<uri>` to the given `<path>`. If | |
426 | `<path>.temp` exists, then Git assumes that the `.temp` file is a | |
427 | partial download from a previous attempt and will resume the | |
428 | download from that position. | |
429 | ||
6eb996b5 DB |
430 | If a fatal error occurs, the program writes the error message to |
431 | stderr and exits. The caller should expect that a suitable error | |
432 | message has been printed if the child closes the connection without | |
433 | completing a valid response for the current command. | |
434 | ||
435 | Additional commands may be supported, as may be determined from | |
436 | capabilities reported by the helper. | |
437 | ||
6eb996b5 DB |
438 | REF LIST ATTRIBUTES |
439 | ------------------- | |
440 | ||
9ec8bcda MH |
441 | The 'list' command produces a list of refs in which each ref |
442 | may be followed by a list of attributes. The following ref list | |
443 | attributes are defined. | |
6eb996b5 | 444 | |
f8ec9167 DB |
445 | 'unchanged':: |
446 | This ref is unchanged since the last import or fetch, although | |
447 | the helper cannot necessarily determine what value that produced. | |
6eb996b5 | 448 | |
452e3568 | 449 | REF LIST KEYWORDS |
450 | ----------------- | |
451 | ||
452 | The 'list' command may produce a list of key-value pairs. | |
453 | The following keys are defined. | |
454 | ||
455 | 'object-format':: | |
456 | The refs are using the given hash algorithm. This keyword is only | |
457 | used if the server and client both support the object-format | |
458 | extension. | |
459 | ||
460 | ||
ef08ef9e SP |
461 | OPTIONS |
462 | ------- | |
9ec8bcda MH |
463 | |
464 | The following options are defined and (under suitable circumstances) | |
2de9b711 | 465 | set by Git if the remote helper has the 'option' capability. |
9ec8bcda | 466 | |
3b0d2405 | 467 | 'option verbosity' <n>:: |
d43427d3 | 468 | Changes the verbosity of messages displayed by the helper. |
3b0d2405 | 469 | A value of 0 for <n> means that processes operate |
d43427d3 RR |
470 | quietly, and the helper produces only error output. |
471 | 1 is the default level of verbosity, and higher values | |
3b0d2405 | 472 | of <n> correspond to the number of -v flags passed on the |
ef08ef9e SP |
473 | command line. |
474 | ||
4538a882 | 475 | 'option progress' {'true'|'false'}:: |
d43427d3 | 476 | Enables (or disables) progress messages displayed by the |
ef08ef9e SP |
477 | transport helper during a command. |
478 | ||
479 | 'option depth' <depth>:: | |
d43427d3 | 480 | Deepens the history of a shallow repository. |
ef08ef9e | 481 | |
9dc75d81 | 482 | 'option deepen-since' <timestamp>:: |
508ea882 NTND |
483 | Deepens the history of a shallow repository based on time. |
484 | ||
9dc75d81 | 485 | 'option deepen-not' <ref>:: |
a45a2600 NTND |
486 | Deepens the history of a shallow repository excluding ref. |
487 | Multiple options add up. | |
488 | ||
9dc75d81 | 489 | 'option deepen-relative' {'true'|'false'}:: |
cccf74e2 NTND |
490 | Deepens the history of a shallow repository relative to |
491 | current boundary. Only valid when used with "option depth". | |
492 | ||
4538a882 | 493 | 'option followtags' {'true'|'false'}:: |
ef08ef9e SP |
494 | If enabled the helper should automatically fetch annotated |
495 | tag objects if the object the tag points at was transferred | |
496 | during the fetch command. If the tag is not fetched by | |
497 | the helper a second fetch command will usually be sent to | |
498 | ask for the tag specifically. Some helpers may be able to | |
499 | use this option to avoid a second network connection. | |
500 | ||
4538a882 | 501 | 'option dry-run' {'true'|'false'}: |
ae4efe19 | 502 | If true, pretend the operation completed successfully, |
8d75a1d1 | 503 | but don't actually change any repository data. For most |
ae4efe19 SP |
504 | helpers this only applies to the 'push', if supported. |
505 | ||
fa8c097c | 506 | 'option servpath <c-style-quoted-path>':: |
d43427d3 RR |
507 | Sets service path (--upload-pack, --receive-pack etc.) for |
508 | next connect. Remote helper may support this option, but | |
509 | must not rely on this option being set before | |
fa8c097c IL |
510 | connect request occurs. |
511 | ||
4538a882 | 512 | 'option check-connectivity' {'true'|'false'}:: |
9ba38048 NTND |
513 | Request the helper to check connectivity of a clone. |
514 | ||
4538a882 | 515 | 'option force' {'true'|'false'}:: |
510fa6f5 FC |
516 | Request the helper to perform a force update. Defaults to |
517 | 'false'. | |
518 | ||
2aaf37b6 | 519 | 'option cloning' {'true'|'false'}:: |
16094885 NTND |
520 | Notify the helper this is a clone request (i.e. the current |
521 | repository is guaranteed empty). | |
522 | ||
2aaf37b6 | 523 | 'option update-shallow' {'true'|'false'}:: |
16094885 NTND |
524 | Allow to extend .git/shallow if the new refs require it. |
525 | ||
2aaf37b6 | 526 | 'option pushcert' {'true'|'false'}:: |
b9299a2b DB |
527 | GPG sign pushes. |
528 | ||
51d41dc2 | 529 | 'option push-option' <string>:: |
5621760f | 530 | Transmit <string> as a push option. As the push option |
438fc684 SB |
531 | must not contain LF or NUL characters, the string is not encoded. |
532 | ||
88e2f9ed JT |
533 | 'option from-promisor' {'true'|'false'}:: |
534 | Indicate that these objects are being fetched from a promisor. | |
535 | ||
536 | 'option no-dependents' {'true'|'false'}:: | |
537 | Indicate that only the objects wanted need to be fetched, not | |
538 | their dependents. | |
539 | ||
6f119424 | 540 | 'option atomic' {'true'|'false'}:: |
541 | When pushing, request the remote server to update refs in a single atomic | |
542 | transaction. If successful, all refs will be updated, or none will. If the | |
543 | remote side does not support this capability, the push will fail. | |
544 | ||
d6f6b433 JK |
545 | 'option object-format true':: |
546 | Indicate that the caller wants hash algorithm information | |
452e3568 | 547 | to be passed back from the remote. This mode is used when fetching |
548 | refs. | |
452e3568 | 549 | |
b6c8d2d6 RR |
550 | SEE ALSO |
551 | -------- | |
552 | linkgit:git-remote[1] | |
553 | ||
26726718 MH |
554 | linkgit:git-remote-ext[1] |
555 | ||
556 | linkgit:git-remote-fd[1] | |
557 | ||
26726718 MH |
558 | linkgit:git-fast-import[1] |
559 | ||
6eb996b5 DB |
560 | GIT |
561 | --- | |
562 | Part of the linkgit:git[1] suite |