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 | --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: '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 files in the working tree
  60         as well (see <<ATTRIBUTES>>).
  61
  62 <extra>::
  63         This can be any options that the archiver backend understands.
  64         See next section.
  65
  66 --remote=<repo>::
  67         Instead of making a tar archive from the local repository,
  68         retrieve a tar archive from a remote repository.
  69
  70 --exec=<git-upload-archive>::
  71         Used with --remote to specify the path to the
  72         'git-upload-archive' on the remote side.
  73
  74 <tree-ish>::
  75         The tree or commit to produce an archive for.
  76
  77 <path>::
  78         Without an optional path parameter, all files and subdirectories
  79         of the current working directory are included in the archive.
  80         If one or more paths are specified, only these are included.
  81
  82 BACKEND EXTRA OPTIONS
  83 ---------------------
  84
  85 zip
  86 ~~~
  87 -0::
  88         Store the files instead of deflating them.
  89 -9::
  90         Highest and slowest compression level.  You can specify any
  91         number from 1 to 9 to adjust compression speed and ratio.
  92
  93
  94 CONFIGURATION
  95 -------------
  96
  97 tar.umask::
  98         This variable can be used to restrict the permission bits of
  99         tar archive entries.  The default is 0002, which turns off the
 100         world write bit.  The special value "user" indicates that the
 101         archiving user's umask will be used instead.  See umask(2) for
 102         details.  If `--remote` is used then only the configuration of
 103         the remote repository takes effect.
 104
 105 tar.<format>.command::
 106         This variable specifies a shell command through which the tar
 107         output generated by `git archive` should be piped. The command
 108         is executed using the shell with the generated tar file on its
 109         standard input, and should produce the final output on its
 110         standard output. Any compression-level options will be passed
 111         to the command (e.g., "-9"). An output file with the same
 112         extension as `<format>` will be use this format if no other
 113         format is given.
 114 +
 115 The "tar.gz" and "tgz" formats are defined automatically and default to
 116 `gzip -cn`. You may override them with custom commands.
 117
 118 tar.<format>.remote::
 119         If true, enable `<format>` for use by remote clients via
 120         linkgit:git-upload-archive[1]. Defaults to false for
 121         user-defined formats, but true for the "tar.gz" and "tgz"
 122         formats.
 123
 124 [[ATTRIBUTES]]
 125 ATTRIBUTES
 126 ----------
 127
 128 export-ignore::
 129         Files and directories with the attribute export-ignore won't be
 130         added to archive files.  See linkgit:gitattributes[5] for details.
 131
 132 export-subst::
 133         If the attribute export-subst is set for a file then Git will
 134         expand several placeholders when adding this file to an archive.
 135         See linkgit:gitattributes[5] for details.
 136
 137 Note that attributes are by default taken from the `.gitattributes` files
 138 in the tree that is being archived.  If you want to tweak the way the
 139 output is generated after the fact (e.g. you committed without adding an
 140 appropriate export-ignore in its `.gitattributes`), adjust the checked out
 141 `.gitattributes` file as necessary and use `--worktree-attributes`
 142 option.  Alternatively you can keep necessary attributes that should apply
 143 while archiving any tree in your `$GIT_DIR/info/attributes` file.
 144
 145 EXAMPLES
 146 --------
 147 `git archive --format=tar --prefix=junk/ HEAD | (cd /var/tmp/ && tar xf -)`::
 148
 149         Create a tar archive that contains the contents of the
 150         latest commit on the current branch, and extract it in the
 151         `/var/tmp/junk` directory.
 152
 153 `git archive --format=tar --prefix=git-1.4.0/ v1.4.0 | gzip >git-1.4.0.tar.gz`::
 154
 155         Create a compressed tarball for v1.4.0 release.
 156
 157 `git archive --format=tar.gz --prefix=git-1.4.0/ v1.4.0 >git-1.4.0.tar.gz`::
 158
 159         Same as above, but using the builtin tar.gz handling.
 160
 161 `git archive --prefix=git-1.4.0/ -o git-1.4.0.tar.gz v1.4.0`::
 162
 163         Same as above, but the format is inferred from the output file.
 164
 165 `git archive --format=tar --prefix=git-1.4.0/ v1.4.0^{tree} | gzip >git-1.4.0.tar.gz`::
 166
 167         Create a compressed tarball for v1.4.0 release, but without a
 168         global extended pax header.
 169
 170 `git archive --format=zip --prefix=git-docs/ HEAD:Documentation/ > git-1.4.0-docs.zip`::
 171
 172         Put everything in the current head's Documentation/ directory
 173         into 'git-1.4.0-docs.zip', with the prefix 'git-docs/'.
 174
 175 `git archive -o latest.zip HEAD`::
 176
 177         Create a Zip archive that contains the contents of the latest
 178         commit on the current branch. Note that the output format is
 179         inferred by the extension of the output file.
 180
 181 `git config tar.tar.xz.command "xz -c"`::
 182
 183         Configure a "tar.xz" format for making LZMA-compressed tarfiles.
 184         You can use it specifying `--format=tar.xz`, or by creating an
 185         output file like `-o foo.tar.xz`.
 186
 187
 188 SEE ALSO
 189 --------
 190 linkgit:gitattributes[5]
 191
 192 GIT
 193 ---
 194 Part of the linkgit:git[1] suite