6 git - the stupid content tracker
12 'git' [--version] [--help] [-C <path>] [-c <name>=<value>]
13 [--exec-path[=<path>]] [--html-path] [--man-path] [--info-path]
14 [-p|--paginate|--no-pager] [--no-replace-objects] [--bare]
15 [--git-dir=<path>] [--work-tree=<path>] [--namespace=<name>]
20 Git is a fast, scalable, distributed revision control system with an
21 unusually rich command set that provides both high-level operations
22 and full access to internals.
24 See linkgit:gittutorial[7] to get started, then see
25 linkgit:giteveryday[7] for a useful minimum set of
26 commands. The link:user-manual.html[Git User's Manual] has a more
27 in-depth introduction.
29 After you mastered the basic concepts, you can come back to this
30 page to learn what commands Git offers. You can learn more about
31 individual Git commands with "git help command". linkgit:gitcli[7]
32 manual page gives you an overview of the command-line command syntax.
34 Formatted and hyperlinked version of the latest Git documentation
35 can be viewed at `http://git-htmldocs.googlecode.com/git/git.html`.
41 You are reading the documentation for the latest (possibly
42 unreleased) version of Git, that is available from the 'master'
43 branch of the `git.git` repository.
44 Documentation for older releases are available here:
46 * link:v2.1.0/git.html[documentation for release 2.1]
49 link:RelNotes/2.1.0.txt[2.1].
51 * link:v2.0.4/git.html[documentation for release 2.0.4]
54 link:RelNotes/2.0.4.txt[2.0.4],
55 link:RelNotes/2.0.3.txt[2.0.3],
56 link:RelNotes/2.0.2.txt[2.0.2],
57 link:RelNotes/2.0.1.txt[2.0.1],
58 link:RelNotes/2.0.0.txt[2.0.0].
60 * link:v1.9.4/git.html[documentation for release 1.9.4]
63 link:RelNotes/1.9.4.txt[1.9.4],
64 link:RelNotes/1.9.3.txt[1.9.3],
65 link:RelNotes/1.9.2.txt[1.9.2],
66 link:RelNotes/1.9.1.txt[1.9.1],
67 link:RelNotes/1.9.0.txt[1.9.0].
69 * link:v1.8.5.5/git.html[documentation for release 1.8.5.5]
72 link:RelNotes/1.8.5.5.txt[1.8.5.5],
73 link:RelNotes/1.8.5.4.txt[1.8.5.4],
74 link:RelNotes/1.8.5.3.txt[1.8.5.3],
75 link:RelNotes/1.8.5.2.txt[1.8.5.2],
76 link:RelNotes/1.8.5.1.txt[1.8.5.1],
77 link:RelNotes/1.8.5.txt[1.8.5].
79 * link:v1.8.4.5/git.html[documentation for release 1.8.4.5]
82 link:RelNotes/1.8.4.5.txt[1.8.4.5],
83 link:RelNotes/1.8.4.4.txt[1.8.4.4],
84 link:RelNotes/1.8.4.3.txt[1.8.4.3],
85 link:RelNotes/1.8.4.2.txt[1.8.4.2],
86 link:RelNotes/1.8.4.1.txt[1.8.4.1],
87 link:RelNotes/1.8.4.txt[1.8.4].
89 * link:v1.8.3.4/git.html[documentation for release 1.8.3.4]
92 link:RelNotes/1.8.3.4.txt[1.8.3.4],
93 link:RelNotes/1.8.3.3.txt[1.8.3.3],
94 link:RelNotes/1.8.3.2.txt[1.8.3.2],
95 link:RelNotes/1.8.3.1.txt[1.8.3.1],
96 link:RelNotes/1.8.3.txt[1.8.3].
98 * link:v1.8.2.3/git.html[documentation for release 1.8.2.3]
101 link:RelNotes/1.8.2.3.txt[1.8.2.3],
102 link:RelNotes/1.8.2.2.txt[1.8.2.2],
103 link:RelNotes/1.8.2.1.txt[1.8.2.1],
104 link:RelNotes/1.8.2.txt[1.8.2].
106 * link:v1.8.1.6/git.html[documentation for release 1.8.1.6]
109 link:RelNotes/1.8.1.6.txt[1.8.1.6],
110 link:RelNotes/1.8.1.5.txt[1.8.1.5],
111 link:RelNotes/1.8.1.4.txt[1.8.1.4],
112 link:RelNotes/1.8.1.3.txt[1.8.1.3],
113 link:RelNotes/1.8.1.2.txt[1.8.1.2],
114 link:RelNotes/1.8.1.1.txt[1.8.1.1],
115 link:RelNotes/1.8.1.txt[1.8.1].
117 * link:v1.8.0.3/git.html[documentation for release 1.8.0.3]
120 link:RelNotes/1.8.0.3.txt[1.8.0.3],
121 link:RelNotes/1.8.0.2.txt[1.8.0.2],
122 link:RelNotes/1.8.0.1.txt[1.8.0.1],
123 link:RelNotes/1.8.0.txt[1.8.0].
125 * link:v1.7.12.4/git.html[documentation for release 1.7.12.4]
128 link:RelNotes/1.7.12.4.txt[1.7.12.4],
129 link:RelNotes/1.7.12.3.txt[1.7.12.3],
130 link:RelNotes/1.7.12.2.txt[1.7.12.2],
131 link:RelNotes/1.7.12.1.txt[1.7.12.1],
132 link:RelNotes/1.7.12.txt[1.7.12].
134 * link:v1.7.11.7/git.html[documentation for release 1.7.11.7]
137 link:RelNotes/1.7.11.7.txt[1.7.11.7],
138 link:RelNotes/1.7.11.6.txt[1.7.11.6],
139 link:RelNotes/1.7.11.5.txt[1.7.11.5],
140 link:RelNotes/1.7.11.4.txt[1.7.11.4],
141 link:RelNotes/1.7.11.3.txt[1.7.11.3],
142 link:RelNotes/1.7.11.2.txt[1.7.11.2],
143 link:RelNotes/1.7.11.1.txt[1.7.11.1],
144 link:RelNotes/1.7.11.txt[1.7.11].
146 * link:v1.7.10.5/git.html[documentation for release 1.7.10.5]
149 link:RelNotes/1.7.10.5.txt[1.7.10.5],
150 link:RelNotes/1.7.10.4.txt[1.7.10.4],
151 link:RelNotes/1.7.10.3.txt[1.7.10.3],
152 link:RelNotes/1.7.10.2.txt[1.7.10.2],
153 link:RelNotes/1.7.10.1.txt[1.7.10.1],
154 link:RelNotes/1.7.10.txt[1.7.10].
156 * link:v1.7.9.7/git.html[documentation for release 1.7.9.7]
159 link:RelNotes/1.7.9.7.txt[1.7.9.7],
160 link:RelNotes/1.7.9.6.txt[1.7.9.6],
161 link:RelNotes/1.7.9.5.txt[1.7.9.5],
162 link:RelNotes/1.7.9.4.txt[1.7.9.4],
163 link:RelNotes/1.7.9.3.txt[1.7.9.3],
164 link:RelNotes/1.7.9.2.txt[1.7.9.2],
165 link:RelNotes/1.7.9.1.txt[1.7.9.1],
166 link:RelNotes/1.7.9.txt[1.7.9].
168 * link:v1.7.8.6/git.html[documentation for release 1.7.8.6]
171 link:RelNotes/1.7.8.6.txt[1.7.8.6],
172 link:RelNotes/1.7.8.5.txt[1.7.8.5],
173 link:RelNotes/1.7.8.4.txt[1.7.8.4],
174 link:RelNotes/1.7.8.3.txt[1.7.8.3],
175 link:RelNotes/1.7.8.2.txt[1.7.8.2],
176 link:RelNotes/1.7.8.1.txt[1.7.8.1],
177 link:RelNotes/1.7.8.txt[1.7.8].
179 * link:v1.7.7.7/git.html[documentation for release 1.7.7.7]
182 link:RelNotes/1.7.7.7.txt[1.7.7.7],
183 link:RelNotes/1.7.7.6.txt[1.7.7.6],
184 link:RelNotes/1.7.7.5.txt[1.7.7.5],
185 link:RelNotes/1.7.7.4.txt[1.7.7.4],
186 link:RelNotes/1.7.7.3.txt[1.7.7.3],
187 link:RelNotes/1.7.7.2.txt[1.7.7.2],
188 link:RelNotes/1.7.7.1.txt[1.7.7.1],
189 link:RelNotes/1.7.7.txt[1.7.7].
191 * link:v1.7.6.6/git.html[documentation for release 1.7.6.6]
194 link:RelNotes/1.7.6.6.txt[1.7.6.6],
195 link:RelNotes/1.7.6.5.txt[1.7.6.5],
196 link:RelNotes/1.7.6.4.txt[1.7.6.4],
197 link:RelNotes/1.7.6.3.txt[1.7.6.3],
198 link:RelNotes/1.7.6.2.txt[1.7.6.2],
199 link:RelNotes/1.7.6.1.txt[1.7.6.1],
200 link:RelNotes/1.7.6.txt[1.7.6].
202 * link:v1.7.5.4/git.html[documentation for release 1.7.5.4]
205 link:RelNotes/1.7.5.4.txt[1.7.5.4],
206 link:RelNotes/1.7.5.3.txt[1.7.5.3],
207 link:RelNotes/1.7.5.2.txt[1.7.5.2],
208 link:RelNotes/1.7.5.1.txt[1.7.5.1],
209 link:RelNotes/1.7.5.txt[1.7.5].
211 * link:v1.7.4.5/git.html[documentation for release 1.7.4.5]
214 link:RelNotes/1.7.4.5.txt[1.7.4.5],
215 link:RelNotes/1.7.4.4.txt[1.7.4.4],
216 link:RelNotes/1.7.4.3.txt[1.7.4.3],
217 link:RelNotes/1.7.4.2.txt[1.7.4.2],
218 link:RelNotes/1.7.4.1.txt[1.7.4.1],
219 link:RelNotes/1.7.4.txt[1.7.4].
221 * link:v1.7.3.5/git.html[documentation for release 1.7.3.5]
224 link:RelNotes/1.7.3.5.txt[1.7.3.5],
225 link:RelNotes/1.7.3.4.txt[1.7.3.4],
226 link:RelNotes/1.7.3.3.txt[1.7.3.3],
227 link:RelNotes/1.7.3.2.txt[1.7.3.2],
228 link:RelNotes/1.7.3.1.txt[1.7.3.1],
229 link:RelNotes/1.7.3.txt[1.7.3].
231 * link:v1.7.2.5/git.html[documentation for release 1.7.2.5]
234 link:RelNotes/1.7.2.5.txt[1.7.2.5],
235 link:RelNotes/1.7.2.4.txt[1.7.2.4],
236 link:RelNotes/1.7.2.3.txt[1.7.2.3],
237 link:RelNotes/1.7.2.2.txt[1.7.2.2],
238 link:RelNotes/1.7.2.1.txt[1.7.2.1],
239 link:RelNotes/1.7.2.txt[1.7.2].
241 * link:v1.7.1.4/git.html[documentation for release 1.7.1.4]
244 link:RelNotes/1.7.1.4.txt[1.7.1.4],
245 link:RelNotes/1.7.1.3.txt[1.7.1.3],
246 link:RelNotes/1.7.1.2.txt[1.7.1.2],
247 link:RelNotes/1.7.1.1.txt[1.7.1.1],
248 link:RelNotes/1.7.1.txt[1.7.1].
250 * link:v1.7.0.9/git.html[documentation for release 1.7.0.9]
253 link:RelNotes/1.7.0.9.txt[1.7.0.9],
254 link:RelNotes/1.7.0.8.txt[1.7.0.8],
255 link:RelNotes/1.7.0.7.txt[1.7.0.7],
256 link:RelNotes/1.7.0.6.txt[1.7.0.6],
257 link:RelNotes/1.7.0.5.txt[1.7.0.5],
258 link:RelNotes/1.7.0.4.txt[1.7.0.4],
259 link:RelNotes/1.7.0.3.txt[1.7.0.3],
260 link:RelNotes/1.7.0.2.txt[1.7.0.2],
261 link:RelNotes/1.7.0.1.txt[1.7.0.1],
262 link:RelNotes/1.7.0.txt[1.7.0].
264 * link:v1.6.6.3/git.html[documentation for release 1.6.6.3]
267 link:RelNotes/1.6.6.3.txt[1.6.6.3],
268 link:RelNotes/1.6.6.2.txt[1.6.6.2],
269 link:RelNotes/1.6.6.1.txt[1.6.6.1],
270 link:RelNotes/1.6.6.txt[1.6.6].
272 * link:v1.6.5.9/git.html[documentation for release 1.6.5.9]
275 link:RelNotes/1.6.5.9.txt[1.6.5.9],
276 link:RelNotes/1.6.5.8.txt[1.6.5.8],
277 link:RelNotes/1.6.5.7.txt[1.6.5.7],
278 link:RelNotes/1.6.5.6.txt[1.6.5.6],
279 link:RelNotes/1.6.5.5.txt[1.6.5.5],
280 link:RelNotes/1.6.5.4.txt[1.6.5.4],
281 link:RelNotes/1.6.5.3.txt[1.6.5.3],
282 link:RelNotes/1.6.5.2.txt[1.6.5.2],
283 link:RelNotes/1.6.5.1.txt[1.6.5.1],
284 link:RelNotes/1.6.5.txt[1.6.5].
286 * link:v1.6.4.5/git.html[documentation for release 1.6.4.5]
289 link:RelNotes/1.6.4.5.txt[1.6.4.5],
290 link:RelNotes/1.6.4.4.txt[1.6.4.4],
291 link:RelNotes/1.6.4.3.txt[1.6.4.3],
292 link:RelNotes/1.6.4.2.txt[1.6.4.2],
293 link:RelNotes/1.6.4.1.txt[1.6.4.1],
294 link:RelNotes/1.6.4.txt[1.6.4].
296 * link:v1.6.3.4/git.html[documentation for release 1.6.3.4]
299 link:RelNotes/1.6.3.4.txt[1.6.3.4],
300 link:RelNotes/1.6.3.3.txt[1.6.3.3],
301 link:RelNotes/1.6.3.2.txt[1.6.3.2],
302 link:RelNotes/1.6.3.1.txt[1.6.3.1],
303 link:RelNotes/1.6.3.txt[1.6.3].
306 link:RelNotes/1.6.2.5.txt[1.6.2.5],
307 link:RelNotes/1.6.2.4.txt[1.6.2.4],
308 link:RelNotes/1.6.2.3.txt[1.6.2.3],
309 link:RelNotes/1.6.2.2.txt[1.6.2.2],
310 link:RelNotes/1.6.2.1.txt[1.6.2.1],
311 link:RelNotes/1.6.2.txt[1.6.2].
313 * link:v1.6.1.3/git.html[documentation for release 1.6.1.3]
316 link:RelNotes/1.6.1.3.txt[1.6.1.3],
317 link:RelNotes/1.6.1.2.txt[1.6.1.2],
318 link:RelNotes/1.6.1.1.txt[1.6.1.1],
319 link:RelNotes/1.6.1.txt[1.6.1].
321 * link:v1.6.0.6/git.html[documentation for release 1.6.0.6]
324 link:RelNotes/1.6.0.6.txt[1.6.0.6],
325 link:RelNotes/1.6.0.5.txt[1.6.0.5],
326 link:RelNotes/1.6.0.4.txt[1.6.0.4],
327 link:RelNotes/1.6.0.3.txt[1.6.0.3],
328 link:RelNotes/1.6.0.2.txt[1.6.0.2],
329 link:RelNotes/1.6.0.1.txt[1.6.0.1],
330 link:RelNotes/1.6.0.txt[1.6.0].
332 * link:v1.5.6.6/git.html[documentation for release 1.5.6.6]
335 link:RelNotes/1.5.6.6.txt[1.5.6.6],
336 link:RelNotes/1.5.6.5.txt[1.5.6.5],
337 link:RelNotes/1.5.6.4.txt[1.5.6.4],
338 link:RelNotes/1.5.6.3.txt[1.5.6.3],
339 link:RelNotes/1.5.6.2.txt[1.5.6.2],
340 link:RelNotes/1.5.6.1.txt[1.5.6.1],
341 link:RelNotes/1.5.6.txt[1.5.6].
343 * link:v1.5.5.6/git.html[documentation for release 1.5.5.6]
346 link:RelNotes/1.5.5.6.txt[1.5.5.6],
347 link:RelNotes/1.5.5.5.txt[1.5.5.5],
348 link:RelNotes/1.5.5.4.txt[1.5.5.4],
349 link:RelNotes/1.5.5.3.txt[1.5.5.3],
350 link:RelNotes/1.5.5.2.txt[1.5.5.2],
351 link:RelNotes/1.5.5.1.txt[1.5.5.1],
352 link:RelNotes/1.5.5.txt[1.5.5].
354 * link:v1.5.4.7/git.html[documentation for release 1.5.4.7]
357 link:RelNotes/1.5.4.7.txt[1.5.4.7],
358 link:RelNotes/1.5.4.6.txt[1.5.4.6],
359 link:RelNotes/1.5.4.5.txt[1.5.4.5],
360 link:RelNotes/1.5.4.4.txt[1.5.4.4],
361 link:RelNotes/1.5.4.3.txt[1.5.4.3],
362 link:RelNotes/1.5.4.2.txt[1.5.4.2],
363 link:RelNotes/1.5.4.1.txt[1.5.4.1],
364 link:RelNotes/1.5.4.txt[1.5.4].
366 * link:v1.5.3.8/git.html[documentation for release 1.5.3.8]
369 link:RelNotes/1.5.3.8.txt[1.5.3.8],
370 link:RelNotes/1.5.3.7.txt[1.5.3.7],
371 link:RelNotes/1.5.3.6.txt[1.5.3.6],
372 link:RelNotes/1.5.3.5.txt[1.5.3.5],
373 link:RelNotes/1.5.3.4.txt[1.5.3.4],
374 link:RelNotes/1.5.3.3.txt[1.5.3.3],
375 link:RelNotes/1.5.3.2.txt[1.5.3.2],
376 link:RelNotes/1.5.3.1.txt[1.5.3.1],
377 link:RelNotes/1.5.3.txt[1.5.3].
379 * link:v1.5.2.5/git.html[documentation for release 1.5.2.5]
382 link:RelNotes/1.5.2.5.txt[1.5.2.5],
383 link:RelNotes/1.5.2.4.txt[1.5.2.4],
384 link:RelNotes/1.5.2.3.txt[1.5.2.3],
385 link:RelNotes/1.5.2.2.txt[1.5.2.2],
386 link:RelNotes/1.5.2.1.txt[1.5.2.1],
387 link:RelNotes/1.5.2.txt[1.5.2].
389 * link:v1.5.1.6/git.html[documentation for release 1.5.1.6]
392 link:RelNotes/1.5.1.6.txt[1.5.1.6],
393 link:RelNotes/1.5.1.5.txt[1.5.1.5],
394 link:RelNotes/1.5.1.4.txt[1.5.1.4],
395 link:RelNotes/1.5.1.3.txt[1.5.1.3],
396 link:RelNotes/1.5.1.2.txt[1.5.1.2],
397 link:RelNotes/1.5.1.1.txt[1.5.1.1],
398 link:RelNotes/1.5.1.txt[1.5.1].
400 * link:v1.5.0.7/git.html[documentation for release 1.5.0.7]
403 link:RelNotes/1.5.0.7.txt[1.5.0.7],
404 link:RelNotes/1.5.0.6.txt[1.5.0.6],
405 link:RelNotes/1.5.0.5.txt[1.5.0.5],
406 link:RelNotes/1.5.0.3.txt[1.5.0.3],
407 link:RelNotes/1.5.0.2.txt[1.5.0.2],
408 link:RelNotes/1.5.0.1.txt[1.5.0.1],
409 link:RelNotes/1.5.0.txt[1.5.0].
411 * documentation for release link:v1.4.4.4/git.html[1.4.4.4],
412 link:v1.3.3/git.html[1.3.3],
413 link:v1.2.6/git.html[1.2.6],
414 link:v1.0.13/git.html[1.0.13].
423 Prints the Git suite version that the 'git' program came from.
426 Prints the synopsis and a list of the most commonly used
427 commands. If the option '--all' or '-a' is given then all
428 available commands are printed. If a Git command is named this
429 option will bring up the manual page for that command.
431 Other options are available to control how the manual page is
432 displayed. See linkgit:git-help[1] for more information,
433 because `git --help ...` is converted internally into `git
437 Run as if git was started in '<path>' instead of the current working
438 directory. When multiple `-C` options are given, each subsequent
439 non-absolute `-C <path>` is interpreted relative to the preceding `-C
442 This option affects options that expect path name like `--git-dir` and
443 `--work-tree` in that their interpretations of the path names would be
444 made relative to the working directory caused by the `-C` option. For
445 example the following invocations are equivalent:
447 git --git-dir=a.git --work-tree=b -C c status
448 git --git-dir=c/a.git --work-tree=c/b status
451 Pass a configuration parameter to the command. The value
452 given will override values from configuration files.
453 The <name> is expected in the same format as listed by
454 'git config' (subkeys separated by dots).
456 Note that omitting the `=` in `git -c foo.bar ...` is allowed and sets
457 `foo.bar` to the boolean true value (just like `[foo]bar` would in a
458 config file). Including the equals but with an empty value (like `git -c
459 foo.bar= ...`) sets `foo.bar` to the empty string.
461 --exec-path[=<path>]::
462 Path to wherever your core Git programs are installed.
463 This can also be controlled by setting the GIT_EXEC_PATH
464 environment variable. If no path is given, 'git' will print
465 the current setting and then exit.
468 Print the path, without trailing slash, where Git's HTML
469 documentation is installed and exit.
472 Print the manpath (see `man(1)`) for the man pages for
473 this version of Git and exit.
476 Print the path where the Info files documenting this
477 version of Git are installed and exit.
481 Pipe all output into 'less' (or if set, $PAGER) if standard
482 output is a terminal. This overrides the `pager.<cmd>`
483 configuration options (see the "Configuration Mechanism" section
487 Do not pipe Git output into a pager.
490 Set the path to the repository. This can also be controlled by
491 setting the GIT_DIR environment variable. It can be an absolute
492 path or relative path to current working directory.
495 Set the path to the working tree. It can be an absolute path
496 or a path relative to the current working directory.
497 This can also be controlled by setting the GIT_WORK_TREE
498 environment variable and the core.worktree configuration
499 variable (see core.worktree in linkgit:git-config[1] for a
500 more detailed discussion).
503 Set the Git namespace. See linkgit:gitnamespaces[7] for more
504 details. Equivalent to setting the `GIT_NAMESPACE` environment
508 Treat the repository as a bare repository. If GIT_DIR
509 environment is not set, it is set to the current working
512 --no-replace-objects::
513 Do not use replacement refs to replace Git objects. See
514 linkgit:git-replace[1] for more information.
516 --literal-pathspecs::
517 Treat pathspecs literally (i.e. no globbing, no pathspec magic).
518 This is equivalent to setting the `GIT_LITERAL_PATHSPECS` environment
522 Add "glob" magic to all pathspec. This is equivalent to setting
523 the `GIT_GLOB_PATHSPECS` environment variable to `1`. Disabling
524 globbing on individual pathspecs can be done using pathspec
528 Add "literal" magic to all pathspec. This is equivalent to setting
529 the `GIT_NOGLOB_PATHSPECS` environment variable to `1`. Enabling
530 globbing on individual pathspecs can be done using pathspec
534 Add "icase" magic to all pathspec. This is equivalent to setting
535 the `GIT_ICASE_PATHSPECS` environment variable to `1`.
540 We divide Git into high level ("porcelain") commands and low level
541 ("plumbing") commands.
543 High-level commands (porcelain)
544 -------------------------------
546 We separate the porcelain commands into the main commands and some
547 ancillary user utilities.
549 Main porcelain commands
550 ~~~~~~~~~~~~~~~~~~~~~~~
552 include::cmds-mainporcelain.txt[]
558 include::cmds-ancillarymanipulators.txt[]
562 include::cmds-ancillaryinterrogators.txt[]
565 Interacting with Others
566 ~~~~~~~~~~~~~~~~~~~~~~~
568 These commands are to interact with foreign SCM and with other
569 people via patch over e-mail.
571 include::cmds-foreignscminterface.txt[]
574 Low-level commands (plumbing)
575 -----------------------------
577 Although Git includes its
578 own porcelain layer, its low-level commands are sufficient to support
579 development of alternative porcelains. Developers of such porcelains
580 might start by reading about linkgit:git-update-index[1] and
581 linkgit:git-read-tree[1].
583 The interface (input, output, set of options and the semantics)
584 to these low-level commands are meant to be a lot more stable
585 than Porcelain level commands, because these commands are
586 primarily for scripted use. The interface to Porcelain commands
587 on the other hand are subject to change in order to improve the
590 The following description divides
591 the low-level commands into commands that manipulate objects (in
592 the repository, index, and working tree), commands that interrogate and
593 compare objects, and commands that move objects and references between
597 Manipulation commands
598 ~~~~~~~~~~~~~~~~~~~~~
600 include::cmds-plumbingmanipulators.txt[]
603 Interrogation commands
604 ~~~~~~~~~~~~~~~~~~~~~~
606 include::cmds-plumbinginterrogators.txt[]
608 In general, the interrogate commands do not touch the files in
612 Synching repositories
613 ~~~~~~~~~~~~~~~~~~~~~
615 include::cmds-synchingrepositories.txt[]
617 The following are helper commands used by the above; end users
618 typically do not use them directly.
620 include::cmds-synchelpers.txt[]
623 Internal helper commands
624 ~~~~~~~~~~~~~~~~~~~~~~~~
626 These are internal helper commands used by other commands; end
627 users typically do not use them directly.
629 include::cmds-purehelpers.txt[]
632 Configuration Mechanism
633 -----------------------
635 Git uses a simple text format to store customizations that are per
636 repository and are per user. Such a configuration file may look
641 # A '#' or ';' character indicates a comment.
646 ; Don't trust file modes
651 name = "Junio C Hamano"
652 email = "gitster@pobox.com"
656 Various commands read from the configuration file and adjust
657 their operation accordingly. See linkgit:git-config[1] for a
658 list and more details about the configuration mechanism.
661 Identifier Terminology
662 ----------------------
664 Indicates the object name for any type of object.
667 Indicates a blob object name.
670 Indicates a tree object name.
673 Indicates a commit object name.
676 Indicates a tree, commit or tag object name. A
677 command that takes a <tree-ish> argument ultimately wants to
678 operate on a <tree> object but automatically dereferences
679 <commit> and <tag> objects that point at a <tree>.
682 Indicates a commit or tag object name. A
683 command that takes a <commit-ish> argument ultimately wants to
684 operate on a <commit> object but automatically dereferences
685 <tag> objects that point at a <commit>.
688 Indicates that an object type is required.
689 Currently one of: `blob`, `tree`, `commit`, or `tag`.
692 Indicates a filename - almost always relative to the
693 root of the tree structure `GIT_INDEX_FILE` describes.
697 Any Git command accepting any <object> can also use the following
701 indicates the head of the current branch.
705 (i.e. a `refs/tags/<tag>` reference).
709 (i.e. a `refs/heads/<head>` reference).
711 For a more complete list of ways to spell object names, see
712 "SPECIFYING REVISIONS" section in linkgit:gitrevisions[7].
715 File/Directory Structure
716 ------------------------
718 Please see the linkgit:gitrepository-layout[5] document.
720 Read linkgit:githooks[5] for more details about each hook.
722 Higher level SCMs may provide and manage additional information in the
728 Please see linkgit:gitglossary[7].
731 Environment Variables
732 ---------------------
733 Various Git commands use the following environment variables:
737 These environment variables apply to 'all' core Git commands. Nb: it
738 is worth noting that they may be used/overridden by SCMS sitting above
739 Git so take care if using Cogito etc.
742 This environment allows the specification of an alternate
743 index file. If not specified, the default of `$GIT_DIR/index`
746 'GIT_INDEX_VERSION'::
747 This environment variable allows the specification of an index
748 version for new repositories. It won't affect existing index
749 files. By default index file version [23] is used.
751 'GIT_OBJECT_DIRECTORY'::
752 If the object storage directory is specified via this
753 environment variable then the sha1 directories are created
754 underneath - otherwise the default `$GIT_DIR/objects`
757 'GIT_ALTERNATE_OBJECT_DIRECTORIES'::
758 Due to the immutable nature of Git objects, old objects can be
759 archived into shared, read-only directories. This variable
760 specifies a ":" separated (on Windows ";" separated) list
761 of Git object directories which can be used to search for Git
762 objects. New objects will not be written to these directories.
765 If the 'GIT_DIR' environment variable is set then it
766 specifies a path to use instead of the default `.git`
767 for the base of the repository.
768 The '--git-dir' command-line option also sets this value.
771 Set the path to the root of the working tree.
772 This can also be controlled by the '--work-tree' command-line
773 option and the core.worktree configuration variable.
776 Set the Git namespace; see linkgit:gitnamespaces[7] for details.
777 The '--namespace' command-line option also sets this value.
779 'GIT_CEILING_DIRECTORIES'::
780 This should be a colon-separated list of absolute paths. If
781 set, it is a list of directories that Git should not chdir up
782 into while looking for a repository directory (useful for
783 excluding slow-loading network directories). It will not
784 exclude the current working directory or a GIT_DIR set on the
785 command line or in the environment. Normally, Git has to read
786 the entries in this list and resolve any symlink that
787 might be present in order to compare them with the current
788 directory. However, if even this access is slow, you
789 can add an empty entry to the list to tell Git that the
790 subsequent entries are not symlinks and needn't be resolved;
792 'GIT_CEILING_DIRECTORIES=/maybe/symlink::/very/slow/non/symlink'.
794 'GIT_DISCOVERY_ACROSS_FILESYSTEM'::
795 When run in a directory that does not have ".git" repository
796 directory, Git tries to find such a directory in the parent
797 directories to find the top of the working tree, but by default it
798 does not cross filesystem boundaries. This environment variable
799 can be set to true to tell Git not to stop at filesystem
800 boundaries. Like 'GIT_CEILING_DIRECTORIES', this will not affect
801 an explicit repository directory set via 'GIT_DIR' or on the
805 If this variable is set to a path, non-worktree files that are
806 normally in $GIT_DIR will be taken from this path
807 instead. Worktree-specific files such as HEAD or index are
808 taken from $GIT_DIR. See linkgit:gitrepository-layout[5] and
809 the section 'MULTIPLE CHECKOUT MODE' in linkgit:checkout[1]
810 details. This variable has lower precedence than other path
811 variables such as GIT_INDEX_FILE, GIT_OBJECT_DIRECTORY...
818 'GIT_COMMITTER_NAME'::
819 'GIT_COMMITTER_EMAIL'::
820 'GIT_COMMITTER_DATE'::
822 see linkgit:git-commit-tree[1]
827 Only valid setting is "--unified=??" or "-u??" to set the
828 number of context lines shown when a unified diff is created.
829 This takes precedence over any "-U" or "--unified" option
830 value passed on the Git diff command line.
832 'GIT_EXTERNAL_DIFF'::
833 When the environment variable 'GIT_EXTERNAL_DIFF' is set, the
834 program named by it is called, instead of the diff invocation
835 described above. For a path that is added, removed, or modified,
836 'GIT_EXTERNAL_DIFF' is called with 7 parameters:
838 path old-file old-hex old-mode new-file new-hex new-mode
842 <old|new>-file:: are files GIT_EXTERNAL_DIFF can use to read the
843 contents of <old|new>,
844 <old|new>-hex:: are the 40-hexdigit SHA-1 hashes,
845 <old|new>-mode:: are the octal representation of the file modes.
847 The file parameters can point at the user's working file
848 (e.g. `new-file` in "git-diff-files"), `/dev/null` (e.g. `old-file`
849 when a new file is added), or a temporary file (e.g. `old-file` in the
850 index). 'GIT_EXTERNAL_DIFF' should not worry about unlinking the
851 temporary file --- it is removed when 'GIT_EXTERNAL_DIFF' exits.
853 For a path that is unmerged, 'GIT_EXTERNAL_DIFF' is called with 1
856 For each path 'GIT_EXTERNAL_DIFF' is called, two environment variables,
857 'GIT_DIFF_PATH_COUNTER' and 'GIT_DIFF_PATH_TOTAL' are set.
859 'GIT_DIFF_PATH_COUNTER'::
860 A 1-based counter incremented by one for every path.
862 'GIT_DIFF_PATH_TOTAL'::
863 The total number of paths.
867 'GIT_MERGE_VERBOSITY'::
868 A number controlling the amount of output shown by
869 the recursive merge strategy. Overrides merge.verbosity.
870 See linkgit:git-merge[1]
873 This environment variable overrides `$PAGER`. If it is set
874 to an empty string or to the value "cat", Git will not launch
875 a pager. See also the `core.pager` option in
876 linkgit:git-config[1].
879 This environment variable overrides `$EDITOR` and `$VISUAL`.
880 It is used by several Git commands when, on interactive mode,
881 an editor is to be launched. See also linkgit:git-var[1]
882 and the `core.editor` option in linkgit:git-config[1].
885 If this environment variable is set then 'git fetch'
886 and 'git push' will use this command instead
887 of 'ssh' when they need to connect to a remote system.
888 The '$GIT_SSH' command will be given exactly two or
889 four arguments: the 'username@host' (or just 'host')
890 from the URL and the shell command to execute on that
891 remote system, optionally preceded by '-p' (literally) and
892 the 'port' from the URL when it specifies something other
893 than the default SSH port.
895 To pass options to the program that you want to list in GIT_SSH
896 you will need to wrap the program and options into a shell script,
897 then set GIT_SSH to refer to the shell script.
899 Usually it is easier to configure any desired options through your
900 personal `.ssh/config` file. Please consult your ssh documentation
904 If this environment variable is set, then Git commands which need to
905 acquire passwords or passphrases (e.g. for HTTP or IMAP authentication)
906 will call this program with a suitable prompt as command-line argument
907 and read the password from its STDOUT. See also the 'core.askpass'
908 option in linkgit:git-config[1].
910 'GIT_CONFIG_NOSYSTEM'::
911 Whether to skip reading settings from the system-wide
912 `$(prefix)/etc/gitconfig` file. This environment variable can
913 be used along with `$HOME` and `$XDG_CONFIG_HOME` to create a
914 predictable environment for a picky script, or you can set it
915 temporarily to avoid using a buggy `/etc/gitconfig` file while
916 waiting for someone with sufficient permissions to fix it.
919 If this environment variable is set to "1", then commands such
920 as 'git blame' (in incremental mode), 'git rev-list', 'git log',
921 'git check-attr' and 'git check-ignore' will
922 force a flush of the output stream after each record have been
924 variable is set to "0", the output of these commands will be done
925 using completely buffered I/O. If this environment variable is
926 not set, Git will choose buffered or record-oriented flushing
927 based on whether stdout appears to be redirected to a file or not.
930 Enables general trace messages, e.g. alias expansion, built-in
931 command execution and external command execution.
933 If this variable is set to "1", "2" or "true" (comparison
934 is case insensitive), trace messages will be printed to
937 If the variable is set to an integer value greater than 2
938 and lower than 10 (strictly) then Git will interpret this
939 value as an open file descriptor and will try to write the
940 trace messages into this file descriptor.
942 Alternatively, if the variable is set to an absolute path
943 (starting with a '/' character), Git will interpret this
944 as a file path and will try to write the trace messages
947 Unsetting the variable, or setting it to empty, "0" or
948 "false" (case insensitive) disables trace messages.
950 'GIT_TRACE_PACK_ACCESS'::
951 Enables trace messages for all accesses to any packs. For each
952 access, the pack file name and an offset in the pack is
953 recorded. This may be helpful for troubleshooting some
954 pack-related performance problems.
955 See 'GIT_TRACE' for available trace output options.
958 Enables trace messages for all packets coming in or out of a
959 given program. This can help with debugging object negotiation
960 or other protocol issues. Tracing is turned off at a packet
961 starting with "PACK".
962 See 'GIT_TRACE' for available trace output options.
964 'GIT_TRACE_PERFORMANCE'::
965 Enables performance related trace messages, e.g. total execution
966 time of each Git command.
967 See 'GIT_TRACE' for available trace output options.
970 Enables trace messages printing the .git, working tree and current
971 working directory after Git has completed its setup phase.
972 See 'GIT_TRACE' for available trace output options.
974 'GIT_TRACE_SHALLOW'::
975 Enables trace messages that can help debugging fetching /
976 cloning of shallow repositories.
977 See 'GIT_TRACE' for available trace output options.
979 GIT_LITERAL_PATHSPECS::
980 Setting this variable to `1` will cause Git to treat all
981 pathspecs literally, rather than as glob patterns. For example,
982 running `GIT_LITERAL_PATHSPECS=1 git log -- '*.c'` will search
983 for commits that touch the path `*.c`, not any paths that the
984 glob `*.c` matches. You might want this if you are feeding
985 literal paths to Git (e.g., paths previously given to you by
986 `git ls-tree`, `--raw` diff output, etc).
989 Setting this variable to `1` will cause Git to treat all
990 pathspecs as glob patterns (aka "glob" magic).
992 GIT_NOGLOB_PATHSPECS::
993 Setting this variable to `1` will cause Git to treat all
994 pathspecs as literal (aka "literal" magic).
996 GIT_ICASE_PATHSPECS::
997 Setting this variable to `1` will cause Git to treat all
998 pathspecs as case-insensitive.
1000 'GIT_REFLOG_ACTION'::
1001 When a ref is updated, reflog entries are created to keep
1002 track of the reason why the ref was updated (which is
1003 typically the name of the high-level command that updated
1004 the ref), in addition to the old and new values of the ref.
1005 A scripted Porcelain command can use set_reflog_action
1006 helper function in `git-sh-setup` to set its name to this
1007 variable when it is invoked as the top level command by the
1008 end user, to be recorded in the body of the reflog.
1011 Discussion[[Discussion]]
1012 ------------------------
1014 More detail on the following is available from the
1015 link:user-manual.html#git-concepts[Git concepts chapter of the
1016 user-manual] and linkgit:gitcore-tutorial[7].
1018 A Git project normally consists of a working directory with a ".git"
1019 subdirectory at the top level. The .git directory contains, among other
1020 things, a compressed object database representing the complete history
1021 of the project, an "index" file which links that history to the current
1022 contents of the working tree, and named pointers into that history such
1023 as tags and branch heads.
1025 The object database contains objects of three main types: blobs, which
1026 hold file data; trees, which point to blobs and other trees to build up
1027 directory hierarchies; and commits, which each reference a single tree
1028 and some number of parent commits.
1030 The commit, equivalent to what other systems call a "changeset" or
1031 "version", represents a step in the project's history, and each parent
1032 represents an immediately preceding step. Commits with more than one
1033 parent represent merges of independent lines of development.
1035 All objects are named by the SHA-1 hash of their contents, normally
1036 written as a string of 40 hex digits. Such names are globally unique.
1037 The entire history leading up to a commit can be vouched for by signing
1038 just that commit. A fourth object type, the tag, is provided for this
1041 When first created, objects are stored in individual files, but for
1042 efficiency may later be compressed together into "pack files".
1044 Named pointers called refs mark interesting points in history. A ref
1045 may contain the SHA-1 name of an object or the name of another ref. Refs
1046 with names beginning `ref/head/` contain the SHA-1 name of the most
1047 recent commit (or "head") of a branch under development. SHA-1 names of
1048 tags of interest are stored under `ref/tags/`. A special ref named
1049 `HEAD` contains the name of the currently checked-out branch.
1051 The index file is initialized with a list of all paths and, for each
1052 path, a blob object and a set of attributes. The blob object represents
1053 the contents of the file as of the head of the current branch. The
1054 attributes (last modified time, size, etc.) are taken from the
1055 corresponding file in the working tree. Subsequent changes to the
1056 working tree can be found by comparing these attributes. The index may
1057 be updated with new content, and new commits may be created from the
1058 content stored in the index.
1060 The index is also capable of storing multiple entries (called "stages")
1061 for a given pathname. These stages are used to hold the various
1062 unmerged version of a file when a merge is in progress.
1064 FURTHER DOCUMENTATION
1065 ---------------------
1067 See the references in the "description" section to get started
1068 using Git. The following is probably more detail than necessary
1069 for a first-time user.
1071 The link:user-manual.html#git-concepts[Git concepts chapter of the
1072 user-manual] and linkgit:gitcore-tutorial[7] both provide
1073 introductions to the underlying Git architecture.
1075 See linkgit:gitworkflows[7] for an overview of recommended workflows.
1077 See also the link:howto-index.html[howto] documents for some useful
1080 The internals are documented in the
1081 link:technical/api-index.html[Git API documentation].
1083 Users migrating from CVS may also want to
1084 read linkgit:gitcvs-migration[7].
1089 Git was started by Linus Torvalds, and is currently maintained by Junio
1090 C Hamano. Numerous contributions have come from the Git mailing list
1091 <git@vger.kernel.org>. http://www.openhub.net/p/git/contributors/summary
1092 gives you a more complete list of contributors.
1094 If you have a clone of git.git itself, the
1095 output of linkgit:git-shortlog[1] and linkgit:git-blame[1] can show you
1096 the authors for specific parts of the project.
1101 Report bugs to the Git mailing list <git@vger.kernel.org> where the
1102 development and maintenance is primarily done. You do not have to be
1103 subscribed to the list to send a message there.
1107 linkgit:gittutorial[7], linkgit:gittutorial-2[7],
1108 linkgit:giteveryday[7], linkgit:gitcvs-migration[7],
1109 linkgit:gitglossary[7], linkgit:gitcore-tutorial[7],
1110 linkgit:gitcli[7], link:user-manual.html[The Git User's Manual],
1111 linkgit:gitworkflows[7]
1115 Part of the linkgit:git[1] suite