NAME

git-archive - Create an archive of files from a named tree

SYNOPSIS

  1. git archive [--format=<fmt>] [--list] [--prefix=<prefix>/] [<extra>]
  2.           [-o <file> | --output=<file>] [--worktree-attributes]
  3.           [--remote=<repo> [--exec=<git-upload-archive>]] <tree-ish>
  4.           [<path>…​]

DESCRIPTION

Creates an archive of the specified format containing the treestructure for the named tree, and writes it out to the standardoutput. If <prefix> is specified it isprepended to the filenames in the archive.

git archive behaves differently when given a tree ID versus whengiven a commit ID or tag ID. In the first case the current time isused as the modification time of each file in the archive. In the lattercase the commit time as recorded in the referenced commit object isused instead. Additionally the commit ID is stored in a globalextended pax header if the tar format is used; it can be extractedusing git get-tar-commit-id. In ZIP files it is stored as a filecomment.

OPTIONS

  • —format=

  • Format of the resulting archive: tar or zip. If this optionis not given, and the output file is specified, the format isinferred from the filename if possible (e.g. writing to "foo.zip"makes the output to be in the zip format). Otherwise the outputformat is tar.

  • -l

  • —list

  • Show all available formats.

  • -v

  • —verbose

  • Report progress to stderr.

  • —prefix=/

  • Prepend / to each filename in the archive.

  • -o

  • —output=

  • Write the archive to instead of stdout.

  • —worktree-attributes

  • Look for attributes in .gitattributes files in the working treeas well (see ATTRIBUTES).

  • This can be any options that the archiver backend understands.See next section.

  • —remote=

  • Instead of making a tar archive from the local repository,retrieve a tar archive from a remote repository. Note that theremote repository may place restrictions on which sha1expressions may be allowed in <tree-ish>. Seegit-upload-archive[1] for details.

  • —exec=

  • Used with —remote to specify the path to thegit-upload-archive on the remote side.

  • The tree or commit to produce an archive for.

  • Without an optional path parameter, all files and subdirectoriesof the current working directory are included in the archive.If one or more paths are specified, only these are included.

BACKEND EXTRA OPTIONS

zip

  • -0

  • Store the files instead of deflating them.

  • -9

  • Highest and slowest compression level. You can specify anynumber from 1 to 9 to adjust compression speed and ratio.

CONFIGURATION

  • tar.umask

  • This variable can be used to restrict the permission bits oftar archive entries. The default is 0002, which turns off theworld write bit. The special value "user" indicates that thearchiving user’s umask will be used instead. See umask(2) fordetails. If —remote is used then only the configuration ofthe remote repository takes effect.

  • tar..command

  • This variable specifies a shell command through which the taroutput generated by git archive should be piped. The commandis executed using the shell with the generated tar file on itsstandard input, and should produce the final output on itsstandard output. Any compression-level options will be passedto the command (e.g., "-9"). An output file with the sameextension as <format> will be use this format if no otherformat is given.

The "tar.gz" and "tgz" formats are defined automatically and default togzip -cn. You may override them with custom commands.

  • tar..remote
  • If true, enable <format> for use by remote clients viagit-upload-archive[1]. Defaults to false foruser-defined formats, but true for the "tar.gz" and "tgz"formats.

ATTRIBUTES

  • export-ignore

  • Files and directories with the attribute export-ignore won’t beadded to archive files. See gitattributes[5] for details.

  • export-subst

  • If the attribute export-subst is set for a file then Git willexpand several placeholders when adding this file to an archive.See gitattributes[5] for details.

Note that attributes are by default taken from the .gitattributes filesin the tree that is being archived. If you want to tweak the way theoutput is generated after the fact (e.g. you committed without adding anappropriate export-ignore in its .gitattributes), adjust the checked out.gitattributes file as necessary and use —worktree-attributesoption. Alternatively you can keep necessary attributes that should applywhile archiving any tree in your $GIT_DIR/info/attributes file.

EXAMPLES

  • git archive —format=tar —prefix=junk/ HEAD | (cd /var/tmp/ && tar xf -)

  • Create a tar archive that contains the contents of thelatest commit on the current branch, and extract it in the/var/tmp/junk directory.

  • git archive —format=tar —prefix=git-1.4.0/ v1.4.0 | gzip >git-1.4.0.tar.gz

  • Create a compressed tarball for v1.4.0 release.

  • git archive —format=tar.gz —prefix=git-1.4.0/ v1.4.0 >git-1.4.0.tar.gz

  • Same as above, but using the builtin tar.gz handling.

  • git archive —prefix=git-1.4.0/ -o git-1.4.0.tar.gz v1.4.0

  • Same as above, but the format is inferred from the output file.

  • git archive —format=tar —prefix=git-1.4.0/ v1.4.0^{tree} | gzip >git-1.4.0.tar.gz

  • Create a compressed tarball for v1.4.0 release, but without aglobal extended pax header.

  • git archive —format=zip —prefix=git-docs/ HEAD:Documentation/ > git-1.4.0-docs.zip

  • Put everything in the current head’s Documentation/ directoryinto git-1.4.0-docs.zip, with the prefix git-docs/.

  • git archive -o latest.zip HEAD

  • Create a Zip archive that contains the contents of the latestcommit on the current branch. Note that the output format isinferred by the extension of the output file.

  • git config tar.tar.xz.command "xz -c"

  • Configure a "tar.xz" format for making LZMA-compressed tarfiles.You can use it specifying —format=tar.xz, or by creating anoutput file like -o foo.tar.xz.

SEE ALSO

gitattributes[5]

GIT

Part of the git[1] suite