简体中文 ▾ 主题 ▾ 最新版本 ▾ 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>，它将作为前缀添加到归档中的文件名之前。

当给定树 ID 与给定提交 ID 或标签 ID 时，git archive 的行为会有所不同。如果提供的是树 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

向标准错误报告进度。

--prefix=<prefix>/

在归档中的路径前加上 <prefix>/。可以重复使用；其最右侧的值用于所有被追踪的文件。请参见下文了解 --add-file 使用哪个值。

-o <文件>
--output=<文件>

将归档写入 <文件> 而不是标准输出。

--add-file=<文件>

将未追踪的文件添加到归档中。可以重复添加多个文件。归档中文件的路径是通过连接此 --add-file 之前最后一个 --prefix 选项的值（如果有）和 <文件> 的基名（basename）构成的。

--add-virtual-file=<路径>:<内容>

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

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

文件模式仅限于普通文件，并且该选项可能受到平台相关的命令行限制。对于非平凡的情况，请编写一个未追踪的文件并改用 --add-file。

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

--worktree-attributes

同时在工作区的 .gitattributes 文件中查找属性（参见 属性）。

--mtime=<时间>

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

<额外选项>

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

--remote=<仓库>

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

--exec=<git-upload-archive>

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

<tree-ish>

要为其生成归档的树或提交。

<路径>

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

后端额外选项

zip

-<数字>

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

tar

-<数字>

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

配置

tar.umask

此变量可用于限制 tar 归档条目的权限位。默认值为 0002，这将关闭其他用户的写权限位。特殊值 "user" 表示将改用归档用户的 umask。有关详细信息，请参阅 umask(2)。如果使用了 --remote，则只有远程仓库的配置生效。

tar.<格式>.command

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

tar.gz 和 tgz 格式是自动定义的，默认情况下使用魔法命令 git archive gzip，它调用 gzip 的内部实现。

tar.<格式>.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 版本创建一个压缩的 tar 包。

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 版本创建一个压缩的 tar 包，但不包含全局扩展 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] 套件的一部分