399

I would like to use this workflow:

  1. Stage some changes.
  2. Save the unstaged changes to the stash.
  3. Do some stuff with the things in stage (build, test, etc.).
  4. Commit.
  5. Restore the unstaged changes.

Is there a way to do step 2?

Example:

git init
echo one >file
git add file
git commit
echo two >>file
git add file
echo three >>file
git stash push
test
git commit
git stash pop
8
  • Why not commit your changes after staging them?
    – Shizzmo
    Commented Oct 4, 2011 at 16:08
  • 4
    IIRC --keepindex does exactly that
    – sehe
    Commented Oct 4, 2011 at 16:11
  • 6
    Because if, say, the build fails I don't want to have a commit of this. I know I can delete the commit but I'd like to do this without a commit if possible.
    – Unapiedra
    Commented Oct 4, 2011 at 16:12
  • Sehe, thanks. I can confirm this works. Gee, I looked at the manual at linux.die.net/man/1/git-stash which is out of date. man git stash is much better.
    – Unapiedra
    Commented Oct 4, 2011 at 16:17
  • it's --keep-index, fwiw.
    – jaf0
    Commented Jun 24, 2014 at 21:34

16 Answers 16

456

git stash push has an option --keep-index that does exactly what you need, so run:

git stash push --keep-index
16
  • 12
    True. I keep using save with git stash. Maybe it is the programmer in me insisting on honoring the symmetry with apply/pop. :)
    – vhallac
    Commented Oct 4, 2011 at 16:22
  • 196
    Note: this still stashes all your changes; the only difference from regular git stash save is that it leaves the already-staged changes in your working copy as well. In the workflow above this would work fine since you're just applying the stash on top of a local copy that already has half of the stash's changes (which git is smart enough to ignore). But if you edit the code before re-applying the stash, you could potentially see merge conflicts when you go to apply. Fyi.
    – peterflynn
    Commented Mar 4, 2014 at 6:09
  • 4
    @ytpete That has bitten me so many times. I really wish there was a way for git to only stash the things you are not keeping... I often commit stuff, then do a full git stash, knowing that I can git commit --ammend if there are problems in what I committed.
    – rjmunro
    Commented Apr 8, 2014 at 10:11
  • 36
    This solution does not work for me because of the problems described by peterflynn. It is not a good answer to the question since it still stashes the staged changes. Anybody got a better solution?
    – user643011
    Commented Mar 18, 2017 at 14:29
  • 5
    Docs seem to say that stash save is deprecated now: "This option is deprecated in favour of git stash push. It differs from "stash push" in that it cannot take pathspecs, and any non-option arguments form the message."
    – jocull
    Commented Aug 27, 2019 at 20:14
93

This may be done in 3 steps: save staged changes, stash everything else, restore index with staged changes. Which is basically:

git commit -m 'Save index'
git stash push -u -m 'Unstaged changes and untracked files'
git reset --soft HEAD^

This will do exactly what you want.

If you do not wish to stash untracked files, you can use

git commit -m 'Save index'
git stash push -m 'Unstaged changes'
git reset --soft HEAD^

Neither version affects gitignored files.

7
  • 5
    Note: -u also stashes untracked files.
    – ma11hew28
    Commented Dec 17, 2018 at 22:28
  • 1
    This approach essentially duplicates what git stash save --keep-index does with a lot more work. I don't see any advantages.
    – Inigo
    Commented Feb 1, 2020 at 22:55
  • 20
    @vas No, the approach does not duplicate that. See peterflynn's comment to the accepted answer. Commented Mar 10, 2020 at 17:30
  • Excellent, but the purpose of stashing unstaged changes was to test staged changes before committing them. So there is no point in executing your third command git reset --soft HEAD^.
    – Géry Ogam
    Commented Jan 30, 2022 at 2:33
  • Pro tip: You can generally combine single-character flags together: -u -m can become -um e.g. git stash push -um "Greatest stashing ever"
    – Adi H
    Commented Apr 21, 2022 at 16:31
68

From Git 2.35+ (Q1 2022) you can now use the --staged flag (man) on git stash push to only stash the changes in your index.

Since your question asks the exact opposite, we have 2 choices:

  1. Reverse the operation like so:
git stash push --staged            # Stash staged changes
git stash                          # Stash everything else
git stash pop stash@{1}            # Restore staged changes stash
  1. Stage the changes you want to stash instead of the ones you want to keep. Now you can just run:
git stash push --staged

