Documentation/git-archive.txt

   1 git-archive(1)
   2 ==============
   3
   4 NAME
   5 ----
   6 git-archive - Create an archive of files from a named tree
   7
   8
   9 SYNOPSIS
  10 --------
  11 [verse]
  12 'git archive' [--format=<fmt>] [--list] [--prefix=<prefix>/] [<extra>]
  13               [-o <file> | --output=<file>] [--worktree-attributes]
  14               [--remote=<repo> [--exec=<git-upload-archive>]] <tree-ish>
  15               [<path>...]
  16
  17 DESCRIPTION
  18 -----------
  19 Creates an archive of the specified format containing the tree
  20 structure for the named tree, and writes it out to the standard
  21 output.  If <prefix> is specified it is
  22 prepended to the filenames in the archive.
  23
  24 'git archive' behaves differently when given a tree ID versus when
  25 given a commit ID or tag ID.  In the first case the current time is
  26 used as the modification time of each file in the archive.  In the latter
  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
  30 using 'git get-tar-commit-id'. In ZIP files it is stored as a file
  31 comment.
  32
  33 OPTIONS
  34 -------
  35
  36 --format=<fmt>::
  37         Format of the resulting archive. Possible values are `tar`,
  38         `zip`, `tar.gz`, `tgz`, and any format defined using the
  39         configuration option `tar.<format>.command`. If `--format`
  40         is not given, and the output file is specified, the format is
  41         inferred from the filename if possible (e.g. writing to `foo.zip`
  42         makes the output to be in the `zip` format). Otherwise the output
  43         format is `tar`.
  44
  45 -l::
  46 --list::
  47         Show all available formats.
  48
  49 -v::
  50 --verbose::
  51         Report progress to stderr.
  52
  53 --prefix=<prefix>/::
  54         Prepend <prefix>/ to paths in the archive.  Can be repeated; its
  55         rightmost value is used for all tracked files.  See below which
  56         value gets used by `--add-file` and `--add-virtual-file`.
  57
  58 -o <file>::
  59 --output=<file>::
  60         Write the archive to <file> instead of stdout.
  61
  62 --add-file=<file>::
  63         Add a non-tracked file to the archive.  Can be repeated to add
  64         multiple files.  The path of the file in the archive is built by
  65         concatenating the value of the last `--prefix` option (if any)
  66         before this `--add-file` and the basename of <file>.
  67
  68 --add-virtual-file=<path>:<content>::
  69         Add the specified contents to the archive.  Can be repeated to add
  70         multiple files.  The path of the file in the archive is built
  71         by concatenating the value of the last `--prefix` option (if any)
  72         before this `--add-virtual-file` and `<path>`.
  73 +
  74 The `<path>` argument can start and end with a literal double-quote
  75 character; the contained file name is interpreted as a C-style string,
  76 i.e. the backslash is interpreted as escape character. The path must
  77 be quoted if it contains a colon, to avoid the colon from being
  78 misinterpreted as the separator between the path and the contents, or
  79 if the path begins or ends with a double-quote character.
  80 +
  81 The file mode is limited to a regular file, and the option may be
  82 subject to platform-dependent command-line limits. For non-trivial
  83 cases, write an untracked file and use `--add-file` instead.
  84
  85 --worktree-attributes::
  86         Look for attributes in .gitattributes files in the working tree
  87         as well (see <<ATTRIBUTES>>).
  88
  89 <extra>::
  90         This can be any options that the archiver backend understands.
  91         See next section.
  92
  93 --remote=<repo>::
  94         Instead of making a tar archive from the local repository,
  95         retrieve a tar archive from a remote repository. Note that the
  96         remote repository may place restrictions on which sha1
  97         expressions may be allowed in `<tree-ish>`. See
  98         linkgit:git-upload-archive[1] for details.
  99
 100 --exec=<git-upload-archive>::
 101         Used with --remote to specify the path to the
 102         'git-upload-archive' on the remote side.
 103
 104 <tree-ish>::
 105         The tree or commit to produce an archive for.
 106
 107 <path>::
 108         Without an optional path parameter, all files and subdirectories
 109         of the current working directory are included in the archive.
 110         If one or more paths are specified, only these are included.
 111
 112 BACKEND EXTRA OPTIONS
 113 ---------------------
 114
 115 zip
 116 ~~~
 117 -<digit>::
 118         Specify compression level.  Larger values allow the command
 119         to spend more time to compress to smaller size.  Supported
 120         values are from `-0` (store-only) to `-9` (best ratio).
 121         Default is `-6` if not given.
 122
 123 tar
 124 ~~~
 125 -<number>::
 126         Specify compression level. The value will be passed to the
 127         compression command configured in `tar.<format>.command`. See
 128         manual page of the configured command for the list of supported
 129         levels and the default level if this option isn't specified.
 130
 131 CONFIGURATION
 132 -------------
 133
 134 tar.umask::
 135         This variable can be used to restrict the permission bits of
 136         tar archive entries.  The default is 0002, which turns off the
 137         world write bit.  The special value "user" indicates that the
 138         archiving user's umask will be used instead.  See umask(2) for
 139         details.  If `--remote` is used then only the configuration of
 140         the remote repository takes effect.
 141
 142 tar.<format>.command::
 143         This variable specifies a shell command through which the tar
 144         output generated by `git archive` should be piped. The command
 145         is executed using the shell with the generated tar file on its
 146         standard input, and should produce the final output on its
 147         standard output. Any compression-level options will be passed
 148         to the command (e.g., `-9`).
 149 +
 150 The `tar.gz` and `tgz` formats are defined automatically and use the
 151 magic command `git archive gzip` by default, which invokes an internal
 152 implementation of gzip.
 153
 154 tar.<format>.remote::
 155         If true, enable the format for use by remote clients via
 156         linkgit:git-upload-archive[1]. Defaults to false for
 157         user-defined formats, but true for the `tar.gz` and `tgz`
 158         formats.
 159
 160 [[ATTRIBUTES]]
 161 ATTRIBUTES
 162 ----------
 163
 164 export-ignore::
 165         Files and directories with the attribute export-ignore won't be
 166         added to archive files.  See linkgit:gitattributes[5] for details.
 167
 168 export-subst::
 169         If the attribute export-subst is set for a file then Git will
 170         expand several placeholders when adding this file to an archive.
 171         See linkgit:gitattributes[5] for details.
 172
 173 Note that attributes are by default taken from the `.gitattributes` files
 174 in the tree that is being archived.  If you want to tweak the way the
 175 output is generated after the fact (e.g. you committed without adding an
 176 appropriate export-ignore in its `.gitattributes`), adjust the checked out
 177 `.gitattributes` file as necessary and use `--worktree-attributes`
 178 option.  Alternatively you can keep necessary attributes that should apply
 179 while archiving any tree in your `$GIT_DIR/info/attributes` file.
 180
 181 EXAMPLES
 182 --------
 183 `git archive --format=tar --prefix=junk/ HEAD | (cd /var/tmp/ && tar xf -)`::
 184
 185         Create a tar archive that contains the contents of the
 186         latest commit on the current branch, and extract it in the
 187         `/var/tmp/junk` directory.
 188
 189 `git archive --format=tar --prefix=git-1.4.0/ v1.4.0 | gzip >git-1.4.0.tar.gz`::
 190
 191         Create a compressed tarball for v1.4.0 release.
 192
 193 `git archive --format=tar.gz --prefix=git-1.4.0/ v1.4.0 >git-1.4.0.tar.gz`::
 194
 195         Same as above, but using the builtin tar.gz handling.
 196
 197 `git archive --prefix=git-1.4.0/ -o git-1.4.0.tar.gz v1.4.0`::
 198
 199         Same as above, but the format is inferred from the output file.
 200
 201 `git archive --format=tar --prefix=git-1.4.0/ v1.4.0^{tree} | gzip >git-1.4.0.tar.gz`::
 202
 203         Create a compressed tarball for v1.4.0 release, but without a
 204         global extended pax header.
 205
 206 `git archive --format=zip --prefix=git-docs/ HEAD:Documentation/ > git-1.4.0-docs.zip`::
 207
 208         Put everything in the current head's Documentation/ directory
 209         into 'git-1.4.0-docs.zip', with the prefix 'git-docs/'.
 210
 211 `git archive -o latest.zip HEAD`::
 212
 213         Create a Zip archive that contains the contents of the latest
 214         commit on the current branch. Note that the output format is
 215         inferred by the extension of the output file.
 216
 217 `git archive -o latest.tar --prefix=build/ --add-file=configure --prefix= HEAD`::
 218
 219         Creates a tar archive that contains the contents of the latest
 220         commit on the current branch with no prefix and the untracked
 221         file 'configure' with the prefix 'build/'.
 222
 223 `git config tar.tar.xz.command "xz -c"`::
 224
 225         Configure a "tar.xz" format for making LZMA-compressed tarfiles.
 226         You can use it specifying `--format=tar.xz`, or by creating an
 227         output file like `-o foo.tar.xz`.
 228
 229
 230 SEE ALSO
 231 --------
 232 linkgit:gitattributes[5]
 233
 234 GIT
 235 ---
 236 Part of the linkgit:git[1] suite