{"title":"git stash","description":null,"content":"Sometimes, you’re in the middle of implementing a feature when an urgent bug fix comes up. Your current changes are half-baked, or maybe they’re just not ready to be committed. You need a way to set those changes aside temporarily without losing them. \n\nEnter `git stash`. This command allows you to save your work in progress without committing it, giving you the flexibility to switch contexts quickly and efficiently.\n\n---\n\n# What is Git Stash?\n\nAt its core, `git stash` allows you to **safely store unfinished changes** in a separate stack. You can then return to a clean working directory, allowing you to work on something else without losing your current progress. \n\nWhen you run `git stash`, Git creates a new stash entry that consists of:\n\n- The **modified tracked files**.\n- The **staged files**.\n- The **untracked files** are not included by default, but you can stash them if needed.\n\nThis operation is crucial for maintaining workflow efficiency, especially in collaborative environments where context switching is frequent.\n\n### How Git Stash Works Under the Hood\n\nTo appreciate how `git stash` operates, it’s helpful to understand what happens when you run the command. \n\nWhen you execute `git stash`, Git performs a series of operations:\n\n1. **Creating a Stash Entry:** Git saves your current changes into a stash object. This object is stored in the `.git` directory under `refs/stash`, which acts as a pointer to the latest stash.\n2. **Cleaning Your Working Directory:** After creating the stash entry, Git resets your working directory to match the last commit, allowing you to have a clean state.\n\nThe stash is basically a combination of commits that Git references, allowing you to retrieve your work later. Visualizing this can help clarify the process:\n\n\n```shell\n[Working Directory]\n\t|\n\t| git stash\n\tv\n[Stash Entry] (changes saved on a stack)\n\t|\n\tv\n[Clean Working Directory]\n```\n\n\n---\n\n# Basic Usage of Git Stash\n\nUsing `git stash` is quite simple. Here are the core commands to get you started:\n\n### Stashing Changes\n\nThe most common command is:\n\n\n```shell\n$ git stash\n```\n\n\nThis command saves your **modified** and **staged** changes. If you want to include untracked files as well, you can use:\n\n\n```shell\n$ git stash -u\n```\n\n\nThis command stashes both tracked and untracked files, which is useful for situations where new files are part of your work in progress.\n\n### Listing Stash Entries\n\nTo see your existing stash entries, use:\n\n\n```shell\n$ git stash list\n```\n\n\nThis will display a list of all stashes in the format:\n\n\n```shell\nstash@{0}: WIP on branch_name: commit_message\nstash@{1}: WIP on branch_name: commit_message\n```\n\n\nEach entry is indexed and can be referenced later.\n\n### Applying Stash Changes\n\nWhen you’re ready to return to your stashed changes, you can apply them back to your working directory with:\n\n\n```shell\n$ git stash apply\n```\n\n\nThis will apply the most recent stash but won't remove it from the stash list. If you want to apply a specific stash, you can specify it like this:\n\n\n```shell\n$ git stash apply stash@{1}\n```\n\n\n### Dropping Stash Entries\n\nIf you no longer need a specific stash entry, you can remove it using:\n\n\n```shell\n$ git stash drop stash@{0}\n```\n\n\nAlternatively, if you want to clear all stashes, use:\n\n\n```shell\n$ git stash clear\n```\n\n\n---\n\n# Real-World Applications of Git Stash\n\nIn practice, `git stash` is incredibly useful in various scenarios. Here are a few real-world situations where it can save the day:\n\n### Context Switching\n\nImagine you’re working on a new feature, and your manager asks you to fix a bug in the production code. Instead of committing your half-finished work, you can stash it:\n\n\n```shell\n$ git stash\n```\n\n\nYou can then switch to the `main` branch, fix the bug, and return to your feature branch without losing your progress.\n\n### Collaborating with Team Members\n\nWhen working in a team, you may need to pull changes from a remote branch while having local changes. Stashing your work allows you to pull without merging conflicts:\n\n\n```shell\ngit stash\ngit pull origin main\ngit stash pop\n```\n\n\nThis sequence ensures that you have the latest changes without the fear of merging your unfinished work.\n\n### Experimenting Safely\n\nSometimes, you may want to explore a new approach without committing your current work. Stashing allows you to quickly switch branches and try something out. If it doesn’t work out, you can return to your original branch and restore your stashed changes.\n\n---\n\n# Common Pitfalls and Nuances\n\nWhile `git stash` is powerful, there are some nuances and common pitfalls to be aware of:\n\n### Stashing Untracked Files\n\nBy default, untracked files are not stashed. If you find yourself needing to stash those as well, remember to use the `-u` flag. If you have ignored files in your `.gitignore`, they will also not be included in the stash.\n\n### Applying Without Dropping\n\nUsing `git stash apply` does not remove the stash entry. This can be useful but may lead to confusion if you forget that the stash still exists. If you want to apply and remove it simultaneously, use:\n\n\n```shell\n$ git stash pop\n```\n\n\n### Conflicts When Applying Stash\n\nWhen applying a stash, you may encounter merge conflicts if the files have changed in the meantime. In this case, resolve the conflicts as you would during a merge, and then proceed with your work.\n\n### Check for Stash Changes\n\nBefore applying a stash, it’s good practice to check what changes you are about to bring back. You can do this with:\n\n\n```shell\n$ git stash show -p stash@{0}\n```\n\n\nThis command shows you the changes included in the specified stash, giving you insight into what will be reapplied to your working directory.\n\n---\n\n# Best Practices for Using Git Stash\n\nTo make the best use of `git stash`, consider these best practices:\n\n- **Use Descriptive Messages:** When stashing changes, you can provide a message for clarity:\n\n\n```shell\n$ git stash save \"Fixing the login bug\"\n```\n\n\n- **Regularly Clean Up Stashes:** Avoid accumulating unnecessary stashes. Regularly review and drop those you no longer need.\n- **Stash Wisely:** Only stash changes that make sense to be set aside. If you have too many stashes, it can lead to confusion later on.\n- **Use Branches for Long-Term Work:** If you find yourself frequently stashing, consider creating a feature branch instead. This helps keep your work organized and versioned.\n\n---\n\nNow that you understand the fundamentals and practical applications of `git stash`, you are ready to explore Stash Operations. In the next chapter, we will look at how to manage stash entries effectively, including applying, dropping, and using advanced options for a better workflow.","pageType":"git"}

git stash

Get Premium