简体中文 ▾ 主题 ▾ 最新版本 ▾ git-archive 最后更新于 2.46.0

名称

git-archive - 创建命名树的归档文件

概要

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

描述

创建指定格式的归档文件，其中包含命名树的树结构，并将其输出到标准输出。如果指定了 <prefix>，则它会添加到归档文件中的文件名之前。

git archive 在提供树 ID 时与提供提交 ID 或标签 ID 时行为不同。当提供树 ID 时，当前时间将用作归档文件中每个文件的修改时间。另一方面，当提供提交 ID 或标签 ID 时，将使用所引用提交对象中记录的提交时间。此外，如果使用 tar 格式，提交 ID 将存储在全局扩展的 pax 头信息中；可以使用 git get-tar-commit-id 提取。在 ZIP 文件中，它存储为文件注释。

选项

--format=<fmt>

生成的归档文件的格式。可能的值包括 tar、zip、tar.gz、tgz，以及使用配置选项 tar.<format>.command 定义的任何格式。如果未给出 --format，并且指定了输出文件，则格式将根据文件名推断（例如，写入 foo.zip 会使输出格式为 zip 格式）。否则，输出格式为 tar。

-l
--list

显示所有可用格式。

-v
--verbose

向 stderr 报告进度。

--prefix=<prefix>/

在归档文件中，在路径前添加 <prefix>/。可以重复指定；最右边的值将用于所有被跟踪的文件。请参阅下方 --add-file 使用的值。

-o <file>
--output=<file>

将归档文件写入 <file> 而不是 stdout。

--add-file=<file>

将未跟踪的文件添加到归档文件。可以重复指定以添加多个文件。归档文件中文件的路径通过连接在此 --add-file 选项之前的最后一个 --prefix 选项的值（如果存在）和 <file> 的基本名称来构建。

--add-virtual-file=<path>:<content>

将指定的内容添加到归档文件。可以重复指定以添加多个文件。

<path> 参数可以以字面双引号字符开头和结尾；包含的文件名被解释为 C 风格字符串，即反斜杠被解释为转义字符。如果路径包含冒号，则必须引用路径，以避免冒号被错误地解释为路径和内容之间的分隔符，或者如果路径以双引号字符开头或结尾。

文件模式限制为普通文件，并且该选项可能受平台相关命令行限制。对于非平凡的情况，请写入一个未跟踪的文件并使用 --add-file 代替。

请注意，与 --add-file 不同，在归档文件中创建的路径不受 --prefix 选项的影响，因为 <path> 的值可以是一个完整的路径。

--worktree-attributes

也在工作树中的 .gitattributes 文件中查找属性（请参阅 属性）。

--mtime=<time>

设置归档条目的修改时间。如果没有此选项，如果 <tree-ish> 是提交或标签，则使用提交者时间；如果是树，则使用当前时间。

<extra>

这可以是归档后端理解的任何选项。请参阅下一节。

--remote=<repo>

不是从本地存储库创建 tar 归档，而是从远程存储库检索 tar 归档。请注意，远程存储库可能对 <tree-ish> 中允许的 sha1 表达式有限制。有关详细信息，请参阅 git-upload-archive[1]。

--exec=<git-upload-archive>

与 --remote 一起使用，用于指定远程端的 git-upload-archive 的路径。

<tree-ish>

用于生成归档文件的树或提交。

<path>

如果没有可选的路径参数，则将当前工作目录的所有文件和子目录包含在归档文件中。如果指定了一个或多个路径，则只包含这些路径。

后端额外选项

zip

-<digit>

指定压缩级别。较高的值允许命令花费更多时间来压缩到更小的尺寸。支持的值范围从 -0（仅存储）到 -9（最佳比率）。如果未指定，则默认为 -6。

tar

-<number>

指定压缩级别。该值将被传递给在 tar.<format>.command 中配置的压缩命令。有关支持的级别列表以及未指定此选项时的默认级别，请参阅配置命令的手册页。

配置

tar.umask

此变量可用于限制 tar 归档条目的权限位。默认值为 0002，这将关闭全局写入位。特殊值“user”表示将使用归档用户的 umask。有关详细信息，请参阅 umask(2)。如果使用 --remote，则仅远程存储库的配置生效。

tar.<format>.command

此变量指定一个 shell 命令，通过该命令，由 git archive 生成的 tar 输出将被管道传输。该命令使用 shell 执行，生成的 tar 文件在标准输入上，并且应在其标准输出上生成最终输出。任何压缩级别选项都将传递给该命令（例如，-9）。

tar.gz 和 tgz 格式是自动定义的，并且默认使用魔术命令 git archive gzip，该命令调用 gzip 的内部实现。

tar.<format>.remote

如果为 true，则启用该格式，以便通过 git-upload-archive[1] 供远程客户端使用。用户定义的格式默认为 false，但 tar.gz 和 tgz 格式为 true。

属性

export-ignore

具有 export-ignore 属性的文件和目录不会被添加到归档文件中。有关详细信息，请参阅 gitattributes[5]。

export-subst

如果为某个文件设置了 export-subst 属性，则 Git 在将该文件添加到归档文件时会扩展几个占位符。有关详细信息，请参阅 gitattributes[5]。

请注意，属性默认取自正在归档的树中的 .gitattributes 文件。如果您想在事后调整输出的生成方式（例如，您提交时未在 .gitattributes 中添加适当的 export-ignore），请根据需要调整已签出的 .gitattributes 文件，并使用 --worktree-attributes 选项。或者，您可以将适用于归档任何树的必要属性保留在 $GIT_DIR/info/attributes 文件中。

示例

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

创建一个 tar 归档文件，其中包含当前分支上最新提交的内容，并将其提取到 /var/tmp/junk 目录中。

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

为 v1.4.0 版本创建压缩的 tarball。

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

与上面相同，但使用内置的 tar.gz 处理。

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

与上面相同，但格式是从输出文件中推断出来的。

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

为 v1.4.0 版本创建压缩的 tarball，但没有全局扩展的 pax 头信息。

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

将当前 HEAD 的 Documentation/ 目录中的所有内容放入 git-1.4.0-docs.zip，并加上 git-docs/ 前缀。

git archive -o latest.zip HEAD

创建包含当前分支上最新提交内容的 Zip 归档文件。请注意，输出格式是通过输出文件的扩展名推断出来的。

git archive -o latest.tar --prefix=build/ --add-file=configure --prefix= HEAD

创建一个 tar 归档文件，其中包含当前分支上最新提交的内容（无前缀）以及未跟踪文件 configure（前缀为 build/）。

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

配置用于创建 LZMA 压缩 tar 文件的“tar.xz”格式。您可以通过指定 --format=tar.xz 来使用它，或者通过创建类似 -o foo.tar.xz 的输出文件来使用。

另请参阅

gitattributes[5]

GIT

Git[1] 套件的一部分