66 lines
2.8 KiB
Markdown
66 lines
2.8 KiB
Markdown
---
|
|
title: Git Stash
|
|
---
|
|
## Git Stash
|
|
|
|
Git has an area called the stash where you can temporarily store a snapshot of your changes without committing them to the repository. It's separate from the working directory, the staging area, or the repository.
|
|
|
|
This functionality is useful when you've made changes to a branch that you aren't ready to commit, but you need to switch to another branch.
|
|
|
|
### Stash Changes
|
|
To save your changes in the stash, run the command:
|
|
|
|
```shell
|
|
git stash save "optional message for yourself"
|
|
```
|
|
|
|
This saves your changes and reverts the working directory to what it looked like for the latest commit. Stashed changes are available from any branch in that repository.
|
|
|
|
Note that changes you want to stash need to be on tracked files. If you created a new file and try to stash your changes, you may get the error `No local changes to save`.
|
|
|
|
### View Stashed Changes
|
|
To see what is in your stash, run the command:
|
|
|
|
```shell
|
|
git stash list
|
|
```
|
|
This returns a list of your saved snapshots in the format `stash@{0}: BRANCH-STASHED-CHANGES-ARE-FOR: MESSAGE`. The `stash@{0}` part is the name of the stash, and the number in the curly braces (`{ }`) is the index of that stash. If you have multiple change sets stashed, each one will have a different index.
|
|
|
|
If you forgot what changes were made in the stash, you can see a summary of them with `git stash show NAME-OF-STASH`. If you want to see the typical diff-style patch layout (with the +'s and -'s for line-by-line changes), you can include the `-p` (for patch) option. Here's an example:
|
|
|
|
```shell
|
|
git stash show -p stash@{0}
|
|
|
|
# Example result:
|
|
diff --git a/PathToFile/fileA b/PathToFile/fileA
|
|
index 2417dd9..b2c9092 100644
|
|
--- a/PathToFile/fileA
|
|
+++ b/PathToFile/fileA
|
|
@@ -1,4 +1,4 @@
|
|
-What this line looks like on branch
|
|
+What this line looks like with stashed changes
|
|
```
|
|
|
|
### Retrieve Stashed Changes
|
|
To retrieve changes out of the stash and apply them to the current branch you're on, you have two options:
|
|
|
|
1. `git stash apply STASH-NAME` applies the changes and leaves a copy in the stash
|
|
2. `git stash pop STASH-NAME` applies the changes and removes the files from the stash
|
|
|
|
There may be conflicts when you apply changes. You can resolve the conflicts similar to a merge (<a href='https://guide.freecodecamp.org/git/git-merge/' target='_blank' rel='nofollow'>see Git merge for details</a>).
|
|
|
|
### Delete Stashed Changes
|
|
If you want to remove stashed changes without applying them, run the command:
|
|
```shell
|
|
git stash drop STASH-NAME
|
|
```
|
|
|
|
To clear the entire stash, run the command:
|
|
```shell
|
|
git stash clear
|
|
```
|
|
|
|
### More Information:
|
|
- The `git merge` command: <a href='https://guide.freecodecamp.org/git/git-merge/' target='_blank' rel='nofollow'>fCC Guide</a>
|
|
- Git documentation: <a href='https://git-scm.com/docs/git-stash' target='_blank' rel='nofollow'>stash</a>
|