- Developers who already know basic commit and branch actions
- Readers who want to understand command boundaries and risk
Command Reference
git-ls-files Tutorial
Explains how to use git-ls-files to list tracked paths from the index and working tree.
- A basic mental model of worktree, index, and commits
- Comfort reading `git status` and a small commit graph
- Using local cleanup commands on already shared history
- Continuing to rewrite before confirming a recovery path
The short version
git-ls-files is used to list tracked paths from the index and working tree.
When it is a good fit
- when you need to list tracked paths from the index and working tree
- when you want this step to be repeatable instead of ad hoc
- when you need a clearer mental model of what Git is recording or updating
Basic example
git ls-files
What to watch most closely
Plumbing commands are closer to Git internals, so check whether a safer high-level command already solves the problem.
A safer working habit
Treat it as a read-only inspection tool first, then move to write-oriented usage only when necessary.
Useful angles for understanding it
- Inspect lower-level objects and refs
- Write scripts or debug advanced issues
- Verify internal repository state
Related reading
Read it alongside git status, git log, and git show so it is easier to see how the command changes history, refs, the index, or the working tree.
What problem this command solves in a workflow
git ls-files solves the problem of "what files are tracked in the index?". It lists all file paths that Git is tracking from the index, providing a quick way to understand the repository's file tracking state.
Typical use cases
- Get a quick list of all tracked files in the repo by running
git ls-files— simpler and more concise thangit status. - Process all tracked files in a script by using
git ls-filesto output a file list for downstream commands. - Use
git ls-files --others --ignoredto see files excluded by.gitignore, useful for debugging ignore rules.
Diagram view
Special cases and boundaries
git ls-filesis a pure read-only command — it never modifies the index, working tree, or any repository content.- By default it only shows tracked files; use
--othersto show untracked files, and--deletedto show files deleted from the working tree but still in the index. - Output paths are relative to the repository root, regardless of the current working directory.
- Unlike
git status,ls-filesdoes not compare the working tree against the index — it only shows what the index contains. - When used in scripts, prefer
-zfor null-delimited output to avoid parsing errors from filenames with spaces or special characters.