{ "content": [ { "type": "text", "text": "# GIT-STASH(1) (man)\n\n**Summary:** git-stash - Stash the changes in a dirty working directory away\n\n**Synopsis:** git stash list []\ngit stash show [-u|--include-untracked|--only-untracked] [] []\ngit stash drop [-q|--quiet] []\ngit stash ( pop | apply ) [--index] [-q|--quiet] []\ngit stash branch []\ngit stash [push [-p|--patch] [-k|--[no-]keep-index] [-q|--quiet]\n[-u|--include-untracked] [-a|--all] [-m|--message ]\n[--pathspec-from-file= [--pathspec-file-nul]]\n[--] [...]]\ngit stash clear\ngit stash create []\ngit stash store [-m|--message ] [-q|--quiet] \n\n## Flags\n\n| Flag | Long | Arg | Description |\n|------|------|-----|-------------|\n| -a | --all | — | This option is only valid for push and save commands. All ignored and untracked files are also stashed and then cleaned |\n| -u | --no-include-untracked | — | When used with the push and save commands, all untracked files are also stashed and then cleaned up with git clean. When |\n| — | --only-untracked | — | This option is only valid for the show command. Show only the untracked files in the stash entry as part of the diff. |\n| — | --index | — | This option is only valid for pop and apply commands. Tries to reinstate not only the working tree’s changes, but also t |\n| -k | --no-keep-index | — | This option is only valid for push and save commands. All changes already added to the index are left intact. |\n| -p | --patch | — | This option is only valid for push and save commands. Interactively select hunks from the diff between HEAD and the work |\n| — | --pathspec-file-nul | — | This option is only valid for push command. Only meaningful with --pathspec-from-file. Pathspec elements are separated w |\n| -q | --quiet | — | This option is only valid for apply, drop, pop, push, save, store commands. Quiet, suppress feedback messages. -- This o |\n\n## Examples\n\n- `Pulling into a dirty tree`\n- `When you are in the middle of something, you learn that there are upstream changes that`\n- `are possibly relevant to what you are doing. When your local changes do not conflict with`\n- `the changes in the upstream, a simple git pull will let you move forward.`\n- `However, there are cases in which your local changes do conflict with the upstream`\n- `changes, and git pull refuses to overwrite your changes. In such a case, you can stash`\n- `your changes away, perform a pull, and then unstash, like this:`\n- `$ git pull`\n- `...`\n- `file foobar not up to date, cannot merge.`\n- `$ git stash`\n- `$ git pull`\n- `$ git stash pop`\n- `Interrupted workflow`\n- `When you are in the middle of something, your boss comes in and demands that you fix`\n- `something immediately. Traditionally, you would make a commit to a temporary branch to`\n- `store your changes away, and return to your original branch to make the emergency fix,`\n- `like this:`\n- `# ... hack hack hack ...`\n- `$ git switch -c mywip`\n- `$ git commit -a -m \"WIP\"`\n- `$ git switch master`\n- `$ edit emergency fix`\n- `$ git commit -a -m \"Fix in a hurry\"`\n- `$ git switch mywip`\n- `$ git reset --soft HEAD^`\n- `# ... continue hacking ...`\n- `You can use git stash to simplify the above, like this:`\n- `# ... hack hack hack ...`\n- `$ git stash`\n- `$ edit emergency fix`\n- `$ git commit -a -m \"Fix in a hurry\"`\n- `$ git stash pop`\n- `# ... continue hacking ...`\n- `Testing partial commits`\n- `You can use git stash push --keep-index when you want to make two or more commits out of`\n- `the changes in the work tree, and you want to test each change before committing:`\n- `# ... hack hack hack ...`\n- `$ git add --patch foo # add just first part to the index`\n- `$ git stash push --keep-index # save all other changes to the stash`\n- `$ edit/build/test first part`\n- `$ git commit -m 'First part' # commit fully tested change`\n- `$ git stash pop # prepare to work on all other changes`\n- `# ... repeat above five steps until one commit remains ...`\n- `$ edit/build/test remaining parts`\n- `$ git commit foo -m 'Remaining parts'`\n- `Recovering stash entries that were cleared/dropped erroneously`\n- `If you mistakenly drop or clear stash entries, they cannot be recovered through the`\n- `normal safety mechanisms. However, you can try the following incantation to get a list of`\n- `stash entries that are still in your repository, but not reachable any more:`\n- `git fsck --unreachable |`\n- `grep commit | cut -d\\ -f3 |`\n- `xargs git log --merges --no-walk --grep=WIP`\n\n## See Also\n\n- git-checkout(1)\n- git-commit(1)\n- git-reflog(1)\n- git-reset(1)\n- git-switch(1)\n\n## Section Outline\n\n- **NAME** (2 lines)\n- **SYNOPSIS** (14 lines)\n- **DESCRIPTION** (16 lines)\n- **COMMANDS** (80 lines)\n- **OPTIONS** (1 lines) — 8 subsections\n - -a, --all (4 lines)\n - -u, --include-untracked, --no-include-untracked (6 lines)\n - --only-untracked (4 lines)\n - --index (6 lines)\n - -k, --keep-index, --no-keep-index (4 lines)\n - -p, --patch (18 lines)\n - --pathspec-file-nul (5 lines)\n - -q, --quiet (24 lines)\n- **DISCUSSION** (12 lines)\n- **EXAMPLES** (68 lines)\n- **SEE ALSO** (2 lines)\n- **GIT** (5 lines)\n\n## Full Content\n\n### NAME\n\ngit-stash - Stash the changes in a dirty working directory away\n\n### SYNOPSIS\n\ngit stash list []\ngit stash show [-u|--include-untracked|--only-untracked] [] []\ngit stash drop [-q|--quiet] []\ngit stash ( pop | apply ) [--index] [-q|--quiet] []\ngit stash branch []\ngit stash [push [-p|--patch] [-k|--[no-]keep-index] [-q|--quiet]\n[-u|--include-untracked] [-a|--all] [-m|--message ]\n[--pathspec-from-file= [--pathspec-file-nul]]\n[--] [...]]\ngit stash clear\ngit stash create []\ngit stash store [-m|--message ] [-q|--quiet] \n\n### DESCRIPTION\n\nUse git stash when you want to record the current state of the working directory and the\nindex, but want to go back to a clean working directory. The command saves your local\nmodifications away and reverts the working directory to match the HEAD commit.\n\nThe modifications stashed away by this command can be listed with git stash list, inspected\nwith git stash show, and restored (potentially on top of a different commit) with git stash\napply. Calling git stash without any arguments is equivalent to git stash push. A stash is by\ndefault listed as \"WIP on branchname ...\", but you can give a more descriptive message on the\ncommand line when you create one.\n\nThe latest stash you created is stored in refs/stash; older stashes are found in the reflog\nof this reference and can be named using the usual reflog syntax (e.g. stash@{0} is the most\nrecently created stash, stash@{1} is the one before it, stash@{2.hours.ago} is also\npossible). Stashes may also be referenced by specifying just the stash index (e.g. the\ninteger n is equivalent to stash@{n}).\n\n### COMMANDS\n\npush [-p|--patch] [-k|--[no-]keep-index] [-u|--include-untracked] [-a|--all] [-q|--quiet]\n[-m|--message ] [--pathspec-from-file= [--pathspec-file-nul]] [--]\n[...]\nSave your local modifications to a new stash entry and roll them back to HEAD (in the\nworking tree and in the index). The part is optional and gives the description\nalong with the stashed state.\n\nFor quickly making a snapshot, you can omit \"push\". In this mode, non-option arguments\nare not allowed to prevent a misspelled subcommand from making an unwanted stash entry.\nThe two exceptions to this are stash -p which acts as alias for stash push -p and\npathspec elements, which are allowed after a double hyphen -- for disambiguation.\n\nsave [-p|--patch] [-k|--[no-]keep-index] [-u|--include-untracked] [-a|--all] [-q|--quiet]\n[]\nThis option is deprecated in favour of git stash push. It differs from \"stash push\" in\nthat it cannot take pathspec. Instead, all non-option arguments are concatenated to form\nthe stash message.\n\nlist []\nList the stash entries that you currently have. Each stash entry is listed with its name\n(e.g. stash@{0} is the latest entry, stash@{1} is the one before, etc.), the name of the\nbranch that was current when the entry was made, and a short description of the commit\nthe entry was based on.\n\nstash@{0}: WIP on submit: 6ebd0e2... Update git-stash documentation\nstash@{1}: On master: 9cc0589... Add git-stash\n\nThe command takes options applicable to the git log command to control what is shown and\nhow. See git-log(1).\n\nshow [-u|--include-untracked|--only-untracked] [] []\nShow the changes recorded in the stash entry as a diff between the stashed contents and\nthe commit back when the stash entry was first created. By default, the command shows the\ndiffstat, but it will accept any format known to git diff (e.g., git stash show -p\nstash@{1} to view the second most recent entry in patch form). If no is\nprovided, the default behavior will be given by the stash.showStat, and stash.showPatch\nconfig variables. You can also use stash.showIncludeUntracked to set whether\n--include-untracked is enabled by default.\n\npop [--index] [-q|--quiet] []\nRemove a single stashed state from the stash list and apply it on top of the current\nworking tree state, i.e., do the inverse operation of git stash push. The working\ndirectory must match the index.\n\nApplying the state can fail with conflicts; in this case, it is not removed from the\nstash list. You need to resolve the conflicts by hand and call git stash drop manually\nafterwards.\n\napply [--index] [-q|--quiet] []\nLike pop, but do not remove the state from the stash list. Unlike pop, may be any\ncommit that looks like a commit created by stash push or stash create.\n\nbranch []\nCreates and checks out a new branch named starting from the commit at which\nthe was originally created, applies the changes recorded in to the new\nworking tree and index. If that succeeds, and is a reference of the form\nstash@{}, it then drops the .\n\nThis is useful if the branch on which you ran git stash push has changed enough that git\nstash apply fails due to conflicts. Since the stash entry is applied on top of the commit\nthat was HEAD at the time git stash was run, it restores the originally stashed state\nwith no conflicts.\n\nclear\nRemove all the stash entries. Note that those entries will then be subject to pruning,\nand may be impossible to recover (see Examples below for a possible strategy).\n\ndrop [-q|--quiet] []\nRemove a single stash entry from the list of stash entries.\n\ncreate\nCreate a stash entry (which is a regular commit object) and return its object name,\nwithout storing it anywhere in the ref namespace. This is intended to be useful for\nscripts. It is probably not the command you want to use; see \"push\" above.\n\nstore\nStore a given stash created via git stash create (which is a dangling merge commit) in\nthe stash ref, updating the stash reflog. This is intended to be useful for scripts. It\nis probably not the command you want to use; see \"push\" above.\n\n### OPTIONS\n\n#### -a, --all\n\nThis option is only valid for push and save commands.\n\nAll ignored and untracked files are also stashed and then cleaned up with git clean.\n\n#### -u, --include-untracked, --no-include-untracked\n\nWhen used with the push and save commands, all untracked files are also stashed and then\ncleaned up with git clean.\n\nWhen used with the show command, show the untracked files in the stash entry as part of\nthe diff.\n\n#### --only-untracked\n\nThis option is only valid for the show command.\n\nShow only the untracked files in the stash entry as part of the diff.\n\n#### --index\n\nThis option is only valid for pop and apply commands.\n\nTries to reinstate not only the working tree’s changes, but also the index’s ones.\nHowever, this can fail, when you have conflicts (which are stored in the index, where you\ntherefore can no longer apply the changes as they were originally).\n\n#### -k, --keep-index, --no-keep-index\n\nThis option is only valid for push and save commands.\n\nAll changes already added to the index are left intact.\n\n#### -p, --patch\n\nThis option is only valid for push and save commands.\n\nInteractively select hunks from the diff between HEAD and the working tree to be stashed.\nThe stash entry is constructed such that its index state is the same as the index state\nof your repository, and its worktree contains only the changes you selected\ninteractively. The selected changes are then rolled back from your worktree. See the\n“Interactive Mode” section of git-add(1) to learn how to operate the --patch mode.\n\nThe --patch option implies --keep-index. You can use --no-keep-index to override this.\n\n--pathspec-from-file=\nThis option is only valid for push command.\n\nPathspec is passed in instead of commandline args. If is exactly - then\nstandard input is used. Pathspec elements are separated by LF or CR/LF. Pathspec elements\ncan be quoted as explained for the configuration variable core.quotePath (see git-\nconfig(1)). See also --pathspec-file-nul and global --literal-pathspecs.\n\n#### --pathspec-file-nul\n\nThis option is only valid for push command.\n\nOnly meaningful with --pathspec-from-file. Pathspec elements are separated with NUL\ncharacter and all other characters are taken literally (including newlines and quotes).\n\n#### -q, --quiet\n\nThis option is only valid for apply, drop, pop, push, save, store commands.\n\nQuiet, suppress feedback messages.\n\n--\nThis option is only valid for push command.\n\nSeparates pathspec from options for disambiguation purposes.\n\n...\nThis option is only valid for push command.\n\nThe new stash entry records the modified states only for the files that match the\npathspec. The index entries and working tree files are then rolled back to the state in\nHEAD only for these files, too, leaving files that do not match the pathspec intact.\n\nFor more details, see the pathspec entry in gitglossary(7).\n\n\nThis option is only valid for apply, branch, drop, pop, show commands.\n\nA reference of the form stash@{}. When no is given, the latest stash is\nassumed (that is, stash@{0}).\n\n### DISCUSSION\n\nA stash entry is represented as a commit whose tree records the state of the working\ndirectory, and its first parent is the commit at HEAD when the entry was created. The tree of\nthe second parent records the state of the index when the entry is made, and it is made a\nchild of the HEAD commit. The ancestry graph looks like this:\n\n.----W\n/ /\n-----H----I\n\nwhere H is the HEAD commit, I is a commit that records the state of the index, and W is a\ncommit that records the state of the working tree.\n\n### EXAMPLES\n\nPulling into a dirty tree\nWhen you are in the middle of something, you learn that there are upstream changes that\nare possibly relevant to what you are doing. When your local changes do not conflict with\nthe changes in the upstream, a simple git pull will let you move forward.\n\nHowever, there are cases in which your local changes do conflict with the upstream\nchanges, and git pull refuses to overwrite your changes. In such a case, you can stash\nyour changes away, perform a pull, and then unstash, like this:\n\n$ git pull\n...\nfile foobar not up to date, cannot merge.\n$ git stash\n$ git pull\n$ git stash pop\n\n\nInterrupted workflow\nWhen you are in the middle of something, your boss comes in and demands that you fix\nsomething immediately. Traditionally, you would make a commit to a temporary branch to\nstore your changes away, and return to your original branch to make the emergency fix,\nlike this:\n\n# ... hack hack hack ...\n$ git switch -c mywip\n$ git commit -a -m \"WIP\"\n$ git switch master\n$ edit emergency fix\n$ git commit -a -m \"Fix in a hurry\"\n$ git switch mywip\n$ git reset --soft HEAD^\n# ... continue hacking ...\n\nYou can use git stash to simplify the above, like this:\n\n# ... hack hack hack ...\n$ git stash\n$ edit emergency fix\n$ git commit -a -m \"Fix in a hurry\"\n$ git stash pop\n# ... continue hacking ...\n\n\nTesting partial commits\nYou can use git stash push --keep-index when you want to make two or more commits out of\nthe changes in the work tree, and you want to test each change before committing:\n\n# ... hack hack hack ...\n$ git add --patch foo # add just first part to the index\n$ git stash push --keep-index # save all other changes to the stash\n$ edit/build/test first part\n$ git commit -m 'First part' # commit fully tested change\n$ git stash pop # prepare to work on all other changes\n# ... repeat above five steps until one commit remains ...\n$ edit/build/test remaining parts\n$ git commit foo -m 'Remaining parts'\n\n\nRecovering stash entries that were cleared/dropped erroneously\nIf you mistakenly drop or clear stash entries, they cannot be recovered through the\nnormal safety mechanisms. However, you can try the following incantation to get a list of\nstash entries that are still in your repository, but not reachable any more:\n\ngit fsck --unreachable |\ngrep commit | cut -d\\ -f3 |\nxargs git log --merges --no-walk --grep=WIP\n\n### SEE ALSO\n\ngit-checkout(1), git-commit(1), git-reflog(1), git-reset(1), git-switch(1)\n\n### GIT\n\nPart of the git(1) suite\n\n\n\nGit 2.34.1 02/26/2026 GIT-STASH(1)\n\n" } ], "structuredContent": { "command": "GIT-STASH", "section": "1", "mode": "man", "summary": "git-stash - Stash the changes in a dirty working directory away", "synopsis": "git stash list []\ngit stash show [-u|--include-untracked|--only-untracked] [] []\ngit stash drop [-q|--quiet] []\ngit stash ( pop | apply ) [--index] [-q|--quiet] []\ngit stash branch []\ngit stash [push [-p|--patch] [-k|--[no-]keep-index] [-q|--quiet]\n[-u|--include-untracked] [-a|--all] [-m|--message ]\n[--pathspec-from-file= [--pathspec-file-nul]]\n[--] [...]]\ngit stash clear\ngit stash create []\ngit stash store [-m|--message ] [-q|--quiet] ", "flags": [ { "flag": "-a", "long": "--all", "arg": null, "description": "This option is only valid for push and save commands. All ignored and untracked files are also stashed and then cleaned up with git clean." }, { "flag": "-u", "long": "--no-include-untracked", "arg": null, "description": "When used with the push and save commands, all untracked files are also stashed and then cleaned up with git clean. When used with the show command, show the untracked files in the stash entry as part of the diff." }, { "flag": "", "long": "--only-untracked", "arg": null, "description": "This option is only valid for the show command. Show only the untracked files in the stash entry as part of the diff." }, { "flag": "", "long": "--index", "arg": null, "description": "This option is only valid for pop and apply commands. Tries to reinstate not only the working tree’s changes, but also the index’s ones. However, this can fail, when you have conflicts (which are stored in the index, where you therefore can no longer apply the changes as they were originally)." }, { "flag": "-k", "long": "--no-keep-index", "arg": null, "description": "This option is only valid for push and save commands. All changes already added to the index are left intact." }, { "flag": "-p", "long": "--patch", "arg": null, "description": "This option is only valid for push and save commands. Interactively select hunks from the diff between HEAD and the working tree to be stashed. The stash entry is constructed such that its index state is the same as the index state of your repository, and its worktree contains only the changes you selected interactively. The selected changes are then rolled back from your worktree. See the “Interactive Mode” section of git-add(1) to learn how to operate the --patch mode. The --patch option implies --keep-index. You can use --no-keep-index to override this. --pathspec-from-file= This option is only valid for push command. Pathspec is passed in instead of commandline args. If is exactly - then standard input is used. Pathspec elements are separated by LF or CR/LF. Pathspec elements can be quoted as explained for the configuration variable core.quotePath (see git- config(1)). See also --pathspec-file-nul and global --literal-pathspecs." }, { "flag": "", "long": "--pathspec-file-nul", "arg": null, "description": "This option is only valid for push command. Only meaningful with --pathspec-from-file. Pathspec elements are separated with NUL character and all other characters are taken literally (including newlines and quotes)." }, { "flag": "-q", "long": "--quiet", "arg": null, "description": "This option is only valid for apply, drop, pop, push, save, store commands. Quiet, suppress feedback messages. -- This option is only valid for push command. Separates pathspec from options for disambiguation purposes. ... This option is only valid for push command. The new stash entry records the modified states only for the files that match the pathspec. The index entries and working tree files are then rolled back to the state in HEAD only for these files, too, leaving files that do not match the pathspec intact. For more details, see the pathspec entry in gitglossary(7). This option is only valid for apply, branch, drop, pop, show commands. A reference of the form stash@{}. When no is given, the latest stash is assumed (that is, stash@{0})." } ], "examples": [ "Pulling into a dirty tree", "When you are in the middle of something, you learn that there are upstream changes that", "are possibly relevant to what you are doing. When your local changes do not conflict with", "the changes in the upstream, a simple git pull will let you move forward.", "However, there are cases in which your local changes do conflict with the upstream", "changes, and git pull refuses to overwrite your changes. In such a case, you can stash", "your changes away, perform a pull, and then unstash, like this:", "$ git pull", "...", "file foobar not up to date, cannot merge.", "$ git stash", "$ git pull", "$ git stash pop", "Interrupted workflow", "When you are in the middle of something, your boss comes in and demands that you fix", "something immediately. Traditionally, you would make a commit to a temporary branch to", "store your changes away, and return to your original branch to make the emergency fix,", "like this:", "# ... hack hack hack ...", "$ git switch -c mywip", "$ git commit -a -m \"WIP\"", "$ git switch master", "$ edit emergency fix", "$ git commit -a -m \"Fix in a hurry\"", "$ git switch mywip", "$ git reset --soft HEAD^", "# ... continue hacking ...", "You can use git stash to simplify the above, like this:", "# ... hack hack hack ...", "$ git stash", "$ edit emergency fix", "$ git commit -a -m \"Fix in a hurry\"", "$ git stash pop", "# ... continue hacking ...", "Testing partial commits", "You can use git stash push --keep-index when you want to make two or more commits out of", "the changes in the work tree, and you want to test each change before committing:", "# ... hack hack hack ...", "$ git add --patch foo # add just first part to the index", "$ git stash push --keep-index # save all other changes to the stash", "$ edit/build/test first part", "$ git commit -m 'First part' # commit fully tested change", "$ git stash pop # prepare to work on all other changes", "# ... repeat above five steps until one commit remains ...", "$ edit/build/test remaining parts", "$ git commit foo -m 'Remaining parts'", "Recovering stash entries that were cleared/dropped erroneously", "If you mistakenly drop or clear stash entries, they cannot be recovered through the", "normal safety mechanisms. However, you can try the following incantation to get a list of", "stash entries that are still in your repository, but not reachable any more:", "git fsck --unreachable |", "grep commit | cut -d\\ -f3 |", "xargs git log --merges --no-walk --grep=WIP" ], "see_also": [ { "name": "git-checkout", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/git-checkout/1/json" }, { "name": "git-commit", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/git-commit/1/json" }, { "name": "git-reflog", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/git-reflog/1/json" }, { "name": "git-reset", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/git-reset/1/json" }, { "name": "git-switch", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/git-switch/1/json" } ], "section_outline": [ { "name": "NAME", "lines": 2, "subsections": [] }, { "name": "SYNOPSIS", "lines": 14, "subsections": [] }, { "name": "DESCRIPTION", "lines": 16, "subsections": [] }, { "name": "COMMANDS", "lines": 80, "subsections": [] }, { "name": "OPTIONS", "lines": 1, "subsections": [ { "name": "-a, --all", "lines": 4, "flag": "-a", "long": "--all" }, { "name": "-u, --include-untracked, --no-include-untracked", "lines": 6, "flag": "-u", "long": "--no-include-untracked" }, { "name": "--only-untracked", "lines": 4, "long": "--only-untracked" }, { "name": "--index", "lines": 6, "long": "--index" }, { "name": "-k, --keep-index, --no-keep-index", "lines": 4, "flag": "-k", "long": "--no-keep-index" }, { "name": "-p, --patch", "lines": 18, "flag": "-p", "long": "--patch" }, { "name": "--pathspec-file-nul", "lines": 5, "long": "--pathspec-file-nul" }, { "name": "-q, --quiet", "lines": 24, "flag": "-q", "long": "--quiet" } ] }, { "name": "DISCUSSION", "lines": 12, "subsections": [] }, { "name": "EXAMPLES", "lines": 68, "subsections": [] }, { "name": "SEE ALSO", "lines": 2, "subsections": [] }, { "name": "GIT", "lines": 5, "subsections": [] } ] } }