English ▾ 主题 ▾ 最新版本 ▾ git-ls-files 上次更新于 2.46.1

名称

git-ls-files - 显示索引和工作树中文件的信息

概要

git ls-files [-z] [-t] [-v] [-f]
		[-c|--cached] [-d|--deleted] [-o|--others] [-i|--ignored]
		[-s|--stage] [-u|--unmerged] [-k|--killed] [-m|--modified]
		[--resolve-undo]
		[--directory [--no-empty-directory]] [--eol]
		[--deduplicate]
		[-x <pattern>|--exclude=<pattern>]
		[-X <file>|--exclude-from=<file>]
		[--exclude-per-directory=<file>]
		[--exclude-standard]
		[--error-unmatch] [--with-tree=<tree-ish>]
		[--full-name] [--recurse-submodules]
		[--abbrev[=<n>]] [--format=<format>] [--] [<file>…​]

描述

此命令将索引中的文件列表与实际工作目录列表合并，并显示两者的不同组合。

可以使用多个标志来确定显示哪些文件，并且如果索引中有多个条目，或者多个状态适用于相关文件选择选项，则每个文件可能会多次打印。

选项

-c
--cached

显示所有缓存到 Git 索引中的文件，即所有跟踪的文件。（如果没有指定 -c/-s/-d/-o/-u/-k/-m/--resolve-undo 选项，这是默认选项。）

-d
--deleted

显示具有未暂存删除的文件

-m
--modified

显示具有未暂存修改的文件（请注意，未暂存的删除也算作未暂存的修改）

-o
--others

在输出中显示其他（即未跟踪）文件

-i
--ignored

仅在输出中显示忽略的文件。必须与显式的 -c 或 -o 一起使用。当显示索引中的文件（即与 -c 一起使用）时，仅打印与排除模式匹配的文件。当显示“其他”文件（即与 -o 一起使用）时，仅显示与排除模式匹配的文件。标准忽略规则不会自动激活；因此，至少需要一个 --exclude* 选项。

-s
--stage

在输出中显示暂存内容的模式位、对象名称和阶段编号。

--directory

如果整个目录被归类为“其他”，则仅显示其名称（带有尾随斜杠），而不显示其全部内容。在没有 -o/--others 的情况下无效。

--no-empty-directory

不列出空目录。在没有 --directory 的情况下无效。

-u
--unmerged

在输出中显示有关未合并文件的信息，但不显示任何其他跟踪的文件（强制 --stage，覆盖 --cached）。

-k
--killed

显示文件系统上需要删除的未跟踪文件，因为文件/目录冲突导致无法将跟踪的文件写入文件系统。

--resolve-undo

显示索引中具有 resolve-undo 信息的文件及其 resolve-undo 信息。（resolve-undo 信息用于实现 "git checkout -m $PATH"，即重新创建意外解决的合并冲突）

-z

输出中使用 \0 作为行终止符，且不引用文件名。有关更多信息，请参见下面的 OUTPUT。

--deduplicate

仅显示文件名时，禁止来自合并期间具有多个阶段的重复项，或同时给出 --deleted 和 --modified 选项。当使用 -t、--unmerged 或 --stage 选项中的任何一个时，此选项无效。

-x <pattern>
--exclude=<pattern>

跳过与模式匹配的未跟踪文件。请注意，模式是 shell 通配符模式。有关更多信息，请参见下面的排除模式。

-X <file>
--exclude-from=<file>

从 <file> 读取排除模式；每行 1 个。

--exclude-per-directory=<file>

读取仅适用于 <file> 中目录及其子目录的其他排除模式。如果你试图模拟 Porcelain 命令的工作方式，则使用 --exclude-standard 选项更容易且更彻底。

--exclude-standard

添加标准 Git 排除项：.git/info/exclude、每个目录中的 .gitignore 以及用户的全局排除文件。

--error-unmatch

如果任何 <file> 未出现在索引中，则将其视为错误（返回 1）。

--with-tree=<tree-ish>

当使用 --error-unmatch 来扩展用户提供的 <file>（即路径模式）参数到路径时，假装自命名的 <tree-ish> 以来在索引中删除的路径仍然存在。将此选项与 -s 或 -u 选项一起使用没有任何意义。

-t

显示状态标签以及文件名。请注意，对于脚本编写目的，git-status[1] --porcelain 和 git-diff-files[1] --name-status 几乎总是更好的选择；用户应该查看 git-status[1] --short 或 git-diff[1] --name-status 以获得更友好的替代方案。

此选项以状态标签（后跟一个空格，然后是文件名）的形式提供显示每个文件名的原因。状态标签都是来自以下列表的单个字符

H

未合并或 skip-worktree 的跟踪文件

S

skip-worktree 的跟踪文件

M

未合并的跟踪文件

R

具有未暂存删除/删除的跟踪文件

C

具有未暂存修改/更改的跟踪文件

K

作为文件/目录冲突一部分的未跟踪路径，这些冲突阻止签出跟踪的文件

?

未跟踪文件

U

具有 resolve-undo 信息的文件

-v

类似于 -t，但是对于标记为assume unchanged（参见 git-update-index[1]）的文件使用小写字母。

-f

类似于 -t，但是对于标记为 fsmonitor valid（参见 git-update-index[1]）的文件使用小写字母。

--full-name

从子目录运行时，该命令通常输出相对于当前目录的路径。此选项强制路径输出相对于项目根目录。

--recurse-submodules

递归地对仓库中的每个活动子模块调用 ls-files。目前只支持 --cached 和 --stage 模式。

--abbrev[=<n>]

