6 git - the stupid content tracker
12 'git' [--version] [--exec-path[=GIT_EXEC_PATH]] [--html-path]
13 [-p|--paginate|--no-pager] [--no-replace-objects]
14 [--bare] [--git-dir=GIT_DIR] [--work-tree=GIT_WORK_TREE]
15 [--help] COMMAND [ARGS]
19 Git is a fast, scalable, distributed revision control system with an
20 unusually rich command set that provides both high-level operations
21 and full access to internals.
23 See linkgit:gittutorial[7] to get started, then see
24 link:everyday.html[Everyday Git] for a useful minimum set of commands, and
25 "man git-commandname" for documentation of each command. CVS users may
26 also want to read linkgit:gitcvs-migration[7]. See
27 the link:user-manual.html[Git User's Manual] for a more in-depth
30 The COMMAND is either a name of a Git command (see below) or an alias
31 as defined in the configuration file (see linkgit:git-config[1]).
33 Formatted and hyperlinked version of the latest git
34 documentation can be viewed at
35 `http://www.kernel.org/pub/software/scm/git/docs/`.
41 You are reading the documentation for the latest (possibly
42 unreleased) version of git, that is available from 'master'
43 branch of the `git.git` repository.
44 Documentation for older releases are available here:
46 * link:v1.7.0.5/git.html[documentation for release 1.7.0.5]
49 link:RelNotes-1.7.0.5.txt[1.7.0.5],
50 link:RelNotes-1.7.0.4.txt[1.7.0.4],
51 link:RelNotes-1.7.0.3.txt[1.7.0.3],
52 link:RelNotes-1.7.0.2.txt[1.7.0.2],
53 link:RelNotes-1.7.0.1.txt[1.7.0.1],
54 link:RelNotes-1.7.0.txt[1.7.0].
56 * link:v1.6.6.2/git.html[documentation for release 1.6.6.2]
59 link:RelNotes-1.6.6.2.txt[1.6.6.2],
60 link:RelNotes-1.6.6.1.txt[1.6.6.1],
61 link:RelNotes-1.6.6.txt[1.6.6].
63 * link:v1.6.5.8/git.html[documentation for release 1.6.5.8]
66 link:RelNotes-1.6.5.8.txt[1.6.5.8],
67 link:RelNotes-1.6.5.7.txt[1.6.5.7],
68 link:RelNotes-1.6.5.6.txt[1.6.5.6],
69 link:RelNotes-1.6.5.5.txt[1.6.5.5],
70 link:RelNotes-1.6.5.4.txt[1.6.5.4],
71 link:RelNotes-1.6.5.3.txt[1.6.5.3],
72 link:RelNotes-1.6.5.2.txt[1.6.5.2],
73 link:RelNotes-1.6.5.1.txt[1.6.5.1],
74 link:RelNotes-1.6.5.txt[1.6.5].
76 * link:v1.6.4.4/git.html[documentation for release 1.6.4.4]
79 link:RelNotes-1.6.4.4.txt[1.6.4.4],
80 link:RelNotes-1.6.4.3.txt[1.6.4.3],
81 link:RelNotes-1.6.4.2.txt[1.6.4.2],
82 link:RelNotes-1.6.4.1.txt[1.6.4.1],
83 link:RelNotes-1.6.4.txt[1.6.4].
85 * link:v1.6.3.4/git.html[documentation for release 1.6.3.4]
88 link:RelNotes-1.6.3.4.txt[1.6.3.4],
89 link:RelNotes-1.6.3.3.txt[1.6.3.3],
90 link:RelNotes-1.6.3.2.txt[1.6.3.2],
91 link:RelNotes-1.6.3.1.txt[1.6.3.1],
92 link:RelNotes-1.6.3.txt[1.6.3].
95 link:RelNotes-1.6.2.5.txt[1.6.2.5],
96 link:RelNotes-1.6.2.4.txt[1.6.2.4],
97 link:RelNotes-1.6.2.3.txt[1.6.2.3],
98 link:RelNotes-1.6.2.2.txt[1.6.2.2],
99 link:RelNotes-1.6.2.1.txt[1.6.2.1],
100 link:RelNotes-1.6.2.txt[1.6.2].
102 * link:v1.6.1.3/git.html[documentation for release 1.6.1.3]
105 link:RelNotes-1.6.1.3.txt[1.6.1.3],
106 link:RelNotes-1.6.1.2.txt[1.6.1.2],
107 link:RelNotes-1.6.1.1.txt[1.6.1.1],
108 link:RelNotes-1.6.1.txt[1.6.1].
110 * link:v1.6.0.6/git.html[documentation for release 1.6.0.6]
113 link:RelNotes-1.6.0.6.txt[1.6.0.6],
114 link:RelNotes-1.6.0.5.txt[1.6.0.5],
115 link:RelNotes-1.6.0.4.txt[1.6.0.4],
116 link:RelNotes-1.6.0.3.txt[1.6.0.3],
117 link:RelNotes-1.6.0.2.txt[1.6.0.2],
118 link:RelNotes-1.6.0.1.txt[1.6.0.1],
119 link:RelNotes-1.6.0.txt[1.6.0].
121 * link:v1.5.6.6/git.html[documentation for release 1.5.6.6]
124 link:RelNotes-1.5.6.6.txt[1.5.6.6],
125 link:RelNotes-1.5.6.5.txt[1.5.6.5],
126 link:RelNotes-1.5.6.4.txt[1.5.6.4],
127 link:RelNotes-1.5.6.3.txt[1.5.6.3],
128 link:RelNotes-1.5.6.2.txt[1.5.6.2],
129 link:RelNotes-1.5.6.1.txt[1.5.6.1],
130 link:RelNotes-1.5.6.txt[1.5.6].
132 * link:v1.5.5.6/git.html[documentation for release 1.5.5.6]
135 link:RelNotes-1.5.5.6.txt[1.5.5.6],
136 link:RelNotes-1.5.5.5.txt[1.5.5.5],
137 link:RelNotes-1.5.5.4.txt[1.5.5.4],
138 link:RelNotes-1.5.5.3.txt[1.5.5.3],
139 link:RelNotes-1.5.5.2.txt[1.5.5.2],
140 link:RelNotes-1.5.5.1.txt[1.5.5.1],
141 link:RelNotes-1.5.5.txt[1.5.5].
143 * link:v1.5.4.7/git.html[documentation for release 1.5.4.7]
146 link:RelNotes-1.5.4.7.txt[1.5.4.7],
147 link:RelNotes-1.5.4.6.txt[1.5.4.6],
148 link:RelNotes-1.5.4.5.txt[1.5.4.5],
149 link:RelNotes-1.5.4.4.txt[1.5.4.4],
150 link:RelNotes-1.5.4.3.txt[1.5.4.3],
151 link:RelNotes-1.5.4.2.txt[1.5.4.2],
152 link:RelNotes-1.5.4.1.txt[1.5.4.1],
153 link:RelNotes-1.5.4.txt[1.5.4].
155 * link:v1.5.3.8/git.html[documentation for release 1.5.3.8]
158 link:RelNotes-1.5.3.8.txt[1.5.3.8],
159 link:RelNotes-1.5.3.7.txt[1.5.3.7],
160 link:RelNotes-1.5.3.6.txt[1.5.3.6],
161 link:RelNotes-1.5.3.5.txt[1.5.3.5],
162 link:RelNotes-1.5.3.4.txt[1.5.3.4],
163 link:RelNotes-1.5.3.3.txt[1.5.3.3],
164 link:RelNotes-1.5.3.2.txt[1.5.3.2],
165 link:RelNotes-1.5.3.1.txt[1.5.3.1],
166 link:RelNotes-1.5.3.txt[1.5.3].
168 * link:v1.5.2.5/git.html[documentation for release 1.5.2.5]
171 link:RelNotes-1.5.2.5.txt[1.5.2.5],
172 link:RelNotes-1.5.2.4.txt[1.5.2.4],
173 link:RelNotes-1.5.2.3.txt[1.5.2.3],
174 link:RelNotes-1.5.2.2.txt[1.5.2.2],
175 link:RelNotes-1.5.2.1.txt[1.5.2.1],
176 link:RelNotes-1.5.2.txt[1.5.2].
178 * link:v1.5.1.6/git.html[documentation for release 1.5.1.6]
181 link:RelNotes-1.5.1.6.txt[1.5.1.6],
182 link:RelNotes-1.5.1.5.txt[1.5.1.5],
183 link:RelNotes-1.5.1.4.txt[1.5.1.4],
184 link:RelNotes-1.5.1.3.txt[1.5.1.3],
185 link:RelNotes-1.5.1.2.txt[1.5.1.2],
186 link:RelNotes-1.5.1.1.txt[1.5.1.1],
187 link:RelNotes-1.5.1.txt[1.5.1].
189 * link:v1.5.0.7/git.html[documentation for release 1.5.0.7]
192 link:RelNotes-1.5.0.7.txt[1.5.0.7],
193 link:RelNotes-1.5.0.6.txt[1.5.0.6],
194 link:RelNotes-1.5.0.5.txt[1.5.0.5],
195 link:RelNotes-1.5.0.3.txt[1.5.0.3],
196 link:RelNotes-1.5.0.2.txt[1.5.0.2],
197 link:RelNotes-1.5.0.1.txt[1.5.0.1],
198 link:RelNotes-1.5.0.txt[1.5.0].
200 * documentation for release link:v1.4.4.4/git.html[1.4.4.4],
201 link:v1.3.3/git.html[1.3.3],
202 link:v1.2.6/git.html[1.2.6],
203 link:v1.0.13/git.html[1.0.13].
212 Prints the git suite version that the 'git' program came from.
215 Prints the synopsis and a list of the most commonly used
216 commands. If the option '--all' or '-a' is given then all
217 available commands are printed. If a git command is named this
218 option will bring up the manual page for that command.
220 Other options are available to control how the manual page is
221 displayed. See linkgit:git-help[1] for more information,
222 because `git --help ...` is converted internally into `git
226 Path to wherever your core git programs are installed.
227 This can also be controlled by setting the GIT_EXEC_PATH
228 environment variable. If no path is given, 'git' will print
229 the current setting and then exit.
232 Print the path to wherever your git HTML documentation is installed
237 Pipe all output into 'less' (or if set, $PAGER) if standard
238 output is a terminal. This overrides the `pager.<cmd>`
239 configuration options (see the "Configuration Mechanism" section
243 Do not pipe git output into a pager.
246 Set the path to the repository. This can also be controlled by
247 setting the GIT_DIR environment variable. It can be an absolute
248 path or relative path to current working directory.
251 Set the path to the working tree. The value will not be
252 used in combination with repositories found automatically in
253 a .git directory (i.e. $GIT_DIR is not set).
254 This can also be controlled by setting the GIT_WORK_TREE
255 environment variable and the core.worktree configuration
256 variable. It can be an absolute path or relative path to
257 the directory specified by --git-dir or GIT_DIR.
258 Note: If --git-dir or GIT_DIR are specified but none of
259 --work-tree, GIT_WORK_TREE and core.worktree is specified,
260 the current working directory is regarded as the top directory
261 of your working tree.
264 Treat the repository as a bare repository. If GIT_DIR
265 environment is not set, it is set to the current working
268 --no-replace-objects::
269 Do not use replacement refs to replace git objects. See
270 linkgit:git-replace[1] for more information.
273 FURTHER DOCUMENTATION
274 ---------------------
276 See the references above to get started using git. The following is
277 probably more detail than necessary for a first-time user.
279 The link:user-manual.html#git-concepts[git concepts chapter of the
280 user-manual] and linkgit:gitcore-tutorial[7] both provide
281 introductions to the underlying git architecture.
283 See linkgit:gitworkflows[7] for an overview of recommended workflows.
285 See also the link:howto-index.html[howto] documents for some useful
288 The internals are documented in the
289 link:technical/api-index.html[GIT API documentation].
294 We divide git into high level ("porcelain") commands and low level
295 ("plumbing") commands.
297 High-level commands (porcelain)
298 -------------------------------
300 We separate the porcelain commands into the main commands and some
301 ancillary user utilities.
303 Main porcelain commands
304 ~~~~~~~~~~~~~~~~~~~~~~~
306 include::cmds-mainporcelain.txt[]
312 include::cmds-ancillarymanipulators.txt[]
316 include::cmds-ancillaryinterrogators.txt[]
319 Interacting with Others
320 ~~~~~~~~~~~~~~~~~~~~~~~
322 These commands are to interact with foreign SCM and with other
323 people via patch over e-mail.
325 include::cmds-foreignscminterface.txt[]
328 Low-level commands (plumbing)
329 -----------------------------
331 Although git includes its
332 own porcelain layer, its low-level commands are sufficient to support
333 development of alternative porcelains. Developers of such porcelains
334 might start by reading about linkgit:git-update-index[1] and
335 linkgit:git-read-tree[1].
337 The interface (input, output, set of options and the semantics)
338 to these low-level commands are meant to be a lot more stable
339 than Porcelain level commands, because these commands are
340 primarily for scripted use. The interface to Porcelain commands
341 on the other hand are subject to change in order to improve the
344 The following description divides
345 the low-level commands into commands that manipulate objects (in
346 the repository, index, and working tree), commands that interrogate and
347 compare objects, and commands that move objects and references between
351 Manipulation commands
352 ~~~~~~~~~~~~~~~~~~~~~
354 include::cmds-plumbingmanipulators.txt[]
357 Interrogation commands
358 ~~~~~~~~~~~~~~~~~~~~~~
360 include::cmds-plumbinginterrogators.txt[]
362 In general, the interrogate commands do not touch the files in
366 Synching repositories
367 ~~~~~~~~~~~~~~~~~~~~~
369 include::cmds-synchingrepositories.txt[]
371 The following are helper commands used by the above; end users
372 typically do not use them directly.
374 include::cmds-synchelpers.txt[]
377 Internal helper commands
378 ~~~~~~~~~~~~~~~~~~~~~~~~
380 These are internal helper commands used by other commands; end
381 users typically do not use them directly.
383 include::cmds-purehelpers.txt[]
386 Configuration Mechanism
387 -----------------------
389 Starting from 0.99.9 (actually mid 0.99.8.GIT), `.git/config` file
390 is used to hold per-repository configuration options. It is a
391 simple text file modeled after `.ini` format familiar to some
392 people. Here is an example:
396 # A '#' or ';' character indicates a comment.
401 ; Don't trust file modes
406 name = "Junio C Hamano"
407 email = "junkio@twinsun.com"
411 Various commands read from the configuration file and adjust
412 their operation accordingly. See linkgit:git-config[1] for a
416 Identifier Terminology
417 ----------------------
419 Indicates the object name for any type of object.
422 Indicates a blob object name.
425 Indicates a tree object name.
428 Indicates a commit object name.
431 Indicates a tree, commit or tag object name. A
432 command that takes a <tree-ish> argument ultimately wants to
433 operate on a <tree> object but automatically dereferences
434 <commit> and <tag> objects that point at a <tree>.
437 Indicates a commit or tag object name. A
438 command that takes a <commit-ish> argument ultimately wants to
439 operate on a <commit> object but automatically dereferences
440 <tag> objects that point at a <commit>.
443 Indicates that an object type is required.
444 Currently one of: `blob`, `tree`, `commit`, or `tag`.
447 Indicates a filename - almost always relative to the
448 root of the tree structure `GIT_INDEX_FILE` describes.
452 Any git command accepting any <object> can also use the following
456 indicates the head of the current branch (i.e. the
457 contents of `$GIT_DIR/HEAD`).
461 (i.e. the contents of `$GIT_DIR/refs/tags/<tag>`).
465 (i.e. the contents of `$GIT_DIR/refs/heads/<head>`).
467 For a more complete list of ways to spell object names, see
468 "SPECIFYING REVISIONS" section in linkgit:git-rev-parse[1].
471 File/Directory Structure
472 ------------------------
474 Please see the linkgit:gitrepository-layout[5] document.
476 Read linkgit:githooks[5] for more details about each hook.
478 Higher level SCMs may provide and manage additional information in the
484 Please see linkgit:gitglossary[7].
487 Environment Variables
488 ---------------------
489 Various git commands use the following environment variables:
493 These environment variables apply to 'all' core git commands. Nb: it
494 is worth noting that they may be used/overridden by SCMS sitting above
495 git so take care if using Cogito etc.
498 This environment allows the specification of an alternate
499 index file. If not specified, the default of `$GIT_DIR/index`
502 'GIT_OBJECT_DIRECTORY'::
503 If the object storage directory is specified via this
504 environment variable then the sha1 directories are created
505 underneath - otherwise the default `$GIT_DIR/objects`
508 'GIT_ALTERNATE_OBJECT_DIRECTORIES'::
509 Due to the immutable nature of git objects, old objects can be
510 archived into shared, read-only directories. This variable
511 specifies a ":" separated (on Windows ";" separated) list
512 of git object directories which can be used to search for git
513 objects. New objects will not be written to these directories.
516 If the 'GIT_DIR' environment variable is set then it
517 specifies a path to use instead of the default `.git`
518 for the base of the repository.
521 Set the path to the working tree. The value will not be
522 used in combination with repositories found automatically in
523 a .git directory (i.e. $GIT_DIR is not set).
524 This can also be controlled by the '--work-tree' command line
525 option and the core.worktree configuration variable.
527 'GIT_CEILING_DIRECTORIES'::
528 This should be a colon-separated list of absolute paths.
529 If set, it is a list of directories that git should not chdir
530 up into while looking for a repository directory.
531 It will not exclude the current working directory or
532 a GIT_DIR set on the command line or in the environment.
533 (Useful for excluding slow-loading network directories.)
540 'GIT_COMMITTER_NAME'::
541 'GIT_COMMITTER_EMAIL'::
542 'GIT_COMMITTER_DATE'::
544 see linkgit:git-commit-tree[1]
549 Only valid setting is "--unified=??" or "-u??" to set the
550 number of context lines shown when a unified diff is created.
551 This takes precedence over any "-U" or "--unified" option
552 value passed on the git diff command line.
554 'GIT_EXTERNAL_DIFF'::
555 When the environment variable 'GIT_EXTERNAL_DIFF' is set, the
556 program named by it is called, instead of the diff invocation
557 described above. For a path that is added, removed, or modified,
558 'GIT_EXTERNAL_DIFF' is called with 7 parameters:
560 path old-file old-hex old-mode new-file new-hex new-mode
564 <old|new>-file:: are files GIT_EXTERNAL_DIFF can use to read the
565 contents of <old|new>,
566 <old|new>-hex:: are the 40-hexdigit SHA1 hashes,
567 <old|new>-mode:: are the octal representation of the file modes.
570 The file parameters can point at the user's working file
571 (e.g. `new-file` in "git-diff-files"), `/dev/null` (e.g. `old-file`
572 when a new file is added), or a temporary file (e.g. `old-file` in the
573 index). 'GIT_EXTERNAL_DIFF' should not worry about unlinking the
574 temporary file --- it is removed when 'GIT_EXTERNAL_DIFF' exits.
576 For a path that is unmerged, 'GIT_EXTERNAL_DIFF' is called with 1
581 'GIT_MERGE_VERBOSITY'::
582 A number controlling the amount of output shown by
583 the recursive merge strategy. Overrides merge.verbosity.
584 See linkgit:git-merge[1]
587 This environment variable overrides `$PAGER`. If it is set
588 to an empty string or to the value "cat", git will not launch
589 a pager. See also the `core.pager` option in
590 linkgit:git-config[1].
593 If this environment variable is set then 'git fetch'
594 and 'git push' will use this command instead
595 of 'ssh' when they need to connect to a remote system.
596 The '$GIT_SSH' command will be given exactly two arguments:
597 the 'username@host' (or just 'host') from the URL and the
598 shell command to execute on that remote system.
600 To pass options to the program that you want to list in GIT_SSH
601 you will need to wrap the program and options into a shell script,
602 then set GIT_SSH to refer to the shell script.
604 Usually it is easier to configure any desired options through your
605 personal `.ssh/config` file. Please consult your ssh documentation
609 If this environment variable is set to "1", then commands such
610 as 'git blame' (in incremental mode), 'git rev-list', 'git log',
611 and 'git whatchanged' will force a flush of the output stream
612 after each commit-oriented record have been flushed. If this
613 variable is set to "0", the output of these commands will be done
614 using completely buffered I/O. If this environment variable is
615 not set, git will choose buffered or record-oriented flushing
616 based on whether stdout appears to be redirected to a file or not.
619 If this variable is set to "1", "2" or "true" (comparison
620 is case insensitive), git will print `trace:` messages on
621 stderr telling about alias expansion, built-in command
622 execution and external command execution.
623 If this variable is set to an integer value greater than 1
624 and lower than 10 (strictly) then git will interpret this
625 value as an open file descriptor and will try to write the
626 trace messages into this file descriptor.
627 Alternatively, if this variable is set to an absolute path
628 (starting with a '/' character), git will interpret this
629 as a file path and will try to write the trace messages
632 Discussion[[Discussion]]
633 ------------------------
635 More detail on the following is available from the
636 link:user-manual.html#git-concepts[git concepts chapter of the
637 user-manual] and linkgit:gitcore-tutorial[7].
639 A git project normally consists of a working directory with a ".git"
640 subdirectory at the top level. The .git directory contains, among other
641 things, a compressed object database representing the complete history
642 of the project, an "index" file which links that history to the current
643 contents of the working tree, and named pointers into that history such
644 as tags and branch heads.
646 The object database contains objects of three main types: blobs, which
647 hold file data; trees, which point to blobs and other trees to build up
648 directory hierarchies; and commits, which each reference a single tree
649 and some number of parent commits.
651 The commit, equivalent to what other systems call a "changeset" or
652 "version", represents a step in the project's history, and each parent
653 represents an immediately preceding step. Commits with more than one
654 parent represent merges of independent lines of development.
656 All objects are named by the SHA1 hash of their contents, normally
657 written as a string of 40 hex digits. Such names are globally unique.
658 The entire history leading up to a commit can be vouched for by signing
659 just that commit. A fourth object type, the tag, is provided for this
662 When first created, objects are stored in individual files, but for
663 efficiency may later be compressed together into "pack files".
665 Named pointers called refs mark interesting points in history. A ref
666 may contain the SHA1 name of an object or the name of another ref. Refs
667 with names beginning `ref/head/` contain the SHA1 name of the most
668 recent commit (or "head") of a branch under development. SHA1 names of
669 tags of interest are stored under `ref/tags/`. A special ref named
670 `HEAD` contains the name of the currently checked-out branch.
672 The index file is initialized with a list of all paths and, for each
673 path, a blob object and a set of attributes. The blob object represents
674 the contents of the file as of the head of the current branch. The
675 attributes (last modified time, size, etc.) are taken from the
676 corresponding file in the working tree. Subsequent changes to the
677 working tree can be found by comparing these attributes. The index may
678 be updated with new content, and new commits may be created from the
679 content stored in the index.
681 The index is also capable of storing multiple entries (called "stages")
682 for a given pathname. These stages are used to hold the various
683 unmerged version of a file when a merge is in progress.
687 * git's founding father is Linus Torvalds <torvalds@osdl.org>.
688 * The current git nurse is Junio C Hamano <gitster@pobox.com>.
689 * The git potty was written by Andreas Ericsson <ae@op5.se>.
690 * General upbringing is handled by the git-list <git@vger.kernel.org>.
694 The documentation for git suite was started by David Greaves
695 <david@dgreaves.com>, and later enhanced greatly by the
696 contributors on the git-list <git@vger.kernel.org>.
700 linkgit:gittutorial[7], linkgit:gittutorial-2[7],
701 link:everyday.html[Everyday Git], linkgit:gitcvs-migration[7],
702 linkgit:gitglossary[7], linkgit:gitcore-tutorial[7],
703 linkgit:gitcli[7], link:user-manual.html[The Git User's Manual],
704 linkgit:gitworkflows[7]
708 Part of the linkgit:git[1] suite