I got this information from this answer on another S/O post.

7
  • 1
    Good point. I have updated my ow answer on this page, in order to reference my other answer.
    – VonC
    Commented Feb 22, 2022 at 14:01
  • 1
    Amazing! This is way more elegant than my git diff solution.
    – Géry Ogam
    Commented Nov 15, 2022 at 1:02
  • 1
    This was a great solution! My only change was I needed to stash new files as well, so I ran git stash --include-untracked instead of just git stash for step 2.
    – ADataGMan
    Commented Jul 4, 2023 at 12:32
  • Using a git version lower than 2.35, you can stash what you want to stash first (using git stash or git stash -p {name_of_your_file}, and then do your commit and pop your stash(es).
    – Apitronix
    Commented Oct 17, 2023 at 7:00
  • Changing the middle line of the first group to git stash -u to also stash uncommitted files is handy. Not sure how to cleanly suggest that as a side option in your answer though.. (Inspired by Aleysa's answer currently above this.) Commented Dec 9, 2023 at 18:33
38
git stash save --keep-index

Also, Re:

Why not commit your changes after staging them? – Shin

A: Because you should always checkin tested code :) That means, you need to run the tests with only the changes you are about to commit

All this apart from the fact that of course, as an experienced programmer, you have the innate urge to test and review just those changes -- only partly kidding

3
  • 1
    Actually this command stashes staged changes too =( Commented Apr 7, 2023 at 21:42
  • Why --keep-index is not the default? Commented May 29 at 18:16
  • @adosar It just isn't. See for relevant explanation and tips here: lore.kernel.org/git/…
    – sehe
    Commented May 29 at 19:52
38

Stash Without the Staged Changes

The Problem with --keep-index / -k

Stashing just the working tree (unstaged changes) in Git is more difficult than it should be. The accepted answer, and quite a few other answers, stashes the unstaged changes and leaves the stage alone as requested via --keep-index.

However what isn't obvious is that --keep-index also stashes the staged changes. The staged changes end up in both the stage AND the stash. This is rarely what one wants because any interim changes to the stash are likely to result in conflicts when popping the stash later.

Alias Solution

This alias works well to stage just the working copy changes:

stash-working = "!f() { \
  git commit --quiet --no-verify -m \"temp for stash-working\" && \
  git stash push \"$@\" && \
  git reset --quiet --soft HEAD~1; }; f"

It commits the staged changes temporarily, creates a stash from the remaining changes (and allows additional arguments such as --include-untracked and --message to be passed as alias arguments), and then resets the temporary commit to get back the staged changes.

It is similar to @Simon Knapp's answer, but with a few minor differences -- it uses --quiet on the temporary actions taken, and it accepts any number of parameters for the stash push, rather than hard-coding the -m, and it does add --soft to the final reset so that the index remains as it started. It also uses --no-verify on the commit to avoid changes to the working copy from pre-commit hooks (HT: @Granfalloner).

For the opposite problem of stashing just the staged changes (alias stash-index) see this answer.

3
  • 5
    As a further improvement to this snippet, its worth to add --no-verify option to git commit, otherwise implicit temporary commit might seriously mess up working directory because of pre-commit hook. Commented Dec 16, 2020 at 17:52
  • 1
    I had more luck using it as a function, not sure why but zsh choked on the above syntax: stash-working() { git commit --quiet --no-verify -m "temp for stash-working" && git stash push "$@" && git reset --quiet --soft HEAD~1; }
    – Lotus
    Commented Jun 8, 2022 at 0:49
  • 2
    @Lotus Try copying it exactly as-is directly into the [alias] section of your .gitconfig. That way, zsh is not involved at all.
    – Raman
    Commented Jun 8, 2022 at 13:10
30

TL;DR; Since at git 2.35 flag was implemented: git stash [push [-S|--staged]], you can do:

git stashu

after adding this alias:

git config --global alias.stashu '!git stash push -S; git stash; git stash pop --index stash@{1}'"

Explanation:

git stash push -S                  # Stash staged changes
git stash                          # Stash everything else
git stash pop --index stash@{1}    # Restore staged changes into index

$ git config --global alias.stashu '!git stash push -S; git stash; git stash pop --index stash@{1}'

$ git diff 
```diff
diff --git a/src/js/modal.js b/src/js/modal.js
index d07c085..766e39a 100644
--- a/src/js/modal.js
+++ b/src/js/modal.js
@@ -6,10 +6,12 @@
 import "jquery-validation/dist/jquery.validate";
 import "bootstrap/dist/js/bootstrap.bundle";
 
+staged
 const FormDataJson = require('form-data-json-convert');
 FormDataJson.defaultOptionsToJson.uncheckedValue =  false;
 FormDataJson.defaultOptionsToJson.skipEmpty      =  true;
 
+unstaged
 import { TabulatorFull as Tabulator } from 'tabulator-tables/dist/js/tabulator';
 
 import { ajax_query } from "./common/ajax";
``` 

$ git add -p
```diff
@@ -6,7 +6,8 @@
 import "jquery-validation/dist/jquery.validate";
 import "bootstrap/dist/js/bootstrap.bundle";
 
+staged
 const FormDataJson = require('form-data-json-convert');
 FormDataJson.defaultOptionsToJson.uncheckedValue =  false;
 FormDataJson.defaultOptionsToJson.skipEmpty      =  true;
``` 

(1/2) Stage this hunk [y,n,q,a,d,j,J,g,/,e,?]? y
```diff
@@ -9,7 +10,8 @@
 const FormDataJson = require('form-data-json-convert');
 FormDataJson.defaultOptionsToJson.uncheckedValue =  false;
 FormDataJson.defaultOptionsToJson.skipEmpty      =  true;
 
+unstaged
 import { TabulatorFull as Tabulator } from 'tabulator-tables/dist/js/tabulator';
 
 import { ajax_query } from "./common/ajax";
```
(2/2) Stage this hunk [y,n,q,a,d,K,g,/,e,?]? n

$ git status
On branch dev-Modal
Changes to be committed:
  (use "git restore --staged <file>..." to unstage)
modified:   modal.js

Changes not staged for commit:
  (use "git add <file>..." to update what will be committed)
  (use "git restore <file>..." to discard changes in working directory)
modified:   modal.js

$ git diff
```diff
diff --git a/src/js/modal.js b/src/js/modal.js
index ac48408..766e39a 100644
--- a/src/js/modal.js
+++ b/src/js/modal.js
@@ -11,6 +11,7 @@ const FormDataJson = require('form-data-json-convert');
 FormDataJson.defaultOptionsToJson.uncheckedValue =  false;
 FormDataJson.defaultOptionsToJson.skipEmpty      =  true;
 
+unstaged
 import { TabulatorFull as Tabulator } from 'tabulator-tables/dist/js/tabulator';
 
 import { ajax_query } from "./common/ajax";
``` 

$ git stashu 
Saved working directory and index state WIP on dev-Modal: 9f6e760 Imported Tabulator module
Saved working directory and index state WIP on dev-Modal: 9f6e760 Imported Tabulator module
On branch dev-Modal
Changes to be committed:
  (use "git restore --staged <file>..." to unstage)
modified:   src/js/modal.js

Dropped stash@{1} (509be8cf1afa340faf77aa6a2b8d008aa82a980a)

$ git stash show -p
```diff
diff --git a/src/js/modal.js b/src/js/modal.js
index d07c085..ed509ed 100644
--- a/src/js/modal.js
+++ b/src/js/modal.js
@@ -10,6 +10,7 @@ const FormDataJson = require('form-data-json-convert');
 FormDataJson.defaultOptionsToJson.uncheckedValue =  false;
 FormDataJson.defaultOptionsToJson.skipEmpty      =  true;
 
+unstaged
 import { TabulatorFull as Tabulator } from 'tabulator-tables/dist/js/tabulator';
 
 import { ajax_query } from "./common/ajax";
```

**BONUS for those who read till here. The alias to stash staged changes:
```
$ git config --global alias.stashs 'stash push -S'
```
And now you can `stash staged`:
```
git stashs
```


With git version 2.7.4 you may use the --patch option:

git stash save --patch

Then git will ask you to add or not your changes into stash.
And you then just answer y or n.

You can restore the working directory as you always do like:

git stash pop

or, if you want to keep saved changes in stash:

git stash apply
2
  • This is awesome. It's a little labor-intensive, but at least you can skip and add whole files. Commented Apr 24, 2020 at 19:28
  • Here is a version of the alias that allows you to forward arguments to the stash command (for example, -m for a message): !f() { git stash push -S && git stash "$@" && git stash pop --index stash@{1}; }; f
    – bgfvdu3w
    Commented Apr 2 at 18:01
25

To add the unstagged (not added to commit) files to stash, run the following command:

git stash -k

If you want to include newly added files(which are not staged - not in green) also to the stash, do the following:

git stash -k -u

Then you can commit the staged files. After that you can get back the last stashed files using the command:

git stash pop
3
  • 1
    I think this should be accepted answer because the one accepted does not work if you have some edits that are staged and unstaged on the same file, you get patch does not apply. Commented May 20, 2022 at 13:25
  • If you modify a file after staging it, you will lose these changes when doing git stash -k -u followed by git stash pop - See stackoverflow.com/questions/73128025/… Commented Jul 26, 2022 at 18:52
  • This does not work because it will still stash everything (BOTH staged and unstaged files). -k or '--keep-index' does not prevent staged files from being added to the stash; it is merely for the convenience of leaving the stash intact after the operation (instead of removing it from the stash)
    – Adi H
    Commented Jul 6, 2023 at 1:28
7

Git doesn't have a command that stashes only your unstaged changes.

Git does, however, let you specify which files you want to stash.

git stash push --message 'Unstaged changes' -- app/controllers/products_controller.rb test/controllers/products_controller_test.rb

If you only want to stash specific changes in those files, add the --patch option.

git stash push --patch --message 'Unstaged changes' -- app/controllers/products_controller.rb test/controllers/products_controller_test.rb

The --include-untracked option lets you stash untracked files.

git stash push --include-untracked --message 'Untracked files' -- app/controllers/widgets_controller.rb test/controllers/widgets_controller_test.rb

Run git help stash (or man git-stash) for more info.

Note: If your unstaged changes are rather disoganized, @alesguzik's answer is probably easier.

5

Extending previous answers, I sometimes have a complex set of changes staged, but wish to commit a separate change first. For example, I might have spotted a bug or otherwise incorrect code that I'd like to fix ahead of my staged changes. One possible route to take is this:

first stash everything, but leave the staged changes intact

$ git stash save --keep-index [--include-untracked]

now stash the staged changes separately too

$ git stash save

make changes for fix; and test; commit them:

$ git add [--interactive] [--patch]

$ git commit -m"fix..."

now restore the previously staged changes:

$ git stash pop

resolve any conflicts, and note that if there were conflicts, git will have applied but not dropped that top stash entry.

(... Then commit the staged changes, and restore the stash of all the other changes, and continue ...)

3

Another tip, related to the question:

When you effectively stash your unstaged changes using

$ git stash save --keep-index

you might wish to give the stash a message, so that when you to do a git stash list it's more obvious what you have stashed before, especially if you follow that stash operation by further saves. For example

$ git stash save --keep-index "changes not yet staged"

(although actually it does contain all the changes as noted in other answers).

For example, the above might be followed immediately by:

$ git stash save "staged changes for feature X"

Beware, though, that you can't then use

$ git stash apply "stash@{1}" ### ✘ doesn't quite do what you might want

to restore just the unstaged changes.

3

I use an an alias, which accepts a string to use as a message to the stash entry.

mystash = "!f() { git commit -m hold && git stash push -m \"$1\" && git reset HEAD^; }; f"

Which:

  • commits everything in the index,
  • stashes what is changed in the working tree (could of course add -u or -a),
  • resets the last commit back to the working try (may want to use --soft to keep it in the index).
1
  • thanks I had some success with it with the --soft flag, except I added 2 twists: git commit --allow-empty in case nothing is staged, and a default value for the stash message $1. I had to add # to the end as well to avoid message being repeated. which gives me: git config --global alias.save '!git commit --no-verify --allow-empty -m hold && git stash push -um "${1-unstaged}" && git reset --soft HEAD^ #' Commented Nov 17, 2022 at 17:21
3

2022: I mention in "Stashing only staged changes in git - is it possible?", Git 2.35 (Q1 2022) comes with "git stash push --staged"(man):

This option is only valid for push and save commands.

Stash only the changes that are currently staged.
This is similar to basic git commit except the state is committed to the stash instead of current branch.


2019: The modern form of that command is git stash push [--] [<pathspec>...], since Git 2.16+ (git stash save is deprecated)

You can combine that with a wildcard form, for example:

git stash push --all --keep-index ':(glob)**/*.testextension' 

But that does not work well with Git for Windows, until Git 2.22 (Q2 2019), see issue 2037, considering git stash has been re-implemented in C (instead of a shell script)

See commit 7db9302 (11 Mar 2019) by Thomas Gummerer (tgummerer).
See commit 1366c78, commit 7b556aa (07 Mar 2019) by Johannes Schindelin (dscho).
(Merged by Junio C Hamano -- gitster -- in commit 0ba1ba4, 22 Apr 2019)

built-in stash: handle :(glob) pathspecs again

When passing a list of pathspecs to, say, git add, we need to be careful to use the original form, not the parsed form of the pathspecs.

This makes a difference e.g. when calling

git stash -- ':(glob)**/*.txt'

where the original form includes the :(glob) prefix while the parsed form does not.

However, in the built-in git stash, we passed the parsed (i.e. incorrect) form, and git add would fail with the error message:

fatal: pathspec '**/*.txt' did not match any files

at the stage where git stash drops the changes from the worktree, even if refs/stash has been actually updated successfully.

1

Here's (in my opinion) the best solution, that does exactly what the OP has asked for. It stashes only the unstaged, tracked files – without an unnecessary commit or stashing all changed files with --keep-index

It lists all the unstaged, tracked changes (git diff --name-only) converts newlines to spaces (| tr '\n' ' ') and stashes all these files using git stash push:

git stash push $(git diff --name-only | tr '\n' ' ')
7
  • Simple yet working! Thanks! Commented Feb 18, 2022 at 12:38
  • No problem! Glad I could help @GeorgiyBukharov Commented Feb 18, 2022 at 16:30
  • I just ran this and it stashed my unstaged changes too
    – Anentropic
    Commented Apr 8, 2022 at 16:45
  • @Anentropic that is exactly what OP asked for – to stash unstaged changes. Was that a typo? Commented Apr 8, 2022 at 21:04
  • I think I mis-typed, it seemed to stash everything, staged too, but tbh maybe I confused that too
    – Anentropic
    Commented Apr 10, 2022 at 8:58
0

I was interested in how the Python program pre-commit does it. Here is the code. https://github.com/pre-commit/pre-commit/blob/3fe38dff05957f609cf7b97f471b35a8d9e0659a/pre_commit/staged_files_only.py#L50

It is functionally equivalent to something like:

git diff-index --ignore-submodules --binary --exit-code --no-color --no-ext-diff $(git write-tree) -- >stash.patch
git checkout -- .

# Do stuff now

git apply stash.patch && rm stash.patch
0

Rethink: It is not necessary to limit the stash data to the working tree changes only, but it can be decided later at apply time to only apply the working tree changes of the stash.

Thus at stash time just do as usual:

git stash [-k|--keep-index]

At apply time do

git cherry-pick -m2 -n stash

Explanation: The -m2 selects the changes to the 2nd parent of the stage commit, which is the stored index state. -n|--no-commit blocks auto-commit. stash@{1} would be the ref for the 2nd stash on the stack ...

-1

To my knowledge, it is currently impossible to save only unstaged changes in the working tree with git stash push, i.e. to save changes from the index state. This command saves all changes in the working tree (staged and unstaged changes), i.e. changes from the HEAD state, even with the option --keep-index which also sets the working tree state to the index state instead of the HEAD state (thereby creating conflicts when restoring the changes from the HEAD state with git stash pop). It would be very convenient if git stash push had an option -U|--unstaged for saving only unstaged changes (to me the option --keep-index is flawed), since it has already an option -S|--staged for saving only staged changes.

So for the moment you have to emulate

git stash push --unstaged

git stash pop

with a temporary file:

git diff >unstaged
git restore .

git apply unstaged
rm unstaged

Your use case is testing before committing partial changes and it is already in the reference documentation, but with the flawed option --keep-index which creates conflicts. Here is the version with the emulated option -U|--unstaged:

git init
echo one >file
git add file
git commit
echo two >>file
git add file
echo three >>file
git diff >unstaged
git restore .
test
git commit
git apply unstaged
rm unstaged

Visualising states

For a better understanding of stashing, I think it is important to look at the states of the working tree, index and HEAD at each step. Let’s take your use case.

git init

working index HEAD

echo one >file

working index HEAD
one

git add file

working index HEAD
one one

git commit

working index HEAD
one one one

echo two >>file

working index HEAD
one one one
two

git add file

working index HEAD
one one one
two two

echo three >>file

working index HEAD
one one one
two two
three

git diff >unstaged

git restore .

working index HEAD
one one one
two two

test

git commit

working index HEAD
one one one
two two two

git apply unstaged

rm unstaged

working index HEAD
one one one
two two two
three

Not the answer you're looking for? Browse other questions tagged or ask your own question.