NAME
git-archive - Create an archive of files from a named tree
SYNOPSIS
git archive\n [--format=<fmt>] [--list] [--prefix=<prefix>/] [<extra>]
\n
[-o <file> | --output=<file>] [--worktree-attributes]
\n
[--remote=<repo> [--exec=<git-upload-archive>]] <tree-ish>
\n
[<path>...]DESCRIPTION
Creates an archive of the specified format containing the tree structure for the named tree, and writes it out to the standard output. If <prefix> is specified it is prepended to the filenames in the archive.
git archive behaves differently when given a tree ID as opposed to a commit ID or tag ID. When a tree ID is provided, the current time is used as the modification time of each file in the archive. On the other hand, when a commit ID or tag ID is provided, the commit time as recorded in the referenced commit object is used instead. Additionally the commit ID is stored in a global extended pax header if the tar format is used; it can be extracted using git get-tar-commit-id. In ZIP files it is stored as a file comment.
OPTIONS
--format=<fmt>
-l, --list
-v, --verbose
--prefix=<prefix>/
-o <file>, --output=<file>
--add-file=<file>
--add-virtual-file=<path>:<content>
The <path> argument can start and end with a literal double-quote character; the contained file name is interpreted as a C-style string, i.e. the backslash is interpreted as escape character. The path must be quoted if it contains a colon, to avoid the colon from being misinterpreted as the separator between the path and the contents, or if the path begins or ends with a double-quote character.
The file mode is limited to a regular file, and the option may be subject to platform-dependent command-line limits. For non-trivial cases, write an untracked file and use --add-file instead.
Note that unlike --add-file the path created in the archive is not affected by the --prefix option, as a full <path> can be given as the value of the option.
--worktree-attributes
--mtime=<time>
<extra>
--remote=<repo>
--exec=<git-upload-archive>
<tree-ish>
<path>
BACKEND EXTRA OPTIONS
zip
-<digit>
tar
-<number>
CONFIGURATION
tar.umask
tar.<format>.command
The tar.gz and tgz formats are defined automatically and use the magic command git archive gzip by default, which invokes an internal implementation of gzip.
tar.<format>.remote
ATTRIBUTES
export-ignore
export-subst
Note that attributes are by default taken from the .gitattributes files in the tree that is being archived. If you want to tweak the way the output is generated after the fact (e.g. you committed without adding an appropriate export-ignore in its .gitattributes), adjust the checked out .gitattributes file as necessary and use --worktree-attributes option. Alternatively you can keep necessary attributes that should apply while archiving any tree in your $GIT_DIR/info/attributes file.
EXAMPLES
git archive --format=tar --prefix=junk/ HEAD | (cd /var/tmp/ && tar xf -)
git archive --format=tar --prefix=git-1.4.0/ v1.4.0 | gzip >git-1.4.0.tar.gz
git archive --format=tar.gz --prefix=git-1.4.0/ v1.4.0 >git-1.4.0.tar.gz
git archive --prefix=git-1.4.0/ -o git-1.4.0.tar.gz v1.4.0
git archive --format=tar --prefix=git-1.4.0/ v1.4.0^{tree} | gzip >git-1.4.0.tar.gz
git archive --format=zip --prefix=git-docs/ HEAD:Documentation/ > git-1.4.0-docs.zip
git archive -o latest.zip HEAD
git archive -o latest.tar --prefix=build/ --add-file=configure --prefix= HEAD
git config tar.tar.xz.command "xz -c"
SEE ALSO
gitattributes(5)
GIT
Part of the git(1) suite