6 git - the stupid content tracker
12 'git' [--version] [--exec-path[=GIT_EXEC_PATH]]
13 [-p|--paginate|--no-pager]
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 this link:tutorial.html[tutorial] 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 link:cvs-migration.html[CVS migration]. See
27 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 gitlink: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.5.3/git.html[documentation for release 1.5.3]
49 link:RelNotes-1.5.3.3.txt[1.5.3.3],
50 link:RelNotes-1.5.3.2.txt[1.5.3.2],
51 link:RelNotes-1.5.3.1.txt[1.5.3.1].
54 link:RelNotes-1.5.2.5.txt[1.5.2.5],
55 link:RelNotes-1.5.2.4.txt[1.5.2.4],
56 link:RelNotes-1.5.2.3.txt[1.5.2.3],
57 link:RelNotes-1.5.2.2.txt[1.5.2.2],
58 link:RelNotes-1.5.2.1.txt[1.5.2.1],
59 link:RelNotes-1.5.2.txt[1.5.2].
61 * link:v1.5.1.6/git.html[documentation for release 1.5.1.6]
64 link:RelNotes-1.5.1.6.txt[1.5.1.6],
65 link:RelNotes-1.5.1.5.txt[1.5.1.5],
66 link:RelNotes-1.5.1.4.txt[1.5.1.4],
67 link:RelNotes-1.5.1.3.txt[1.5.1.3],
68 link:RelNotes-1.5.1.2.txt[1.5.1.2],
69 link:RelNotes-1.5.1.1.txt[1.5.1.1],
70 link:RelNotes-1.5.1.txt[1.5.1].
72 * link:v1.5.0.7/git.html[documentation for release 1.5.0.7]
75 link:RelNotes-1.5.0.7.txt[1.5.0.7],
76 link:RelNotes-1.5.0.6.txt[1.5.0.6],
77 link:RelNotes-1.5.0.5.txt[1.5.0.5],
78 link:RelNotes-1.5.0.3.txt[1.5.0.3],
79 link:RelNotes-1.5.0.2.txt[1.5.0.2],
80 link:RelNotes-1.5.0.1.txt[1.5.0.1],
81 link:RelNotes-1.5.0.txt[1.5.0].
83 * documentation for release link:v1.4.4.4/git.html[1.4.4.4],
84 link:v1.3.3/git.html[1.3.3],
85 link:v1.2.6/git.html[1.2.6],
86 link:v1.0.13/git.html[1.0.13].
95 Prints the git suite version that the 'git' program came from.
98 Prints the synopsis and a list of the most commonly used
99 commands. If a git command is named this option will bring up
100 the man-page for that command. If the option '--all' or '-a' is
101 given then all available commands are printed.
104 Path to wherever your core git programs are installed.
105 This can also be controlled by setting the GIT_EXEC_PATH
106 environment variable. If no path is given 'git' will print
107 the current setting and then exit.
110 Pipe all output into 'less' (or if set, $PAGER).
113 Do not pipe git output into a pager.
116 Set the path to the repository. This can also be controlled by
117 setting the GIT_DIR environment variable.
120 Set the path to the working tree. The value will not be
121 used in combination with repositories found automatically in
122 a .git directory (i.e. $GIT_DIR is not set).
123 This can also be controlled by setting the GIT_WORK_TREE
124 environment variable and the core.worktree configuration
128 Treat the repository as a bare repository. If GIT_DIR
129 environment is not set, it is set to the current working
133 FURTHER DOCUMENTATION
134 ---------------------
136 See the references above to get started using git. The following is
137 probably more detail than necessary for a first-time user.
139 The link:user-manual.html#git-concepts[git concepts chapter of the
140 user-manual] and the link:core-tutorial.html[Core tutorial] both provide
141 introductions to the underlying git architecture.
143 See also the link:howto-index.html[howto] documents for some useful
149 We divide git into high level ("porcelain") commands and low level
150 ("plumbing") commands.
152 High-level commands (porcelain)
153 -------------------------------
155 We separate the porcelain commands into the main commands and some
156 ancillary user utilities.
158 Main porcelain commands
159 ~~~~~~~~~~~~~~~~~~~~~~~
161 include::cmds-mainporcelain.txt[]
167 include::cmds-ancillarymanipulators.txt[]
171 include::cmds-ancillaryinterrogators.txt[]
174 Interacting with Others
175 ~~~~~~~~~~~~~~~~~~~~~~~
177 These commands are to interact with foreign SCM and with other
178 people via patch over e-mail.
180 include::cmds-foreignscminterface.txt[]
183 Low-level commands (plumbing)
184 -----------------------------
186 Although git includes its
187 own porcelain layer, its low-level commands are sufficient to support
188 development of alternative porcelains. Developers of such porcelains
189 might start by reading about gitlink:git-update-index[1] and
190 gitlink:git-read-tree[1].
192 The interface (input, output, set of options and the semantics)
193 to these low-level commands are meant to be a lot more stable
194 than Porcelain level commands, because these commands are
195 primarily for scripted use. The interface to Porcelain commands
196 on the other hand are subject to change in order to improve the
199 The following description divides
200 the low-level commands into commands that manipulate objects (in
201 the repository, index, and working tree), commands that interrogate and
202 compare objects, and commands that move objects and references between
206 Manipulation commands
207 ~~~~~~~~~~~~~~~~~~~~~
209 include::cmds-plumbingmanipulators.txt[]
212 Interrogation commands
213 ~~~~~~~~~~~~~~~~~~~~~~
215 include::cmds-plumbinginterrogators.txt[]
217 In general, the interrogate commands do not touch the files in
221 Synching repositories
222 ~~~~~~~~~~~~~~~~~~~~~
224 include::cmds-synchingrepositories.txt[]
226 The following are helper programs used by the above; end users
227 typically do not use them directly.
229 include::cmds-synchelpers.txt[]
232 Internal helper commands
233 ~~~~~~~~~~~~~~~~~~~~~~~~
235 These are internal helper commands used by other commands; end
236 users typically do not use them directly.
238 include::cmds-purehelpers.txt[]
241 Configuration Mechanism
242 -----------------------
244 Starting from 0.99.9 (actually mid 0.99.8.GIT), `.git/config` file
245 is used to hold per-repository configuration options. It is a
246 simple text file modeled after `.ini` format familiar to some
247 people. Here is an example:
251 # A '#' or ';' character indicates a comment.
256 ; Don't trust file modes
261 name = "Junio C Hamano"
262 email = "junkio@twinsun.com"
266 Various commands read from the configuration file and adjust
267 their operation accordingly.
270 Identifier Terminology
271 ----------------------
273 Indicates the object name for any type of object.
276 Indicates a blob object name.
279 Indicates a tree object name.
282 Indicates a commit object name.
285 Indicates a tree, commit or tag object name. A
286 command that takes a <tree-ish> argument ultimately wants to
287 operate on a <tree> object but automatically dereferences
288 <commit> and <tag> objects that point at a <tree>.
291 Indicates a commit or tag object name. A
292 command that takes a <commit-ish> argument ultimately wants to
293 operate on a <commit> object but automatically dereferences
294 <tag> objects that point at a <commit>.
297 Indicates that an object type is required.
298 Currently one of: `blob`, `tree`, `commit`, or `tag`.
301 Indicates a filename - almost always relative to the
302 root of the tree structure `GIT_INDEX_FILE` describes.
306 Any git command accepting any <object> can also use the following
310 indicates the head of the current branch (i.e. the
311 contents of `$GIT_DIR/HEAD`).
315 (i.e. the contents of `$GIT_DIR/refs/tags/<tag>`).
319 (i.e. the contents of `$GIT_DIR/refs/heads/<head>`).
321 For a more complete list of ways to spell object names, see
322 "SPECIFYING REVISIONS" section in gitlink:git-rev-parse[1].
325 File/Directory Structure
326 ------------------------
328 Please see link:repository-layout.html[repository layout] document.
330 Read link:hooks.html[hooks] for more details about each hook.
332 Higher level SCMs may provide and manage additional information in the
338 Please see link:glossary.html[glossary] document.
341 Environment Variables
342 ---------------------
343 Various git commands use the following environment variables:
347 These environment variables apply to 'all' core git commands. Nb: it
348 is worth noting that they may be used/overridden by SCMS sitting above
349 git so take care if using Cogito etc.
352 This environment allows the specification of an alternate
353 index file. If not specified, the default of `$GIT_DIR/index`
356 'GIT_OBJECT_DIRECTORY'::
357 If the object storage directory is specified via this
358 environment variable then the sha1 directories are created
359 underneath - otherwise the default `$GIT_DIR/objects`
362 'GIT_ALTERNATE_OBJECT_DIRECTORIES'::
363 Due to the immutable nature of git objects, old objects can be
364 archived into shared, read-only directories. This variable
365 specifies a ":" separated list of git object directories which
366 can be used to search for git objects. New objects will not be
367 written to these directories.
370 If the 'GIT_DIR' environment variable is set then it
371 specifies a path to use instead of the default `.git`
372 for the base of the repository.
375 Set the path to the working tree. The value will not be
376 used in combination with repositories found automatically in
377 a .git directory (i.e. $GIT_DIR is not set).
378 This can also be controlled by the '--work-tree' command line
379 option and the core.worktree configuration variable.
386 'GIT_COMMITTER_NAME'::
387 'GIT_COMMITTER_EMAIL'::
388 'GIT_COMMITTER_DATE'::
390 see gitlink:git-commit-tree[1]
395 Only valid setting is "--unified=??" or "-u??" to set the
396 number of context lines shown when a unified diff is created.
397 This takes precedence over any "-U" or "--unified" option
398 value passed on the git diff command line.
400 'GIT_EXTERNAL_DIFF'::
401 When the environment variable 'GIT_EXTERNAL_DIFF' is set, the
402 program named by it is called, instead of the diff invocation
403 described above. For a path that is added, removed, or modified,
404 'GIT_EXTERNAL_DIFF' is called with 7 parameters:
406 path old-file old-hex old-mode new-file new-hex new-mode
410 <old|new>-file:: are files GIT_EXTERNAL_DIFF can use to read the
411 contents of <old|new>,
412 <old|new>-hex:: are the 40-hexdigit SHA1 hashes,
413 <old|new>-mode:: are the octal representation of the file modes.
416 The file parameters can point at the user's working file
417 (e.g. `new-file` in "git-diff-files"), `/dev/null` (e.g. `old-file`
418 when a new file is added), or a temporary file (e.g. `old-file` in the
419 index). 'GIT_EXTERNAL_DIFF' should not worry about unlinking the
420 temporary file --- it is removed when 'GIT_EXTERNAL_DIFF' exits.
422 For a path that is unmerged, 'GIT_EXTERNAL_DIFF' is called with 1
427 'GIT_MERGE_VERBOSITY'::
428 A number controlling the amount of output shown by
429 the recursive merge strategy. Overrides merge.verbosity.
430 See gitlink:git-merge[1]
433 This environment variable overrides `$PAGER`. If it is set
434 to an empty string or to the value "cat", git will not launch
438 If this environment variable is set then gitlink:git-fetch[1]
439 and gitlink:git-push[1] will use this command instead
440 of `ssh` when they need to connect to a remote system.
441 The 'GIT_SSH' command will be given exactly two arguments:
442 the 'username@host' (or just 'host') from the URL and the
443 shell command to execute on that remote system.
445 To pass options to the program that you want to list in GIT_SSH
446 you will need to wrap the program and options into a shell script,
447 then set GIT_SSH to refer to the shell script.
449 Usually it is easier to configure any desired options through your
450 personal `.ssh/config` file. Please consult your ssh documentation
454 If this environment variable is set to "1", then commands such
455 as git-blame (in incremental mode), git-rev-list, git-log,
456 git-whatchanged, etc., will force a flush of the output stream
457 after each commit-oriented record have been flushed. If this
458 variable is set to "0", the output of these commands will be done
459 using completely buffered I/O. If this environment variable is
460 not set, git will choose buffered or record-oriented flushing
461 based on whether stdout appears to be redirected to a file or not.
464 If this variable is set to "1", "2" or "true" (comparison
465 is case insensitive), git will print `trace:` messages on
466 stderr telling about alias expansion, built-in command
467 execution and external command execution.
468 If this variable is set to an integer value greater than 1
469 and lower than 10 (strictly) then git will interpret this
470 value as an open file descriptor and will try to write the
471 trace messages into this file descriptor.
472 Alternatively, if this variable is set to an absolute path
473 (starting with a '/' character), git will interpret this
474 as a file path and will try to write the trace messages
477 Discussion[[Discussion]]
478 ------------------------
480 More detail on the following is available from the
481 link:user-manual.html#git-concepts[git concepts chapter of the
482 user-manual] and the link:core-tutorial.html[Core tutorial].
484 A git project normally consists of a working directory with a ".git"
485 subdirectory at the top level. The .git directory contains, among other
486 things, a compressed object database representing the complete history
487 of the project, an "index" file which links that history to the current
488 contents of the working tree, and named pointers into that history such
489 as tags and branch heads.
491 The object database contains objects of three main types: blobs, which
492 hold file data; trees, which point to blobs and other trees to build up
493 directory heirarchies; and commits, which each reference a single tree
494 and some number of parent commits.
496 The commit, equivalent to what other systems call a "changeset" or
497 "version", represents a step in the project's history, and each parent
498 represents an immediately preceding step. Commits with more than one
499 parent represent merges of independent lines of development.
501 All objects are named by the SHA1 hash of their contents, normally
502 written as a string of 40 hex digits. Such names are globally unique.
503 The entire history leading up to a commit can be vouched for by signing
504 just that commit. A fourth object type, the tag, is provided for this
507 When first created, objects are stored in individual files, but for
508 efficiency may later be compressed together into "pack files".
510 Named pointers called refs mark interesting points in history. A ref
511 may contain the SHA1 name of an object or the name of another ref. Refs
512 with names beginning `ref/head/` contain the SHA1 name of the most
513 recent commit (or "head") of a branch under developement. SHA1 names of
514 tags of interest are stored under `ref/tags/`. A special ref named
515 `HEAD` contains the name of the currently checked-out branch.
517 The index file is initialized with a list of all paths and, for each
518 path, a blob object and a set of attributes. The blob object represents
519 the contents of the file as of the head of the current branch. The
520 attributes (last modified time, size, etc.) are taken from the
521 corresponding file in the working tree. Subsequent changes to the
522 working tree can be found by comparing these attributes. The index may
523 be updated with new content, and new commits may be created from the
524 content stored in the index.
526 The index is also capable of storing multiple entries (called "stages")
527 for a given pathname. These stages are used to hold the various
528 unmerged version of a file when a merge is in progress.
532 * git's founding father is Linus Torvalds <torvalds@osdl.org>.
533 * The current git nurse is Junio C Hamano <gitster@pobox.com>.
534 * The git potty was written by Andres Ericsson <ae@op5.se>.
535 * General upbringing is handled by the git-list <git@vger.kernel.org>.
539 The documentation for git suite was started by David Greaves
540 <david@dgreaves.com>, and later enhanced greatly by the
541 contributors on the git-list <git@vger.kernel.org>.
545 Part of the gitlink:git[7] suite