简体中文 ▾ 主题 ▾ 最新版本 ▾ 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

显示索引中有解决撤销信息的文件及其解决撤销信息。（解决撤销信息是用于实现“git checkout -m $PATH”的信息，即恢复意外解决的合并冲突）

-z

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

--deduplicate

当仅显示文件名时，抑制由于合并期间有多个暂存区或同时给出 --deleted 和 --modified 选项而可能出现的重复项。当使用 -t、--unmerged 或 --stage 选项之一时，此选项无效。

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

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

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

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

--exclude-per-directory=<file>

从 <file> 中读取仅适用于目录及其子目录的其他排除模式。如果你试图模仿 Porcelain 命令的工作方式，使用 --exclude-standard 选项会更简单、更全面。

--exclude-standard

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

--error-unmatch

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

--with-tree=<span class="hover-term" data-term="tree-ish"><tree-ish></span>

当使用 --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

具有解决撤销信息的文件

-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>。<eolinfo> 是 Git 在“text”属性为“auto”（或未设置且 core.autocrlf 不为 false）时使用的文件内容标识。<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>

要显示的文件。如果没有给出文件，将显示所有符合其他指定标准的匹配文件。

输出

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

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

git ls-files --eol 将显示 i/<eolinfo><空格>w/<eolinfo><空格>attr/<eolattr><空格*><制表符><文件>

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

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

如果不使用 -z 选项，则具有“特殊”字符的路径名将像 core.quotePath 配置变量（参见 git-config[1]）中解释的那样被引用。使用 -z 时，文件名将按原样输出，行以 NUL 字节结束。

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

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

字段名称

可以通过使用 --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

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

排除模式

git ls-files 在遍历目录树并查找文件以供 --others 或 --ignored 标志显示时，可以使用一组“排除模式”。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= 选项。

另请参阅

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

GIT

Git[1] 套件的一部分