6 git-stash - Stash the changes in a dirty working directory away
11 'git stash' list [<options>]
12 'git stash' show [<options>] [<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' [push [-p|--patch] [-k|--[no-]keep-index] [-q|--quiet]
17 [-u|--include-untracked] [-a|--all] [-m|--message <message>]
20 'git stash' create [<message>]
21 'git stash' store [-m|--message <message>] [-q|--quiet] <commit>
26 Use `git stash` when you want to record the current state of the
27 working directory and the index, but want to go back to a clean
28 working directory. The command saves your local modifications away
29 and reverts the working directory to match the `HEAD` commit.
31 The modifications stashed away by this command can be listed with
32 `git stash list`, inspected with `git stash show`, and restored
33 (potentially on top of a different commit) with `git stash apply`.
34 Calling `git stash` without any arguments is equivalent to `git stash push`.
35 A stash is by default listed as "WIP on 'branchname' ...", but
36 you can give a more descriptive message on the command line when
39 The latest stash you created is stored in `refs/stash`; older
40 stashes are found in the reflog of this reference and can be named using
41 the usual reflog syntax (e.g. `stash@{0}` is the most recently
42 created stash, `stash@{1}` is the one before it, `stash@{2.hours.ago}`
43 is also possible). Stashes may also be referenced by specifying just the
44 stash index (e.g. the integer `n` is equivalent to `stash@{n}`).
49 push [-p|--patch] [-k|--[no-]keep-index] [-u|--include-untracked] [-a|--all] [-q|--quiet] [-m|--message <message>] [--] [<pathspec>...]::
51 Save your local modifications to a new 'stash entry' and roll them
52 back to HEAD (in the working tree and in the index).
53 The <message> part is optional and gives
54 the description along with the stashed state.
56 For quickly making a snapshot, you can omit "push". In this mode,
57 non-option arguments are not allowed to prevent a misspelled
58 subcommand from making an unwanted stash entry. The two exceptions to this
59 are `stash -p` which acts as alias for `stash push -p` and pathspecs,
60 which are allowed after a double hyphen `--` for disambiguation.
62 save [-p|--patch] [-k|--[no-]keep-index] [-u|--include-untracked] [-a|--all] [-q|--quiet] [<message>]::
64 This option is deprecated in favour of 'git stash push'. It
65 differs from "stash push" in that it cannot take pathspecs.
66 Instead, all non-option arguments are concatenated to form the stash
71 List the stash entries that you currently have. Each 'stash entry' is
72 listed with its name (e.g. `stash@{0}` is the latest entry, `stash@{1}` is
73 the one before, etc.), the name of the branch that was current when the
74 entry was made, and a short description of the commit the entry was
77 ----------------------------------------------------------------
78 stash@{0}: WIP on submit: 6ebd0e2... Update git-stash documentation
79 stash@{1}: On master: 9cc0589... Add git-stash
80 ----------------------------------------------------------------
82 The command takes options applicable to the 'git log'
83 command to control what is shown and how. See linkgit:git-log[1].
85 show [<options>] [<stash>]::
87 Show the changes recorded in the stash entry as a diff between the
88 stashed contents and the commit back when the stash entry was first
90 By default, the command shows the diffstat, but it will accept any
91 format known to 'git diff' (e.g., `git stash show -p stash@{1}`
92 to view the second most recent entry in patch form).
93 You can use stash.showStat and/or stash.showPatch config variables
94 to change the default behavior.
96 pop [--index] [-q|--quiet] [<stash>]::
98 Remove a single stashed state from the stash list and apply it
99 on top of the current working tree state, i.e., do the inverse
100 operation of `git stash push`. The working directory must
103 Applying the state can fail with conflicts; in this case, it is not
104 removed from the stash list. You need to resolve the conflicts by hand
105 and call `git stash drop` manually afterwards.
107 apply [--index] [-q|--quiet] [<stash>]::
109 Like `pop`, but do not remove the state from the stash list. Unlike `pop`,
110 `<stash>` may be any commit that looks like a commit created by
111 `stash push` or `stash create`.
113 branch <branchname> [<stash>]::
115 Creates and checks out a new branch named `<branchname>` starting from
116 the commit at which the `<stash>` was originally created, applies the
117 changes recorded in `<stash>` to the new working tree and index.
118 If that succeeds, and `<stash>` is a reference of the form
119 `stash@{<revision>}`, it then drops the `<stash>`.
121 This is useful if the branch on which you ran `git stash push` has
122 changed enough that `git stash apply` fails due to conflicts. Since
123 the stash entry is applied on top of the commit that was HEAD at the
124 time `git stash` was run, it restores the originally stashed state
128 Remove all the stash entries. Note that those entries will then
129 be subject to pruning, and may be impossible to recover (see
130 'Examples' below for a possible strategy).
132 drop [-q|--quiet] [<stash>]::
134 Remove a single stash entry from the list of stash entries.
138 Create a stash entry (which is a regular commit object) and
139 return its object name, without storing it anywhere in the ref
141 This is intended to be useful for scripts. It is probably not
142 the command you want to use; see "push" above.
146 Store a given stash created via 'git stash create' (which is a
147 dangling merge commit) in the stash ref, updating the stash
148 reflog. This is intended to be useful for scripts. It is
149 probably not the command you want to use; see "push" above.
155 This option is only valid for `push` and `save` commands.
157 All ignored and untracked files are also stashed and then cleaned
161 --include-untracked::
162 This option is only valid for `push` and `save` commands.
164 All untracked files are also stashed and then cleaned up with
168 This option is only valid for `pop` and `apply` commands.
170 Tries to reinstate not only the working tree's changes, but also
171 the index's ones. However, this can fail, when you have conflicts
172 (which are stored in the index, where you therefore can no longer
173 apply the changes as they were originally).
178 This option is only valid for `push` and `save` commands.
180 All changes already added to the index are left intact.
184 This option is only valid for `push` and `save` commands.
186 Interactively select hunks from the diff between HEAD and the
187 working tree to be stashed. The stash entry is constructed such
188 that its index state is the same as the index state of your
189 repository, and its worktree contains only the changes you selected
190 interactively. The selected changes are then rolled back from your
191 worktree. See the ``Interactive Mode'' section of linkgit:git-add[1]
192 to learn how to operate the `--patch` mode.
194 The `--patch` option implies `--keep-index`. You can use
195 `--no-keep-index` to override this.
199 This option is only valid for `apply`, `drop`, `pop`, `push`,
200 `save`, `store` commands.
202 Quiet, suppress feedback messages.
205 This option is only valid for `push` command.
207 Separates pathspec from options for disambiguation purposes.
210 This option is only valid for `push` command.
212 The new stash entry records the modified states only for the files
213 that match the pathspec. The index entries and working tree files
214 are then rolled back to the state in HEAD only for these files,
215 too, leaving files that do not match the pathspec intact.
218 This option is only valid for `apply`, `branch`, `drop`, `pop`,
221 A reference of the form `stash@{<revision>}`. When no `<stash>` is
222 given, the latest stash is assumed (that is, `stash@{0}`).
227 A stash entry is represented as a commit whose tree records the state
228 of the working directory, and its first parent is the commit at `HEAD`
229 when the entry was created. The tree of the second parent records the
230 state of the index when the entry is made, and it is made a child of
231 the `HEAD` commit. The ancestry graph looks like this:
237 where `H` is the `HEAD` commit, `I` is a commit that records the state
238 of the index, and `W` is a commit that records the state of the working
245 Pulling into a dirty tree::
247 When you are in the middle of something, you learn that there are
248 upstream changes that are possibly relevant to what you are
249 doing. When your local changes do not conflict with the changes in
250 the upstream, a simple `git pull` will let you move forward.
252 However, there are cases in which your local changes do conflict with
253 the upstream changes, and `git pull` refuses to overwrite your
254 changes. In such a case, you can stash your changes away,
255 perform a pull, and then unstash, like this:
257 ----------------------------------------------------------------
260 file foobar not up to date, cannot merge.
264 ----------------------------------------------------------------
266 Interrupted workflow::
268 When you are in the middle of something, your boss comes in and
269 demands that you fix something immediately. Traditionally, you would
270 make a commit to a temporary branch to store your changes away, and
271 return to your original branch to make the emergency fix, like this:
273 ----------------------------------------------------------------
274 # ... hack hack hack ...
275 $ git switch -c my_wip
276 $ git commit -a -m "WIP"
279 $ git commit -a -m "Fix in a hurry"
281 $ git reset --soft HEAD^
282 # ... continue hacking ...
283 ----------------------------------------------------------------
285 You can use 'git stash' to simplify the above, like this:
287 ----------------------------------------------------------------
288 # ... hack hack hack ...
291 $ git commit -a -m "Fix in a hurry"
293 # ... continue hacking ...
294 ----------------------------------------------------------------
296 Testing partial commits::
298 You can use `git stash push --keep-index` when you want to make two or
299 more commits out of the changes in the work tree, and you want to test
300 each change before committing:
302 ----------------------------------------------------------------
303 # ... hack hack hack ...
304 $ git add --patch foo # add just first part to the index
305 $ git stash push --keep-index # save all other changes to the stash
306 $ edit/build/test first part
307 $ git commit -m 'First part' # commit fully tested change
308 $ git stash pop # prepare to work on all other changes
309 # ... repeat above five steps until one commit remains ...
310 $ edit/build/test remaining parts
311 $ git commit foo -m 'Remaining parts'
312 ----------------------------------------------------------------
314 Recovering stash entries that were cleared/dropped erroneously::
316 If you mistakenly drop or clear stash entries, they cannot be recovered
317 through the normal safety mechanisms. However, you can try the
318 following incantation to get a list of stash entries that are still in
319 your repository, but not reachable any more:
321 ----------------------------------------------------------------
322 git fsck --unreachable |
323 grep commit | cut -d\ -f3 |
324 xargs git log --merges --no-walk --grep=WIP
325 ----------------------------------------------------------------
330 linkgit:git-checkout[1],
331 linkgit:git-commit[1],
332 linkgit:git-reflog[1],
333 linkgit:git-reset[1],
334 linkgit:git-switch[1]
338 Part of the linkgit:git[1] suite