Git
英语 ▾ 主题 ▾ 版本 2.44.0 ▾ git-archive 上次更新于 2.44.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 和 --add-virtual-file 使用哪个值。

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

将存档写入 <file>，而不是 stdout。

--add-file=<file>

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

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

将指定内容添加到存档中。可以重复以添加多个文件。存档中文件的路径通过连接此 --add-virtual-file 之前的最后一个 --prefix 选项（如果有）的值和 <path> 来构建。

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

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

--worktree-attributes

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

--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

如果为真，则通过 git-upload-archive[1] 启用远程客户端使用的格式。对于用户定义的格式，默认为假，但对于 tar.gz 和 tgz 格式，默认为真。

属性

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

将当前头的 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"

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

另请参阅

gitattributes[5]

GIT

git[1] 套件的一部分

scroll-to-top