不显示完整的 40 字节十六进制对象行，而是显示至少 <n> 个十六进制数字的最短前缀，该前缀唯一地引用该对象。可以使用 --abbrev=<n> 指定非默认位数。

--debug

在描述文件的每一行之后，添加有关其缓存条目的更多数据。这旨在显示尽可能多的信息以进行手动检查；确切的格式可能随时更改。

--eol

显示文件的 <eolinfo> 和 <eolattr>。当 "text" 属性为 "auto"（或者未设置且 core.autocrlf 不为 false）时，<eolinfo> 是 Git 使用的文件内容标识。 <eolinfo> 可以是 "-text"、"none"、"lf"、"crlf"、"mixed" 或 ""。

"" 表示该文件不是常规文件，不在索引中或在工作树中不可访问。

<eolattr> 是检出或提交时使用的属性，它可以是 ""、"-text"、"text"、"text=auto"、"text eol=lf"、"text eol=crlf"。从 Git 2.10 开始，支持 "text=auto eol=lf" 和 "text=auto eol=crlf"。

对于常规文件，显示索引中的 <eolinfo> ("i/<eolinfo>") 和工作树中的 <eolinfo> ("w/<eolinfo>")，后跟 ("attr/<eolattr>")。

--sparse

如果索引是稀疏的，则显示稀疏目录，而不扩展到包含的文件。稀疏目录将显示尾部斜杠，例如稀疏目录 "x" 的 "x/"。

--format=<format>

一个字符串，它从正在显示的结果中插入 %(fieldname)。它还将 %% 插入为 %，并将 %xXX（其中 XX 是十六进制数字）插入为十六进制代码为 XX 的字符；例如，%x00 插入为 \0 (NUL)，%x09 插入为 \t (TAB)，%x0a 插入为 \n (LF)。--format 不能与 -s、-o、-k、-t、--resolve-undo 和 --eol 组合使用。

--

不要将任何其他参数解释为选项。

<file>

要显示的文件。如果没有给出文件，则显示所有符合其他指定条件的文件。

OUTPUT

git ls-files 仅输出文件名，除非指定了 --stage，在这种情况下它输出

[<tag> ]<mode> <object> <stage> <file>

git ls-files --eol 将显示 i/<eolinfo><SPACES>w/<eolinfo><SPACES>attr/<eolattr><SPACE*><TAB><file>

git ls-files --unmerged 和 git ls-files --stage 可用于检查未合并路径的详细信息。

对于未合并的路径，索引记录最多三个模式/SHA-1 对，而不是记录单个模式/SHA-1 对；一个来自阶段 1 中的树 O，阶段 2 中的 A 和阶段 3 中的 B。用户（或瓷器）可以使用此信息来查看最终应该在该路径上记录的内容。（有关状态的更多信息，请参见 git-read-tree[1]）

如果没有 -z 选项，则具有“不寻常”字符的路径名会像配置变量 core.quotePath 中解释的那样被引用（请参见 git-config[1]）。使用 -z 时，文件名将逐字输出，并且该行以 NUL 字节结尾。

可以使用 --format 选项以自定义格式打印，该选项能够使用 %(fieldname) 表示法插入不同的字段。例如，如果您只关心 "objectname" 和 "path" 字段，则可以使用特定的 "--format" 执行，例如

git ls-files --format='%(objectname) %(path)'

FIELD NAMES

可以通过使用 --format=<format> 选项来自定义每个路径的显示方式，其中 <format> 字符串中的 %(fieldname) 用于插入索引条目的各个方面。理解以下 "fieldname"

objectmode

记录在索引中的文件的模式。

objecttype

记录在索引中的文件的对象类型。

objectname

记录在索引中的文件的名称。

objectsize[:padded]

记录在索引中的文件的对象大小（如果对象是 commit 或 tree，则为“-”）。它还支持 "%(objectsize:padded)" 的填充格式大小。

stage

记录在索引中的文件的阶段。

eolinfo:index
eolinfo:worktree

路径的索引或工作树中内容的 <eolinfo>（参见 --eol 选项的描述）。

eolattr

应用于该路径的 <eolattr>（参见 --eol 选项的描述）。

path

记录在索引中的文件的路径名。

EXCLUDE PATTERNS

当指定 --others 或 --ignored 标志时，git ls-files 可以使用“排除模式”列表来遍历目录树并查找要显示的文件。 gitignore[5] 指定了排除模式的格式。

这些排除模式可以从以下位置指定，按顺序排列

  1. 命令行标志 --exclude=<pattern> 指定单个模式。模式按照它们出现在命令行中的相同顺序排列。

  2. 命令行标志 --exclude-from=<file> 指定一个包含模式列表的文件。模式按照它们出现在文件中的相同顺序排列。

  3. 命令行标志 --exclude-per-directory=<name> 指定 git ls-files 检查的每个目录中的文件名，通常为 .gitignore。更深层目录中的文件具有优先权。模式按照它们出现在文件中的相同顺序排列。

在命令行上使用 --exclude 指定或从使用 --exclude-from 指定的文件中读取的模式是相对于目录树的顶部的。从 --exclude-per-directory 指定的文件中读取的模式是相对于模式文件出现的目录的。

通常，当您希望排除规则的应用方式与 Porcelain 命令相同的方式时，应该能够使用 --exclude-standard。要模拟 --exclude-standard 指定的内容，您可以提供 --exclude-per-directory=.gitignore，然后指定

  1. core.excludesfile 配置变量指定的文件（如果存在）或 $XDG_CONFIG_HOME/git/ignore 文件。

  2. $GIT_DIR/info/exclude 文件。

通过 --exclude-from= 选项。

SEE ALSO

git-read-tree[1], gitignore[5]

GIT

Part of the git[1] suite

scroll-to-top