1git-archive(1) 2============== 3 4NAME 5---- 6git-archive - Create an archive of files from a named tree 7 8 9SYNOPSIS 10-------- 11[verse] 12'git archive' [--format=<fmt>] [--list] [--prefix=<prefix>/] [<extra>] 13 [-o | --output=<file>] [--worktree-attributes] 14 [--remote=<repo> [--exec=<git-upload-archive>]] <tree-ish> 15 [<path>...] 16 17DESCRIPTION 18----------- 19Creates an archive of the specified format containing the tree 20structure for the named tree, and writes it out to the standard 21output. If <prefix> is specified it is 22prepended to the filenames in the archive. 23 24'git archive' behaves differently when given a tree ID versus when 25given a commit ID or tag ID. In the first case the current time is 26used as the modification time of each file in the archive. In the latter 27case the commit time as recorded in the referenced commit object is 28used instead. Additionally the commit ID is stored in a global 29extended pax header if the tar format is used; it can be extracted 30using 'git get-tar-commit-id'. In ZIP files it is stored as a file 31comment. 32 33OPTIONS 34------- 35 36--format=<fmt>:: 37 Format of the resulting archive: 'tar' or 'zip'. If this option 38 is not given, and the output file is specified, the format is 39 inferred from the filename if possible (e.g. writing to "foo.zip" 40 makes the output to be in the zip format). Otherwise the output 41 format is `tar`. 42 43-l:: 44--list:: 45 Show all available formats. 46 47-v:: 48--verbose:: 49 Report progress to stderr. 50 51--prefix=<prefix>/:: 52 Prepend <prefix>/ to each filename in the archive. 53 54-o <file>:: 55--output=<file>:: 56 Write the archive to <file> instead of stdout. 57 58--worktree-attributes:: 59 Look for attributes in .gitattributes in working directory too. 60 61<extra>:: 62 This can be any options that the archiver backend understands. 63 See next section. 64 65--remote=<repo>:: 66 Instead of making a tar archive from the local repository, 67 retrieve a tar archive from a remote repository. 68 69--exec=<git-upload-archive>:: 70 Used with --remote to specify the path to the 71 'git-upload-archive' on the remote side. 72 73<tree-ish>:: 74 The tree or commit to produce an archive for. 75 76<path>:: 77 Without an optional path parameter, all files and subdirectories 78 of the current working directory are included in the archive. 79 If one or more paths are specified, only these are included. 80 81BACKEND EXTRA OPTIONS 82--------------------- 83 84zip 85~~~ 86-0:: 87 Store the files instead of deflating them. 88-9:: 89 Highest and slowest compression level. You can specify any 90 number from 1 to 9 to adjust compression speed and ratio. 91 92 93CONFIGURATION 94------------- 95 96tar.umask:: 97 This variable can be used to restrict the permission bits of 98 tar archive entries. The default is 0002, which turns off the 99 world write bit. The special value "user" indicates that the 100 archiving user's umask will be used instead. See umask(2) for 101 details. If `--remote` is used then only the configuration of 102 the remote repository takes effect. 103 104ATTRIBUTES 105---------- 106 107export-ignore:: 108 Files and directories with the attribute export-ignore won't be 109 added to archive files. See linkgit:gitattributes[5] for details. 110 111export-subst:: 112 If the attribute export-subst is set for a file then git will 113 expand several placeholders when adding this file to an archive. 114 See linkgit:gitattributes[5] for details. 115 116Note that attributes are by default taken from the `.gitattributes` files 117in the tree that is being archived. If you want to tweak the way the 118output is generated after the fact (e.g. you committed without adding an 119appropriate export-ignore in its `.gitattributes`), adjust the checked out 120`.gitattributes` file as necessary and use `--worktree-attributes` 121option. Alternatively you can keep necessary attributes that should apply 122while archiving any tree in your `$GIT_DIR/info/attributes` file. 123 124EXAMPLES 125-------- 126git archive --format=tar --prefix=junk/ HEAD | (cd /var/tmp/ && tar xf -):: 127 128 Create a tar archive that contains the contents of the 129 latest commit on the current branch, and extract it in the 130 `/var/tmp/junk` directory. 131 132git archive --format=tar --prefix=git-1.4.0/ v1.4.0 | gzip >git-1.4.0.tar.gz:: 133 134 Create a compressed tarball for v1.4.0 release. 135 136git archive --format=tar --prefix=git-1.4.0/ v1.4.0{caret}\{tree\} | gzip >git-1.4.0.tar.gz:: 137 138 Create a compressed tarball for v1.4.0 release, but without a 139 global extended pax header. 140 141git archive --format=zip --prefix=git-docs/ HEAD:Documentation/ > git-1.4.0-docs.zip:: 142 143 Put everything in the current head's Documentation/ directory 144 into 'git-1.4.0-docs.zip', with the prefix 'git-docs/'. 145 146git archive -o latest.zip HEAD:: 147 148 Create a Zip archive that contains the contents of the latest 149 commit on the current branch. Note that the output format is 150 inferred by the extension of the output file. 151 152 153SEE ALSO 154-------- 155linkgit:gitattributes[5] 156 157GIT 158--- 159Part of the linkgit:git[1] suite