]>
Commit | Line | Data |
---|---|---|
4df096a5 FBH |
1 | git-archive(1) |
2 | ============== | |
3 | ||
4 | NAME | |
5 | ---- | |
29cf5e12 | 6 | git-archive - Create an archive of files from a named tree |
4df096a5 FBH |
7 | |
8 | ||
9 | SYNOPSIS | |
10 | -------- | |
e448ff87 | 11 | [verse] |
82d97da3 | 12 | 'git archive' [--format=<fmt>] [--list] [--prefix=<prefix>/] [<extra>] |
0460ed2c | 13 | [-o <file> | --output=<file>] [--worktree-attributes] |
c005c6aa | 14 | [--remote=<repo> [--exec=<git-upload-archive>]] <tree-ish> |
62b4698e | 15 | [<path>...] |
4df096a5 FBH |
16 | |
17 | DESCRIPTION | |
18 | ----------- | |
19 | Creates an archive of the specified format containing the tree | |
42b5f869 JA |
20 | structure for the named tree, and writes it out to the standard |
21 | output. If <prefix> is specified it is | |
4df096a5 FBH |
22 | prepended to the filenames in the archive. |
23 | ||
0b444cdb | 24 | 'git archive' behaves differently when given a tree ID versus when |
4df096a5 | 25 | given a commit ID or tag ID. In the first case the current time is |
3f7cdf32 | 26 | used as the modification time of each file in the archive. In the latter |
4df096a5 FBH |
27 | case the commit time as recorded in the referenced commit object is |
28 | used instead. Additionally the commit ID is stored in a global | |
29 | extended pax header if the tar format is used; it can be extracted | |
0b444cdb | 30 | using 'git get-tar-commit-id'. In ZIP files it is stored as a file |
4df096a5 FBH |
31 | comment. |
32 | ||
33 | OPTIONS | |
34 | ------- | |
35 | ||
36 | --format=<fmt>:: | |
0f4b377c DP |
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`. | |
4df096a5 | 42 | |
3240240f SB |
43 | -l:: |
44 | --list:: | |
4df096a5 FBH |
45 | Show all available formats. |
46 | ||
3240240f SB |
47 | -v:: |
48 | --verbose:: | |
27c8f8cd AR |
49 | Report progress to stderr. |
50 | ||
4df096a5 FBH |
51 | --prefix=<prefix>/:: |
52 | Prepend <prefix>/ to each filename in the archive. | |
53 | ||
05d3951e | 54 | -o <file>:: |
aec0c1bb CMDV |
55 | --output=<file>:: |
56 | Write the archive to <file> instead of stdout. | |
57 | ||
2947a793 RS |
58 | --add-file=<file>:: |
59 | Add a non-tracked file to the archive. Can be repeated to add | |
60 | multiple files. The path of the file in the archive is built | |
61 | by concatenating the value for `--prefix` (if any) and the | |
62 | basename of <file>. | |
63 | ||
ba053ea9 | 64 | --worktree-attributes:: |
59a7714c RS |
65 | Look for attributes in .gitattributes files in the working tree |
66 | as well (see <<ATTRIBUTES>>). | |
ba053ea9 | 67 | |
4df096a5 | 68 | <extra>:: |
3f7cdf32 | 69 | This can be any options that the archiver backend understands. |
e8daf78a | 70 | See next section. |
4df096a5 FBH |
71 | |
72 | --remote=<repo>:: | |
3f7cdf32 | 73 | Instead of making a tar archive from the local repository, |
69897bc2 JK |
74 | retrieve a tar archive from a remote repository. Note that the |
75 | remote repository may place restrictions on which sha1 | |
76 | expressions may be allowed in `<tree-ish>`. See | |
77 | linkgit:git-upload-archive[1] for details. | |
4df096a5 | 78 | |
c005c6aa MB |
79 | --exec=<git-upload-archive>:: |
80 | Used with --remote to specify the path to the | |
ba020ef5 | 81 | 'git-upload-archive' on the remote side. |
c005c6aa | 82 | |
4df096a5 FBH |
83 | <tree-ish>:: |
84 | The tree or commit to produce an archive for. | |
85 | ||
62b4698e | 86 | <path>:: |
165ca621 RS |
87 | Without an optional path parameter, all files and subdirectories |
88 | of the current working directory are included in the archive. | |
89 | If one or more paths are specified, only these are included. | |
4df096a5 | 90 | |
e8daf78a FBH |
91 | BACKEND EXTRA OPTIONS |
92 | --------------------- | |
93 | ||
94 | zip | |
95 | ~~~ | |
96 | -0:: | |
97 | Store the files instead of deflating them. | |
98 | -9:: | |
99 | Highest and slowest compression level. You can specify any | |
100 | number from 1 to 9 to adjust compression speed and ratio. | |
101 | ||
102 | ||
4df096a5 FBH |
103 | CONFIGURATION |
104 | ------------- | |
4df096a5 | 105 | |
687157c7 RS |
106 | tar.umask:: |
107 | This variable can be used to restrict the permission bits of | |
108 | tar archive entries. The default is 0002, which turns off the | |
109 | world write bit. The special value "user" indicates that the | |
110 | archiving user's umask will be used instead. See umask(2) for | |
810cae53 RS |
111 | details. If `--remote` is used then only the configuration of |
112 | the remote repository takes effect. | |
4df096a5 | 113 | |
767cf457 JK |
114 | tar.<format>.command:: |
115 | This variable specifies a shell command through which the tar | |
116 | output generated by `git archive` should be piped. The command | |
117 | is executed using the shell with the generated tar file on its | |
118 | standard input, and should produce the final output on its | |
119 | standard output. Any compression-level options will be passed | |
120 | to the command (e.g., "-9"). An output file with the same | |
121 | extension as `<format>` will be use this format if no other | |
122 | format is given. | |
0e804e09 JK |
123 | + |
124 | The "tar.gz" and "tgz" formats are defined automatically and default to | |
125 | `gzip -cn`. You may override them with custom commands. | |
767cf457 | 126 | |
7b97730b JK |
127 | tar.<format>.remote:: |
128 | If true, enable `<format>` for use by remote clients via | |
129 | linkgit:git-upload-archive[1]. Defaults to false for | |
130 | user-defined formats, but true for the "tar.gz" and "tgz" | |
131 | formats. | |
132 | ||
59a7714c | 133 | [[ATTRIBUTES]] |
8d1b9d23 RL |
134 | ATTRIBUTES |
135 | ---------- | |
136 | ||
137 | export-ignore:: | |
138 | Files and directories with the attribute export-ignore won't be | |
139 | added to archive files. See linkgit:gitattributes[5] for details. | |
140 | ||
141 | export-subst:: | |
2de9b711 | 142 | If the attribute export-subst is set for a file then Git will |
8d1b9d23 RL |
143 | expand several placeholders when adding this file to an archive. |
144 | See linkgit:gitattributes[5] for details. | |
145 | ||
9b4c8b0a JH |
146 | Note that attributes are by default taken from the `.gitattributes` files |
147 | in the tree that is being archived. If you want to tweak the way the | |
148 | output is generated after the fact (e.g. you committed without adding an | |
149 | appropriate export-ignore in its `.gitattributes`), adjust the checked out | |
fc7642a0 | 150 | `.gitattributes` file as necessary and use `--worktree-attributes` |
9b4c8b0a JH |
151 | option. Alternatively you can keep necessary attributes that should apply |
152 | while archiving any tree in your `$GIT_DIR/info/attributes` file. | |
153 | ||
4df096a5 FBH |
154 | EXAMPLES |
155 | -------- | |
5d2fc913 | 156 | `git archive --format=tar --prefix=junk/ HEAD | (cd /var/tmp/ && tar xf -)`:: |
4df096a5 FBH |
157 | |
158 | Create a tar archive that contains the contents of the | |
3f7cdf32 | 159 | latest commit on the current branch, and extract it in the |
4df096a5 FBH |
160 | `/var/tmp/junk` directory. |
161 | ||
5d2fc913 | 162 | `git archive --format=tar --prefix=git-1.4.0/ v1.4.0 | gzip >git-1.4.0.tar.gz`:: |
4df096a5 FBH |
163 | |
164 | Create a compressed tarball for v1.4.0 release. | |
165 | ||
5d2fc913 | 166 | `git archive --format=tar.gz --prefix=git-1.4.0/ v1.4.0 >git-1.4.0.tar.gz`:: |
0e804e09 JK |
167 | |
168 | Same as above, but using the builtin tar.gz handling. | |
169 | ||
5d2fc913 | 170 | `git archive --prefix=git-1.4.0/ -o git-1.4.0.tar.gz v1.4.0`:: |
0e804e09 JK |
171 | |
172 | Same as above, but the format is inferred from the output file. | |
173 | ||
6cf378f0 | 174 | `git archive --format=tar --prefix=git-1.4.0/ v1.4.0^{tree} | gzip >git-1.4.0.tar.gz`:: |
4df096a5 FBH |
175 | |
176 | Create a compressed tarball for v1.4.0 release, but without a | |
177 | global extended pax header. | |
178 | ||
5d2fc913 | 179 | `git archive --format=zip --prefix=git-docs/ HEAD:Documentation/ > git-1.4.0-docs.zip`:: |
4df096a5 FBH |
180 | |
181 | Put everything in the current head's Documentation/ directory | |
182 | into 'git-1.4.0-docs.zip', with the prefix 'git-docs/'. | |
183 | ||
5d2fc913 | 184 | `git archive -o latest.zip HEAD`:: |
0f4b377c DP |
185 | |
186 | Create a Zip archive that contains the contents of the latest | |
187 | commit on the current branch. Note that the output format is | |
188 | inferred by the extension of the output file. | |
189 | ||
5d2fc913 | 190 | `git config tar.tar.xz.command "xz -c"`:: |
767cf457 JK |
191 | |
192 | Configure a "tar.xz" format for making LZMA-compressed tarfiles. | |
193 | You can use it specifying `--format=tar.xz`, or by creating an | |
194 | output file like `-o foo.tar.xz`. | |
195 | ||
8d1b9d23 RL |
196 | |
197 | SEE ALSO | |
198 | -------- | |
199 | linkgit:gitattributes[5] | |
200 | ||
4df096a5 FBH |
201 | GIT |
202 | --- | |
9e1f0a85 | 203 | Part of the linkgit:git[1] suite |