Using git, how do you reset the working tree (local file system state) to the state of the index ("staged" files)?
Asked Answered
P

6

79

Situation:

  1. Edit files
  2. Add files to the index with git add (these files are now "staged")
  3. Edit more files

Now we have three different states: the state of HEAD (which points to the last commit), the state of the index (which includes all added, or "staged" files) and the state of the working tree (the unstaged, local file system state). What is the command to undo changes in the working tree so that it matches the state of the index?

Ppi answered 24/6, 2010 at 6:54 Comment(1)
I edited your question to define and make clear what "working tree" and "index" mean, as I've been using git for years and only discovered yesterday what these terms mean. I think will help reach many more people, as most of the "populace" using git doesn't know these terms, but they do know what their local file system is, what git add is, and what green lines (staged content in the index) means when they look at git status. Hopefully you're okay with these changes.Lingual
E
87

I tend to use git checkout . which discards all changes from the working directory down. This makes a difference if you're not at the root of the repository.

This command doesn't remove newly created files which is usually a good thing. If you need to do this then you can use git clean as well.

Ephraim answered 24/6, 2010 at 7:10 Comment(7)
This also works with a single filenames: git checkout [file ...]. Thanks!Slowpoke
Out of curiosity, do you know how to undo this?Trivial
I find that git checkout :/ discards all changes in the working tree, regardless of the current working directory.Extra
I've been using git for years and I seem to learn something new every day. I came across this when I needed a file from another branch, so I checked that out. Then edited, and wanted to revert. You can do git checkout again without specifying the branch name, it defaults to the state of the index. Nice job.Begga
@Gershy, you can't undo this. Undoing this would be like undoing rm some_file, or undoing a delete where you skipped the trash can. So, make sure it's what you really want before you do this.Lingual
Related: see also this answer where these commands are used, and my answer here too: "How to do a --soft or --hard git reset by path" where I use them.Lingual
After a bunch of experimenting, I think git checkout-index -fa, as Peter Tillemans states, produces a much better result. Putting git clean -fd into the mix, and providing thorough explanations, led to the creation of my new answer here.Lingual
F
18

You can use git stash save --keep-index to do this. After saving the stash, you can use git stash drop if you don't want to keep it around.

Farthingale answered 24/6, 2010 at 7:7 Comment(3)
This is so unintuitive I wonder if I misunderstand something. What I want to do is git reset --hard <specific file> that has merge conflicts, so that I can just git pull the latest version. But git won't let me do that for individual files. Is there really no way to roll back changes to a file in the working directory besides git stash??Doubleton
@Andy: To roll back a specific file, git checkout -- <specific file>.Farthingale
Oh! I hadn't even thought of that, that's different than other SCMs and GUI tools I'm coming from. Thanks!Doubleton
P
13

Use the new git restore command.

Restore the working tree from the index (from staged files):

git restore .

Restore a single file in the working tree from the index (from the staged version):

git restore myFile

source: https://git-scm.com/docs/git-restore

Precedency answered 23/1, 2022 at 22:56 Comment(0)
I
12

You can use git-checkout-index (git checkout-index). Be aware that you need to add

  • -f to force it to overwrite existing files, or
  • -f -a to enforce overwriting all paths in the index.
Integral answered 24/6, 2010 at 7:1 Comment(2)
See man git checkout-index for the local man pages. Run man git then / and type git-checkout-index, then Enter, to read a brief blurb about it in the main man git pages too. Its description there is "Copy files from the index to the working tree.".Lingual
What's the advantage/difference of this command compared to git checkout .? Why is it needed?Chuipek
E
4

git checkout :/ discards all changes in the working tree and replaces it with what's in the index, regardless of the current working directory.

https://git-scm.com/docs/gitglossary#Documentation/gitglossary.txt-aiddefpathspecapathspec

Extra answered 28/11, 2017 at 19:30 Comment(0)
L
4

The other answers I don't think capture the full parts. Here's what you need:

Just the commands:

git checkout-index -fa
# See the WARNING below before running this command.
git clean -fd

With detailed comments:

Note: Run git status. Changes shown in green are in your index. These are "staged" changes. Changes shown in red are in your working tree, or local file system, but NOT in the index. These are "unstaged" changes. Calling git checkout-index -fa forces your working tree to match your index, so git status will no longer show those changes in red after running that command, unless it is an entirely new file you have in your working tree, in which case git clean -fd is required to remove/delete it.

# 1. 'f'orce checkout 'a'll paths from the index (staged/added files) to the
# working tree (local file system) 
git checkout-index -fa

# 2. 'f'orce clean (remove) all files and 'd'irectories which are in the working 
# tree but NOT in the index. WARNING WARNING WARNING: this is a destructive
# command and cannot be undone. It is like doing `rm` to remove files. 
# First, make sure no changes exist in red when you run `git status` which
# you want to keep.
git clean -fd

From man git checkout-index:

-f, --force
    forces overwrite of existing files

-a, --all
    checks out all files in the index. Cannot be used together with
    explicit filenames.

See also:

  1. this great help from @Peter Tillemans
  2. my answer where I needed these commands to do a --hard or --soft git reset by path
  3. [my answer, which contains "All about checking out files or directories in git"] How to get just one file from another branch?
Lingual answered 11/3, 2021 at 19:12 Comment(0)

© 2022 - 2024 — McMap. All rights reserved.