How do I remove a single file from the staging area (undo git add)?
-
19-09-2019 - |
Question
Situation: I have a Git repository with files already in the index. I make changes to several files, open Git and add these files to my staging area with "git add ."
Question: How do I remove one of those files from the staging area but not remove it from the index or undo the changes to the file itself?
Solution
If I understand the question correctly, you simply want to "undo" the git add
that was done for that file.
If you need to remove a single file from the staging area, use
git reset HEAD -- <file>
If you need to remove a whole directory (folder) from the staging area, use
git reset HEAD -- <directoryName>
Your modifications will be kept. When you run git status
the file will once again show up as modified but not yet staged.
See the git reset
man page for details.
OTHER TIPS
git rm --cached FILE
,
git rm -r --cached CVS */CVS
git reset <file>
Works whether or not you have any previous commits.
So, a slight tweak to Tim Henigan's answer: you need to use -- before the file name. It would look like this:
git reset HEAD -- <file>
git reset filename.txt
If you have a modification in filename.txt , you added it to stage by mistake and you want to remove the file from staging but you don't want to lose the changes.
In case you just want to remove a subset of the changes to your file, you can use:
git reset -p
or
git reset -p <file_name>
This command is basically the reverse of git add -p
: it will only remove the selected changes from the staging area. I find it extremely useful in "unadding" something that I added by mistake.
If you want to remove files following a certain pattern and you are using git rm --cached
, you can use file-glob patterns too.
See here.
You want:
Affect to a single file
Remove file from staging area
Not remove single file from index
Don't undo the change itself
and the solution is
git reset HEAD file_name.ext
or
git reset HEAD path/to/file/file_name.ext
When you do git status
, Git tells you how to unstage:
Changes to be committed: (use "git reset HEAD <file>..." to unstage).
So git reset HEAD <file>
worked for me and the changes were un-touched.
If you make changes to many tracked files but only want to stage a few of them, doing a
git add .
isn't always favorable (or recommended)- as it stages all the tracked files (some cases where you want to keep changes only to yourself and don't want to stage them to the remote repository).
nor is it ideal doing a bunch of
git add path/to/file1 path/to/file2
if you have a lot of nested directories (which is the case in most projects) - gets annoying
That's when Git GUI is helpful (probably only time I use it). Just open Git GUI, it shows staged and unstaged file sections. Select the files from the staged section that you want to unstage and press
Ctrl+U
(for windows)
to unstage them.
I think you probably got confused with the concept of index, as @CB Bailey commented:
The staging area is the index.
You can simply consider staging directory and index as the same thing.
So, just like @Tim Henigan's answer, I guess:
you simply want to "undo" the
git add
that was done for that file.
Here is my answer:
Commonly, there are two ways to undo a stage operation, as other answers already mentioned:
git reset HEAD <file>
and
git rm --cached <file>
But what is the difference?
Assume the file has been staged and exists in working directory too, use git rm --cached <file>
if you want to remove it from staging directory, and keep the file in working directory. But notice that this operation will not only remove the file from staging directory but also mark the file as deleted
in staging directory, if you use
git status
after this operation, you will see this :
deleted: <file>
It's a record of removing the file from staging directory. If you don't want to keep that record and just simply want to undo a previous stage operation of a file, use git reset HEAD <file>
instead.
-------- END OF ANSWER --------
PS: I have noticed some answers mentioned:
git checkout -- <file>
This command is for the situation when the file has been staged, but the file has been modified in working directory after it was staged, use this operation to restore the file in working directory from staging directory. In other words, after this operation, changes happen in your working directory, NOT your staging directory.
You need to be in the directory of the file and then type the following into the terminal
git reset HEAD .
Assumption is that you need to reset one file only.
To unstage everything at once, run this command
git reset HEAD -- .
git checkout -- <file>
It works perfectly to remove files from Staging Area
In my case, I do
git checkout -- FILE