6 git-stash - Stash the changes in a dirty working directory away
11 'git stash' list [<options>]
12 'git stash' show [<stash>]
13 'git stash' drop [-q|--quiet] [<stash>]
14 'git stash' ( pop | apply ) [--index] [-q|--quiet] [<stash>]
15 'git stash' branch <branchname> [<stash>]
16 'git stash' save [-p|--patch] [-k|--[no-]keep-index] [-q|--quiet]
17 [-u|--include-untracked] [-a|--all] [<message>]
18 'git stash' [push [-p|--patch] [-k|--[no-]keep-index] [-q|--quiet]
19 [-u|--include-untracked] [-a|--all] [-m|--message <message>]]
22 'git stash' create [<message>]
23 'git stash' store [-m|--message <message>] [-q|--quiet] <commit>
28 Use `git stash` when you want to record the current state of the
29 working directory and the index, but want to go back to a clean
30 working directory. The command saves your local modifications away
31 and reverts the working directory to match the `HEAD` commit.
33 The modifications stashed away by this command can be listed with
34 `git stash list`, inspected with `git stash show`, and restored
35 (potentially on top of a different commit) with `git stash apply`.
36 Calling `git stash` without any arguments is equivalent to `git stash save`.
37 A stash is by default listed as "WIP on 'branchname' ...", but
38 you can give a more descriptive message on the command line when
41 The latest stash you created is stored in `refs/stash`; older
42 stashes are found in the reflog of this reference and can be named using
43 the usual reflog syntax (e.g. `stash@{0}` is the most recently
44 created stash, `stash@{1}` is the one before it, `stash@{2.hours.ago}`
45 is also possible). Stashes may also be referenced by specifying just the
46 stash index (e.g. the integer `n` is equivalent to `stash@{n}`).
51 save [-p|--patch] [-k|--[no-]keep-index] [-u|--include-untracked] [-a|--all] [-q|--quiet] [<message>]::
52 push [-p|--patch] [-k|--[no-]keep-index] [-u|--include-untracked] [-a|--all] [-q|--quiet] [-m|--message <message>] [--] [<pathspec>...]::
54 Save your local modifications to a new 'stash' and roll them
55 back to HEAD (in the working tree and in the index).
56 The <message> part is optional and gives
57 the description along with the stashed state. For quickly making
58 a snapshot, you can omit _both_ "save" and <message>, but giving
59 only <message> does not trigger this action to prevent a misspelled
60 subcommand from making an unwanted stash.
62 When pathspec is given to 'git stash push', the new stash records the
63 modified states only for the files that match the pathspec. The index
64 entries and working tree files are then rolled back to the state in
65 HEAD only for these files, too, leaving files that do not match the
68 If the `--keep-index` option is used, all changes already added to the
69 index are left intact.
71 If the `--include-untracked` option is used, all untracked files are also
72 stashed and then cleaned up with `git clean`, leaving the working directory
73 in a very clean state. If the `--all` option is used instead then the
74 ignored files are stashed and cleaned in addition to the untracked files.
76 With `--patch`, you can interactively select hunks from the diff
77 between HEAD and the working tree to be stashed. The stash entry is
78 constructed such that its index state is the same as the index state
79 of your repository, and its worktree contains only the changes you
80 selected interactively. The selected changes are then rolled back
81 from your worktree. See the ``Interactive Mode'' section of
82 linkgit:git-add[1] to learn how to operate the `--patch` mode.
84 The `--patch` option implies `--keep-index`. You can use
85 `--no-keep-index` to override this.
89 List the stashes that you currently have. Each 'stash' is listed
90 with its name (e.g. `stash@{0}` is the latest stash, `stash@{1}` is
91 the one before, etc.), the name of the branch that was current when the
92 stash was made, and a short description of the commit the stash was
95 ----------------------------------------------------------------
96 stash@{0}: WIP on submit: 6ebd0e2... Update git-stash documentation
97 stash@{1}: On master: 9cc0589... Add git-stash
98 ----------------------------------------------------------------
100 The command takes options applicable to the 'git log'
101 command to control what is shown and how. See linkgit:git-log[1].
105 Show the changes recorded in the stash as a diff between the
106 stashed state and its original parent. When no `<stash>` is given,
107 shows the latest one. By default, the command shows the diffstat, but
108 it will accept any format known to 'git diff' (e.g., `git stash show
109 -p stash@{1}` to view the second most recent stash in patch form).
110 You can use stash.showStat and/or stash.showPatch config variables
111 to change the default behavior.
113 pop [--index] [-q|--quiet] [<stash>]::
115 Remove a single stashed state from the stash list and apply it
116 on top of the current working tree state, i.e., do the inverse
117 operation of `git stash save`. The working directory must
120 Applying the state can fail with conflicts; in this case, it is not
121 removed from the stash list. You need to resolve the conflicts by hand
122 and call `git stash drop` manually afterwards.
124 If the `--index` option is used, then tries to reinstate not only the working
125 tree's changes, but also the index's ones. However, this can fail, when you
126 have conflicts (which are stored in the index, where you therefore can no
127 longer apply the changes as they were originally).
129 When no `<stash>` is given, `stash@{0}` is assumed, otherwise `<stash>` must
130 be a reference of the form `stash@{<revision>}`.
132 apply [--index] [-q|--quiet] [<stash>]::
134 Like `pop`, but do not remove the state from the stash list. Unlike `pop`,
135 `<stash>` may be any commit that looks like a commit created by
136 `stash save` or `stash create`.
138 branch <branchname> [<stash>]::
140 Creates and checks out a new branch named `<branchname>` starting from
141 the commit at which the `<stash>` was originally created, applies the
142 changes recorded in `<stash>` to the new working tree and index.
143 If that succeeds, and `<stash>` is a reference of the form
144 `stash@{<revision>}`, it then drops the `<stash>`. When no `<stash>`
145 is given, applies the latest one.
147 This is useful if the branch on which you ran `git stash save` has
148 changed enough that `git stash apply` fails due to conflicts. Since
149 the stash is applied on top of the commit that was HEAD at the time
150 `git stash` was run, it restores the originally stashed state with
154 Remove all the stashed states. Note that those states will then
155 be subject to pruning, and may be impossible to recover (see
156 'Examples' below for a possible strategy).
158 drop [-q|--quiet] [<stash>]::
160 Remove a single stashed state from the stash list. When no `<stash>`
161 is given, it removes the latest one. i.e. `stash@{0}`, otherwise
162 `<stash>` must be a valid stash log reference of the form
163 `stash@{<revision>}`.
167 Create a stash (which is a regular commit object) and return its
168 object name, without storing it anywhere in the ref namespace.
169 This is intended to be useful for scripts. It is probably not
170 the command you want to use; see "save" above.
174 Store a given stash created via 'git stash create' (which is a
175 dangling merge commit) in the stash ref, updating the stash
176 reflog. This is intended to be useful for scripts. It is
177 probably not the command you want to use; see "save" above.
182 A stash is represented as a commit whose tree records the state of the
183 working directory, and its first parent is the commit at `HEAD` when
184 the stash was created. The tree of the second parent records the
185 state of the index when the stash is made, and it is made a child of
186 the `HEAD` commit. The ancestry graph looks like this:
192 where `H` is the `HEAD` commit, `I` is a commit that records the state
193 of the index, and `W` is a commit that records the state of the working
200 Pulling into a dirty tree::
202 When you are in the middle of something, you learn that there are
203 upstream changes that are possibly relevant to what you are
204 doing. When your local changes do not conflict with the changes in
205 the upstream, a simple `git pull` will let you move forward.
207 However, there are cases in which your local changes do conflict with
208 the upstream changes, and `git pull` refuses to overwrite your
209 changes. In such a case, you can stash your changes away,
210 perform a pull, and then unstash, like this:
212 ----------------------------------------------------------------
215 file foobar not up to date, cannot merge.
219 ----------------------------------------------------------------
221 Interrupted workflow::
223 When you are in the middle of something, your boss comes in and
224 demands that you fix something immediately. Traditionally, you would
225 make a commit to a temporary branch to store your changes away, and
226 return to your original branch to make the emergency fix, like this:
228 ----------------------------------------------------------------
229 # ... hack hack hack ...
230 $ git checkout -b my_wip
231 $ git commit -a -m "WIP"
232 $ git checkout master
234 $ git commit -a -m "Fix in a hurry"
235 $ git checkout my_wip
236 $ git reset --soft HEAD^
237 # ... continue hacking ...
238 ----------------------------------------------------------------
240 You can use 'git stash' to simplify the above, like this:
242 ----------------------------------------------------------------
243 # ... hack hack hack ...
246 $ git commit -a -m "Fix in a hurry"
248 # ... continue hacking ...
249 ----------------------------------------------------------------
251 Testing partial commits::
253 You can use `git stash save --keep-index` when you want to make two or
254 more commits out of the changes in the work tree, and you want to test
255 each change before committing:
257 ----------------------------------------------------------------
258 # ... hack hack hack ...
259 $ git add --patch foo # add just first part to the index
260 $ git stash save --keep-index # save all other changes to the stash
261 $ edit/build/test first part
262 $ git commit -m 'First part' # commit fully tested change
263 $ git stash pop # prepare to work on all other changes
264 # ... repeat above five steps until one commit remains ...
265 $ edit/build/test remaining parts
266 $ git commit foo -m 'Remaining parts'
267 ----------------------------------------------------------------
269 Recovering stashes that were cleared/dropped erroneously::
271 If you mistakenly drop or clear stashes, they cannot be recovered
272 through the normal safety mechanisms. However, you can try the
273 following incantation to get a list of stashes that are still in your
274 repository, but not reachable any more:
276 ----------------------------------------------------------------
277 git fsck --unreachable |
278 grep commit | cut -d\ -f3 |
279 xargs git log --merges --no-walk --grep=WIP
280 ----------------------------------------------------------------
285 linkgit:git-checkout[1],
286 linkgit:git-commit[1],
287 linkgit:git-reflog[1],
292 Part of the linkgit:git[1] suite