{"title":"git restore","description":null,"content":"If you've ever found yourself in a situation where you made changes to a file in your Git repository and wanted to go back to a previous state without disrupting your commit history, you're not alone. \n\nThe `git restore` command is a powerful tool designed for undoing changes in a more granular way compared to other commands. It allows you to selectively discard changes in your working directory or staging area, providing a safety net for your workflows.\n\n---\n\n# What is git restore?\n\nThe `git restore` command was introduced in Git 2.23 as part of a larger effort to simplify the command-line interface for users. Its primary purpose is to restore files in the working directory or the staging area. While it may seem similar to `git checkout`, `git restore` is more focused and user-friendly for undoing changes.\n\nWhen you use `git restore`, you're interacting specifically with the contents of your files, either to discard changes you've made or to bring back a version from the repository. This command acts on the following three primary areas:\n\n- **Working directory**: The files you're actively editing.\n- **Staging area (index)**: The files that are ready to be committed.\n- **Repository**: The historical commits where you can pull previous versions of files.\n\n---\n\n# Discarding Changes in the Working Directory\n\nOne of the most common scenarios for using `git restore` is to discard uncommitted changes in your working directory. This is particularly useful when you’ve made modifications to a file and realize you want to revert those changes.\n\n### Basic Usage\n\nTo discard changes in a file, you can run:\n\n\n```shell\n$ git restore \n```\n\n\nThis command will reset the specified file in your working directory to the state of the last commit. For example, if you modified `example.txt` but decide you want to discard those changes:\n\n\n```shell\n$ git restore example.txt\n```\n\n\nAfter executing this command, `example.txt` will go back to the last committed state, losing all uncommitted changes.\n\n### Discarding Changes in Multiple Files\n\nYou can also restore multiple files at once:\n\n\n```shell\n$ git restore file1.txt file2.txt file3.txt\n```\n\n\nThis command is convenient when you have several files with unwanted changes.\n\n\n> **WARNING**\n>\n> Be cautious with `git restore` as it permanently discards any uncommitted changes in the specified file(s). Always ensure you really want to lose those changes.\n\n\n---\n\n# Restoring Staged Changes\n\nSometimes, you may stage changes but realize you want to modify them before committing. In this case, `git restore` allows you to unstage files.\n\n### Unstaging Files\n\nTo unstage a file, use the `--staged` option:\n\n\n```shell\n$ git restore --staged \n```\n\n\nFor example, if you staged `example.txt` but want to make further changes before committing, you would run:\n\n\n```shell\n$ git restore --staged example.txt\n```\n\n\nThis command moves the changes from the staging area back to the working directory. The file now reflects the changes you made, allowing you to edit it further.\n\n### Unstaging Multiple Files\n\nYou can also unstage multiple files at once:\n\n\n```shell\n$git restore --staged file1.txt file2.txt\n```\n\n\nThis is useful for cases where you need to adjust several files before committing them.\n\n---\n\n# Restoring to a Specific Commit\n\nIn addition to restoring files to their last committed state, `git restore` allows you to pull versions of a file from any specific commit. This can be extremely useful for recovering an earlier version of a file without affecting your current commit history.\n\n### Restoring from a Commit\n\nTo restore a file from a specific commit, use the following syntax:\n\n\n```shell\n$ git restore --source \n```\n\n\nFor instance, if you want to restore `example.txt` from a commit with the hash `abc1234`, you would execute:\n\n\n```shell\n$ git restore --source abc1234 example.txt\n```\n\n\nThis command takes the version of `example.txt` from the specified commit and replaces the current version in your working directory.\n\n### Visualizing Changes\n\nTo know which commit you want to restore from, you can use:\n\n\n```shell\n$ git log --oneline\n```\n\n\nThis command will show you a simple graph of recent commits, helping you identify the correct commit hash.\n\n---\n\n# Combining with Other Options\n\nWhile `git restore` is powerful on its own, combining it with other options can enhance its functionality. Here are some useful combinations:\n\n### Restoring with Checkout Options\n\nIf you want to restore a file and also check it out at the same time, you can combine `git restore` with `--worktree`:\n\n\n```shell\n$ git restore --source --worktree \n```\n\n\nThis command ensures that the specified file in your working directory reflects the state from the specified commit.\n\n### Using Paths\n\nIf you want to restore all files in a directory or specific patterns, you can use paths:\n\n\n```shell\n$ git restore --source -- /*\n```\n\n\nThis command will restore all files in the specified directory from a specific commit.\n\n---\n\n# Real-World Use Cases\n\nUnderstanding practical scenarios where `git restore` shines can help solidify its importance in your workflow. Here are some examples:\n\n### Mistaken Edits\n\nImagine you’re working on a feature and accidentally modify a few lines in a file. You realize the changes are unnecessary and now wish to discard them. Instead of going through each change manually, you can simply run:\n\n\n```shell\n$ git restore example.txt\n```\n\n\n### Pre-Commit Adjustments\n\nSuppose you've added several files to the staging area but want to make last-minute adjustments before committing. You can unstage them using:\n\n\n```shell\n$ git restore --staged file1.txt file2.txt\n```\n\n\nThis gives you the chance to refine your changes, ensuring only the best code goes into your commit.\n\n### Experimentation with Version History\n\nIf you are exploring how a file has evolved over time, you can restore different versions to see how changes impacted the codebase. For example:\n\n\n```shell\n$ git restore --source example.txt\n```\n\n\nThis practice can provide insights into why certain decisions were made in the code, helping you make informed choices in your current work.\n\n---\n\n# Summary\n\nThe `git restore` command is a versatile tool that simplifies the process of discarding unwanted changes and managing your staging area. By allowing you to restore files from the working directory or the repository's history, it empowers you to handle changes more confidently and efficiently.\n\nUsing `git restore`, you can:\n\n- Discard changes in your working directory.\n- Unstage files that are ready for commit.\n- Restore specific file versions from past commits.\n\nMastering `git restore` equips you with the capabilities to refine your workflow and ensures you maintain a clean commit history.\n\n---\n\nNow that you understand how to effectively use `git restore` to manage your changes, you are ready to explore `git reset`. In the next chapter, we will look at how reset can help you manipulate your commit history and manage your staging area even further. Get ready to uncover the intricacies of resetting your repository!","pageType":"git"}

git restore

Get Premium