7 git - the stupid content tracker
12 'git-<command>' <args>
17 This is reference information for the core git commands.
19 Before reading this cover to cover, you may want to take a look
20 at the link:tutorial.html[tutorial] document.
22 The <<Discussion>> section below contains much useful definition and
23 clarification info - read that first. And of the commands, I suggest
24 reading link:git-update-index.html[git-update-index] and
25 link:git-read-tree.html[git-read-tree] first - I wish I had!
27 If you are migrating from CVS, link:cvs-migration.html[cvs migration]
28 document may be helpful after you finish the tutorial.
30 After you get the general feel from the tutorial and this
31 overview page, you may want to take a look at the
32 link:howto-index.html[howto] documents.
35 David Greaves <david@dgreaves.com>
38 Updated by Junio C Hamano <junkio@cox.net> on 2005-05-05 to
39 reflect recent changes.
43 The git commands can helpfully be split into those that manipulate
44 the repository, the cache and the working fileset, those that
45 interrogate and compare them, and those that moves objects and
46 references between repositories.
48 In addition, git itself comes with a spartan set of porcelain
49 commands. They are usable but are not meant to compete with real
52 There are also some ancillary programs that can be viewed as useful
53 aids for using the core commands but which are unlikely to be used by
54 SCMs layered over git.
58 link:git-apply.html[git-apply]::
59 Reads a "diff -up1" or git generated patch file and
60 applies it to the working tree.
62 link:git-checkout-index.html[git-checkout-index]::
63 Copy files from the cache to the working directory
64 Previously this command was known as git-checkout-cache.
66 link:git-commit-tree.html[git-commit-tree]::
67 Creates a new commit object
69 link:git-hash-object.html[git-hash-object]::
70 Computes the object ID from a file.
72 link:git-init-db.html[git-init-db]::
73 Creates an empty git object database
75 link:git-merge-index.html[git-merge-index]::
76 Runs a merge for files needing merging
77 Previously this command was known as git-merge-cache.
79 link:git-mktag.html[git-mktag]::
82 link:git-pack-objects.html[git-pack-objects]::
83 Creates a packed archive of objects.
85 link:git-prune-packed.html[git-prune-packed]::
86 Remove extra objects that are already in pack files.
88 link:git-read-tree.html[git-read-tree]::
89 Reads tree information into the directory cache
91 link:git-unpack-objects.html[git-unpack-objects]::
92 Unpacks objects out of a packed archive.
94 link:git-update-index.html[git-update-index]::
95 Modifies the index or directory cache
96 Previously this command was known as git-update-cache.
98 link:git-write-tree.html[git-write-tree]::
99 Creates a tree from the current cache
102 Interrogation commands
103 ~~~~~~~~~~~~~~~~~~~~~~
105 link:git-cat-file.html[git-cat-file]::
106 Provide content or type information for repository objects
108 link:git-diff-index.html[git-diff-index]::
109 Compares content and mode of blobs between the cache and repository
110 Previously this command was known as git-diff-cache.
112 link:git-diff-files.html[git-diff-files]::
113 Compares files in the working tree and the cache
115 link:git-diff-stages.html[git-diff-stages]::
116 Compares two "merge stages" in the index file.
118 link:git-diff-tree.html[git-diff-tree]::
119 Compares the content and mode of blobs found via two tree objects
121 link:git-export.html[git-export]::
122 Exports each commit and a diff against each of its parents
124 link:git-fsck-objects.html[git-fsck-objects]::
125 Verifies the connectivity and validity of the objects in the database
126 Previously this command was known as git-fsck-cache.
128 link:git-ls-files.html[git-ls-files]::
129 Information about files in the cache/working directory
131 link:git-ls-tree.html[git-ls-tree]::
132 Displays a tree object in human readable form
134 link:git-merge-base.html[git-merge-base]::
135 Finds as good a common ancestor as possible for a merge
137 link:git-rev-list.html[git-rev-list]::
138 Lists commit objects in reverse chronological order
140 link:git-rev-tree.html[git-rev-tree]::
141 Provides the revision tree for one or more commits
143 link:git-show-index.html[git-show-index]::
144 Displays contents of a pack idx file.
146 link:git-tar-tree.html[git-tar-tree]::
147 Creates a tar archive of the files in the named tree
149 link:git-unpack-file.html[git-unpack-file]::
150 Creates a temporary file with a blob's contents
152 link:git-var.html[git-var]::
153 Displays a git logical variable
155 link:git-verify-pack.html[git-verify-pack]::
156 Validates packed GIT archive files
158 The interrogate commands may create files - and you can force them to
159 touch the working file set - but in general they don't
162 Synching repositories
163 ~~~~~~~~~~~~~~~~~~~~~
165 link:git-clone-pack.html[git-clone-pack]::
166 Clones a repository into the current repository (engine
167 for ssh and local transport)
169 link:git-fetch-pack.html[git-fetch-pack]::
170 Updates from a remote repository.
172 link:git-http-fetch.html[git-http-fetch]::
173 Downloads a remote GIT repository via HTTP
174 Previously this command was known as git-http-pull.
176 link:git-local-fetch.html[git-local-fetch]::
177 Duplicates another GIT repository on a local system
178 Previously this command was known as git-local-pull.
180 link:git-peek-remote.html[git-peek-remote]::
181 Lists references on a remote repository using upload-pack protocol.
183 link:git-receive-pack.html[git-receive-pack]::
184 Invoked by 'git-send-pack' to receive what is pushed to it.
186 link:git-send-pack.html[git-send-pack]::
187 Pushes to a remote repository, intelligently.
189 link:git-ssh-fetch.html[git-ssh-fetch]::
190 Pulls from a remote repository over ssh connection
191 Previously this command was known as git-ssh-pull.
193 link:git-ssh-upload.html[git-ssh-upload]::
194 Helper "server-side" program used by git-ssh-fetch
195 Previously this command was known as git-ssh-push.
197 link:git-update-server-info.html[git-update-server-info]::
198 Updates auxiliary information on a dumb server to help
199 clients discover references and packs on it.
201 link:git-upload-pack.html[git-upload-pack]::
202 Invoked by 'git-clone-pack' and 'git-fetch-pack' to push
206 Porcelain-ish Commands
207 ----------------------
209 link:git-add.html[git-add]::
210 Add paths to the index file.
211 Previously this command was known as git-add-script.
213 link:git-applymbox.html[git-applymbox]::
214 Apply patches from a mailbox.
216 link:git-bisect.html[git-bisect]::
217 Find the change that introduced a bug.
218 Previously this command was known as git-bisect-script.
220 link:git-branch.html[git-branch]::
221 Create and Show branches.
222 Previously this command was known as git-branch-script.
224 link:git-checkout.html[git-checkout]::
225 Checkout and switch to a branch.
226 Previously this command was known as git-checkout-script.
228 link:git-cherry-pick.html[git-cherry-pick]::
229 Cherry-pick the effect of an existing commit.
230 Previously this command was known as git-cherry-pick-script.
232 link:git-clone.html[git-clone]::
233 Clones a repository into a new directory.
234 Previously this command was known as git-clone-script.
236 link:git-commit.html[git-commit]::
237 Record changes to the repository.
238 Previously this command was known as git-commit-script.
240 link:git-diff.html[git-diff]::
241 Show changes between commits, commit and working tree, etc.
242 Previously this command was known as git-diff-script.
244 link:git-fetch.html[git-fetch]::
245 Download from a remote repository via various protocols.
246 Previously this command was known as git-fetch-script.
248 link:git-format-patch.html[git-format-patch]::
249 Prepare patches for e-mail submission.
250 Previously this command was known as git-format-patch-script.
252 link:git-grep.html[git-grep]::
253 Print lines matching a pattern
255 link:git-log.html[git-log]::
257 Previously this command was known as git-log-script.
259 link:git-ls-remote.html[git-ls-remote]::
260 Shows references in a remote or local repository.
261 Previously this command was known as git-ls-remote-script.
263 link:git-merge.html[git-merge]::
264 Grand unified merge driver.
266 link:git-octopus.html[git-octopus]::
267 Merge more than two commits.
268 Previously this command was known as git-octopus-script.
270 link:git-pull.html[git-pull]::
271 Fetch from and merge with a remote repository.
272 Previously this command was known as git-pull-script.
274 link:git-push.html[git-push]::
275 Update remote refs along with associated objects.
276 Previously this command was known as git-push-script.
278 link:git-rebase.html[git-rebase]::
279 Rebase local commits to new upstream head.
280 Previously this command was known as git-rebase-script.
282 link:git-rename.html[git-rename]::
283 Rename files and directories.
284 Previously this command was known as git-rename-script.
286 link:git-repack.html[git-repack]::
287 Pack unpacked objects in a repository.
288 Previously this command was known as git-repack-script.
290 link:git-reset.html[git-reset]::
291 Reset current HEAD to the specified state.
292 Previously this command was known as git-reset-script.
294 link:git-resolve.html[git-resolve]::
296 Previously this command was known as git-resolve-script.
298 link:git-revert.html[git-revert]::
299 Revert an existing commit.
300 Previously this command was known as git-revert-script.
302 link:git-shortlog.html[git-shortlog]::
303 Summarizes 'git log' output.
305 link:git-show-branch.html[git-show-branch]::
306 Show branches and their commits.
308 link:git-status.html[git-status]::
309 Shows the working tree status.
310 Previously this command was known as git-status-script.
312 link:git-verify-tag.html[git-verify-tag]::
313 Check the GPG signature of tag.
314 Previously this command was known as git-verify-tag-script.
316 link:git-whatchanged.html[git-whatchanged]::
317 Shows commit logs and differences they introduce.
324 link:git-applypatch.html[git-applypatch]::
325 Apply one patch extracted from an e-mail.
327 link:git-archimport.html[git-archimport]::
328 Import an arch repository into git.
329 Previously this command was known as git-archimport-script.
331 link:git-convert-objects.html[git-convert-objects]::
332 Converts old-style GIT repository
333 Previously this command was known as git-convert-cache.
335 link:git-cvsimport.html[git-cvsimport]::
336 Salvage your data out of another SCM people love to hate.
337 Previously this command was known as git-cvsimport-script.
339 link:git-merge-one-file.html[git-merge-one-file]::
340 The standard helper program to use with "git-merge-index"
341 Previously this command was known as git-merge-one-file-script.
343 link:git-prune.html[git-prune]::
344 Prunes all unreachable objects from the object database
345 Previously this command was known as git-prune-script.
347 link:git-relink.html[git-relink]::
348 Hardlink common objects in local repositories.
349 Previously this command was known as git-relink-script.
351 link:git-sh-setup.html[git-sh-setup]::
352 Common git shell script setup code.
353 Previously this command was known as git-sh-setup-script.
355 link:git-tag.html[git-tag]::
356 An example script to create a tag object signed with GPG
357 Previously this command was known as git-tag-script.
362 link:git-build-rev-cache.html[git-build-rev-cache]::
363 Create or update a rev-cache file.
365 link:git-cherry.html[git-cherry]::
366 Find commits not merged upstream.
368 link:git-count-objects.html[git-count-objects]::
369 Count unpacked number of objects and their disk consumption.
370 Previously this command was known as git-count-objects-script.
372 link:git-daemon.html[git-daemon]::
373 A really simple server for GIT repositories.
375 link:git-diff-helper.html[git-diff-helper]::
376 Generates patch format output for git-diff-*
378 link:git-get-tar-commit-id.html[git-get-tar-commit-id]::
379 Extract commit ID from an archive created using git-tar-tree.
381 link:git-mailinfo.html[git-mailinfo]::
382 Extracts patch from a single e-mail message.
384 link:git-mailsplit.html[git-mailsplit]::
387 link:git-patch-id.html[git-patch-id]::
388 Compute unique ID for a patch.
390 link:git-parse-remote.html[git-parse-remote]::
391 Routines to help parsing $GIT_DIR/remotes/
392 Previously this command was known as git-parse-remote-script.
394 link:git-request-pull.html[git-request-pull]::
396 Previously this command was known as git-request-pull-script.
398 link:git-rev-parse.html[git-rev-parse]::
399 Pick out and massage parameters.
401 link:git-send-email.html[git-send-email]::
402 Send patch e-mails out of "format-patch --mbox" output.
403 Previously this command was known as git-send-email-script.
405 link:git-show-rev-cache.html[git-show-rev-cache]::
406 Show the contents of a rev-cache file.
408 link:git-stripspace.html[git-stripspace]::
409 Filter out empty lines.
412 Commands not yet documented
413 ---------------------------
415 link:gitk.html[gitk]::
419 Identifier Terminology
420 ----------------------
422 Indicates the sha1 identifier for any type of object
425 Indicates a blob object sha1 identifier
428 Indicates a tree object sha1 identifier
431 Indicates a commit object sha1 identifier
434 Indicates a tree, commit or tag object sha1 identifier. A
435 command that takes a <tree-ish> argument ultimately wants to
436 operate on a <tree> object but automatically dereferences
437 <commit> and <tag> objects that point at a <tree>.
440 Indicates that an object type is required.
441 Currently one of: blob/tree/commit/tag
444 Indicates a filename - always relative to the root of
445 the tree structure GIT_INDEX_FILE describes.
449 Any git command accepting any <object> can also use the following
453 indicates the head of the repository (ie the contents of
457 (ie the contents of `$GIT_DIR/refs/tags/<tag>`)
460 (ie the contents of `$GIT_DIR/refs/heads/<head>`)
462 a valid snapshot 'name'+
463 (ie the contents of `$GIT_DIR/refs/snap/<snap>`)
466 File/Directory Structure
467 ------------------------
469 Please see link:repository-layout.html[repository layout] document.
471 Higher level SCMs may provide and manage additional information in the
477 Please see link:glossary.html[glossary] document.
480 Environment Variables
481 ---------------------
482 Various git commands use the following environment variables:
486 These environment variables apply to 'all' core git commands. Nb: it
487 is worth noting that they may be used/overridden by SCMS sitting above
488 git so take care if using Cogito etc
491 This environment allows the specification of an alternate
492 cache/index file. If not specified, the default of
493 `$GIT_DIR/index` is used.
495 'GIT_OBJECT_DIRECTORY'::
496 If the object storage directory is specified via this
497 environment variable then the sha1 directories are created
498 underneath - otherwise the default `$GIT_DIR/objects`
501 'GIT_ALTERNATE_OBJECT_DIRECTORIES'::
502 Due to the immutable nature of git objects, old objects can be
503 archived into shared, read-only directories. This variable
504 specifies a ":" separated list of git object directories which
505 can be used to search for git objects. New objects will not be
506 written to these directories.
509 If the 'GIT_DIR' environment variable is set then it specifies
510 a path to use instead of `./.git` for the base of the
518 'GIT_COMMITTER_NAME'::
519 'GIT_COMMITTER_EMAIL'::
520 see link:git-commit-tree.html[git-commit-tree]
525 'GIT_EXTERNAL_DIFF'::
526 see the "generating patches" section in :
527 link:git-diff-index.html[git-diff-index];
528 link:git-diff-files.html[git-diff-files];
529 link:git-diff-tree.html[git-diff-tree]
531 Discussion[[Discussion]]
532 ------------------------
537 Written by Linus Torvalds <torvalds@osdl.org> and the git-list <git@vger.kernel.org>.
541 Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.
545 Part of the link:git.html[git] suite