{
    "content": [
        {
            "type": "text",
            "text": "# git-restore(1) (man)\n\n## TLDR\n\n> Restore working tree files. Requires Git version 2.23+.\n\n- Restore an unstaged file to the staged version:\n  `git restore {{path/to/file}}`\n- Restore an unstaged file to the version of a specific commit:\n  `git restore {{-s|--source}} {{commit}} {{path/to/file}}`\n- Discard all unstaged changes to tracked files:\n  `git restore :/`\n- Unstage a file:\n  `git restore {{-S|--staged}} {{path/to/file}}`\n- Unstage all files:\n  `git restore {{-S|--staged}} :/`\n- Discard all changes to files, both staged and unstaged:\n  `git restore {{-W|--worktree}} {{-S|--staged}} :/`\n- Interactively select sections of files to restore:\n  `git restore {{-p|--patch}}`\n\n*Source: tldr-pages*\n\n---\n\n**Summary:** git-restore - Restore working tree files\n\n**Synopsis:** git restore [<options>] [--source=<tree>] [--staged] [--worktree] [--] <pathspec>...\ngit restore [<options>] [--source=<tree>] [--staged] [--worktree] --pathspec-from-file=<file> [--pathspec-file-nul]\ngit restore (-p|--patch) [<options>] [--source=<tree>] [--staged] [--worktree] [--] [<pathspec>...]\n\n## Flags\n\n| Flag | Long | Arg | Description |\n|------|------|-----|-------------|\n| -p | --patch | — | Interactively select hunks in the difference between the restore source and the restore location. See the “Interactive M |\n| -S | --staged | — | Specify the restore location. If neither option is specified, by default the working tree is restored. Specifying --stag |\n| -q | --quiet | — | Quiet, suppress feedback messages. Implies --no-progress. |\n| — | --no-progress | — | Progress status is reported on the standard error stream by default when it is attached to a terminal, unless --quiet is |\n| — | --theirs | — | When restoring files in the working tree from the index, use stage #2 (ours) or #3 (theirs) for unmerged paths. Note tha |\n| -m | --merge | — | When restoring files on the working tree from the index, recreate the conflicted merge in the unmerged paths. --conflict |\n| — | --ignore-unmerged | — | When restoring files on the working tree from the index, do not abort the operation if there are unmerged entries and ne |\n| — | --ignore-skip-worktree-bits | — | In sparse checkout mode, by default is to only update entries matched by <pathspec> and sparse patterns in $GITDIR/info/ |\n| — | --no-recurse-submodules | — | If <pathspec> names an active submodule and the restore location includes the working tree, the submodule will only be u |\n| — | --no-overlay | — | In overlay mode, the command never removes files when restoring. In no-overlay mode, tracked files that do not appear in |\n| — | --pathspec-file-nul | — | Only meaningful with --pathspec-from-file. Pathspec elements are separated with NUL character and all other characters a |\n\n## Examples\n\n- `The following sequence switches to the master branch, reverts the Makefile to two revisions`\n- `back, deletes hello.c by mistake, and gets it back from the index.`\n- `$ git switch master`\n- `$ git restore --source master~2 Makefile  (1)`\n- `$ rm -f hello.c`\n- `$ git restore hello.c                     (2)`\n- `1. take a file out of another commit`\n- `2. restore hello.c from the index`\n- `If you want to restore all C source files to match the version in the index, you can say`\n- `$ git restore '*.c'`\n- `Note the quotes around *.c. The file hello.c will also be restored, even though it is no`\n- `longer in the working tree, because the file globbing is used to match entries in the index`\n- `(not in the working tree by the shell).`\n- `To restore all files in the current directory`\n- `$ git restore .`\n- `or to restore all working tree files with top pathspec magic (see gitglossary(7))`\n- `$ git restore :/`\n- `To restore a file in the index to match the version in HEAD (this is the same as using git-`\n- `reset(1))`\n- `$ git restore --staged hello.c`\n- `or you can restore both the index and the working tree (this the same as using git-`\n- `checkout(1))`\n- `$ git restore --source=HEAD --staged --worktree hello.c`\n- `or the short form which is more practical but less readable:`\n- `$ git restore -s@ -SW hello.c`\n\n## See Also\n\n- git-checkout(1)\n- git-reset(1)\n\n## Section Outline\n\n- **NAME** (2 lines)\n- **SYNOPSIS** (5 lines)\n- **DESCRIPTION** (14 lines)\n- **OPTIONS** (11 lines) — 11 subsections\n  - -p, --patch (6 lines)\n  - -W, --worktree, -S, --staged (4 lines)\n  - -q, --quiet (2 lines)\n  - --progress, --no-progress (4 lines)\n  - --ours, --theirs (6 lines)\n  - -m, --merge (9 lines)\n  - --ignore-unmerged (4 lines)\n  - --ignore-skip-worktree-bits (4 lines)\n  - --recurse-submodules, --no-recurse-submodules (7 lines)\n  - --overlay, --no-overlay (10 lines)\n  - --pathspec-file-nul (11 lines)\n- **EXAMPLES** (48 lines)\n- **SEE ALSO** (2 lines)\n- **GIT** (5 lines)\n\n## Full Content\n\n### NAME\n\ngit-restore - Restore working tree files\n\n### SYNOPSIS\n\ngit restore [<options>] [--source=<tree>] [--staged] [--worktree] [--] <pathspec>...\ngit restore [<options>] [--source=<tree>] [--staged] [--worktree] --pathspec-from-file=<file> [--pathspec-file-nul]\ngit restore (-p|--patch) [<options>] [--source=<tree>] [--staged] [--worktree] [--] [<pathspec>...]\n\n### DESCRIPTION\n\nRestore specified paths in the working tree with some contents from a restore source. If a\npath is tracked but does not exist in the restore source, it will be removed to match the\nsource.\n\nThe command can also be used to restore the content in the index with --staged, or restore\nboth the working tree and the index with --staged --worktree.\n\nBy default, if --staged is given, the contents are restored from HEAD, otherwise from the\nindex. Use --source to restore from a different commit.\n\nSee \"Reset, restore and revert\" in git(1) for the differences between the three commands.\n\nTHIS COMMAND IS EXPERIMENTAL. THE BEHAVIOR MAY CHANGE.\n\n### OPTIONS\n\n-s <tree>, --source=<tree>\nRestore the working tree files with the content from the given tree. It is common to\nspecify the source tree by naming a commit, branch or tag associated with it.\n\nIf not specified, the contents are restored from HEAD if --staged is given, otherwise\nfrom the index.\n\nAs a special case, you may use \"A...B\" as a shortcut for the merge base of A and B if\nthere is exactly one merge base. You can leave out at most one of A and B, in which case\nit defaults to HEAD.\n\n#### -p, --patch\n\nInteractively select hunks in the difference between the restore source and the restore\nlocation. See the “Interactive Mode” section of git-add(1) to learn how to operate the\n--patch mode.\n\nNote that --patch can accept no pathspec and will prompt to restore all modified paths.\n\n#### -W, --worktree, -S, --staged\n\nSpecify the restore location. If neither option is specified, by default the working tree\nis restored. Specifying --staged will only restore the index. Specifying both restores\nboth.\n\n#### -q, --quiet\n\nQuiet, suppress feedback messages. Implies --no-progress.\n\n#### --progress, --no-progress\n\nProgress status is reported on the standard error stream by default when it is attached\nto a terminal, unless --quiet is specified. This flag enables progress reporting even if\nnot attached to a terminal, regardless of --quiet.\n\n#### --ours, --theirs\n\nWhen restoring files in the working tree from the index, use stage #2 (ours) or #3\n(theirs) for unmerged paths.\n\nNote that during git rebase and git pull --rebase, ours and theirs may appear swapped.\nSee the explanation of the same options in git-checkout(1) for details.\n\n#### -m, --merge\n\nWhen restoring files on the working tree from the index, recreate the conflicted merge in\nthe unmerged paths.\n\n--conflict=<style>\nThe same as --merge option above, but changes the way the conflicting hunks are\npresented, overriding the merge.conflictStyle configuration variable. Possible values are\n\"merge\" (default) and \"diff3\" (in addition to what is shown by \"merge\" style, shows the\noriginal contents).\n\n#### --ignore-unmerged\n\nWhen restoring files on the working tree from the index, do not abort the operation if\nthere are unmerged entries and neither --ours, --theirs, --merge or --conflict is\nspecified. Unmerged paths on the working tree are left alone.\n\n#### --ignore-skip-worktree-bits\n\nIn sparse checkout mode, by default is to only update entries matched by <pathspec> and\nsparse patterns in $GITDIR/info/sparse-checkout. This option ignores the sparse patterns\nand unconditionally restores any files in <pathspec>.\n\n#### --recurse-submodules, --no-recurse-submodules\n\nIf <pathspec> names an active submodule and the restore location includes the working\ntree, the submodule will only be updated if this option is given, in which case its\nworking tree will be restored to the commit recorded in the superproject, and any local\nmodifications overwritten. If nothing (or --no-recurse-submodules) is used, submodules\nworking trees will not be updated. Just like git-checkout(1), this will detach HEAD of\nthe submodule.\n\n#### --overlay, --no-overlay\n\nIn overlay mode, the command never removes files when restoring. In no-overlay mode,\ntracked files that do not appear in the --source tree are removed, to make them match\n<tree> exactly. The default is no-overlay mode.\n\n--pathspec-from-file=<file>\nPathspec is passed in <file> instead of commandline args. If <file> 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\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--\nDo not interpret any more arguments as options.\n\n<pathspec>...\nLimits the paths affected by the operation.\n\nFor more details, see the pathspec entry in gitglossary(7).\n\n### EXAMPLES\n\nThe following sequence switches to the master branch, reverts the Makefile to two revisions\nback, deletes hello.c by mistake, and gets it back from the index.\n\n$ git switch master\n$ git restore --source master~2 Makefile  (1)\n$ rm -f hello.c\n$ git restore hello.c                     (2)\n\n\n1. take a file out of another commit\n2. restore hello.c from the index\n\nIf you want to restore all C source files to match the version in the index, you can say\n\n$ git restore '*.c'\n\n\nNote the quotes around *.c. The file hello.c will also be restored, even though it is no\nlonger in the working tree, because the file globbing is used to match entries in the index\n(not in the working tree by the shell).\n\nTo restore all files in the current directory\n\n$ git restore .\n\n\nor to restore all working tree files with top pathspec magic (see gitglossary(7))\n\n$ git restore :/\n\n\nTo restore a file in the index to match the version in HEAD (this is the same as using git-\nreset(1))\n\n$ git restore --staged hello.c\n\n\nor you can restore both the index and the working tree (this the same as using git-\ncheckout(1))\n\n$ git restore --source=HEAD --staged --worktree hello.c\n\n\nor the short form which is more practical but less readable:\n\n$ git restore -s@ -SW hello.c\n\n### SEE ALSO\n\ngit-checkout(1), git-reset(1)\n\n### GIT\n\nPart of the git(1) suite\n\n\n\nGit 2.34.1                                   02/26/2026                               GIT-RESTORE(1)\n\n"
        }
    ],
    "structuredContent": {
        "command": "git-restore",
        "section": "1",
        "mode": "man",
        "summary": "git-restore - Restore working tree files",
        "synopsis": "git restore [<options>] [--source=<tree>] [--staged] [--worktree] [--] <pathspec>...\ngit restore [<options>] [--source=<tree>] [--staged] [--worktree] --pathspec-from-file=<file> [--pathspec-file-nul]\ngit restore (-p|--patch) [<options>] [--source=<tree>] [--staged] [--worktree] [--] [<pathspec>...]",
        "tldr_summary": "Restore working tree files. Requires Git version 2.23+.",
        "tldr_examples": [
            {
                "description": "Restore an unstaged file to the staged version",
                "command": "git restore {{path/to/file}}"
            },
            {
                "description": "Restore an unstaged file to the version of a specific commit",
                "command": "git restore {{-s|--source}} {{commit}} {{path/to/file}}"
            },
            {
                "description": "Discard all unstaged changes to tracked files",
                "command": "git restore :/"
            },
            {
                "description": "Unstage a file",
                "command": "git restore {{-S|--staged}} {{path/to/file}}"
            },
            {
                "description": "Unstage all files",
                "command": "git restore {{-S|--staged}} :/"
            },
            {
                "description": "Discard all changes to files, both staged and unstaged",
                "command": "git restore {{-W|--worktree}} {{-S|--staged}} :/"
            },
            {
                "description": "Interactively select sections of files to restore",
                "command": "git restore {{-p|--patch}}"
            }
        ],
        "tldr_source": "official",
        "flags": [
            {
                "flag": "-p",
                "long": "--patch",
                "arg": null,
                "description": "Interactively select hunks in the difference between the restore source and the restore location. See the “Interactive Mode” section of git-add(1) to learn how to operate the --patch mode. Note that --patch can accept no pathspec and will prompt to restore all modified paths."
            },
            {
                "flag": "-S",
                "long": "--staged",
                "arg": null,
                "description": "Specify the restore location. If neither option is specified, by default the working tree is restored. Specifying --staged will only restore the index. Specifying both restores both."
            },
            {
                "flag": "-q",
                "long": "--quiet",
                "arg": null,
                "description": "Quiet, suppress feedback messages. Implies --no-progress."
            },
            {
                "flag": "",
                "long": "--no-progress",
                "arg": null,
                "description": "Progress status is reported on the standard error stream by default when it is attached to a terminal, unless --quiet is specified. This flag enables progress reporting even if not attached to a terminal, regardless of --quiet."
            },
            {
                "flag": "",
                "long": "--theirs",
                "arg": null,
                "description": "When restoring files in the working tree from the index, use stage #2 (ours) or #3 (theirs) for unmerged paths. Note that during git rebase and git pull --rebase, ours and theirs may appear swapped. See the explanation of the same options in git-checkout(1) for details."
            },
            {
                "flag": "-m",
                "long": "--merge",
                "arg": null,
                "description": "When restoring files on the working tree from the index, recreate the conflicted merge in the unmerged paths. --conflict=<style> The same as --merge option above, but changes the way the conflicting hunks are presented, overriding the merge.conflictStyle configuration variable. Possible values are \"merge\" (default) and \"diff3\" (in addition to what is shown by \"merge\" style, shows the original contents)."
            },
            {
                "flag": "",
                "long": "--ignore-unmerged",
                "arg": null,
                "description": "When restoring files on the working tree from the index, do not abort the operation if there are unmerged entries and neither --ours, --theirs, --merge or --conflict is specified. Unmerged paths on the working tree are left alone."
            },
            {
                "flag": "",
                "long": "--ignore-skip-worktree-bits",
                "arg": null,
                "description": "In sparse checkout mode, by default is to only update entries matched by <pathspec> and sparse patterns in $GITDIR/info/sparse-checkout. This option ignores the sparse patterns and unconditionally restores any files in <pathspec>."
            },
            {
                "flag": "",
                "long": "--no-recurse-submodules",
                "arg": null,
                "description": "If <pathspec> names an active submodule and the restore location includes the working tree, the submodule will only be updated if this option is given, in which case its working tree will be restored to the commit recorded in the superproject, and any local modifications overwritten. If nothing (or --no-recurse-submodules) is used, submodules working trees will not be updated. Just like git-checkout(1), this will detach HEAD of the submodule."
            },
            {
                "flag": "",
                "long": "--no-overlay",
                "arg": null,
                "description": "In overlay mode, the command never removes files when restoring. In no-overlay mode, tracked files that do not appear in the --source tree are removed, to make them match <tree> exactly. The default is no-overlay mode. --pathspec-from-file=<file> Pathspec is passed in <file> instead of commandline args. If <file> 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": "Only meaningful with --pathspec-from-file. Pathspec elements are separated with NUL character and all other characters are taken literally (including newlines and quotes). -- Do not interpret any more arguments as options. <pathspec>... Limits the paths affected by the operation. For more details, see the pathspec entry in gitglossary(7)."
            }
        ],
        "examples": [
            "The following sequence switches to the master branch, reverts the Makefile to two revisions",
            "back, deletes hello.c by mistake, and gets it back from the index.",
            "$ git switch master",
            "$ git restore --source master~2 Makefile  (1)",
            "$ rm -f hello.c",
            "$ git restore hello.c                     (2)",
            "1. take a file out of another commit",
            "2. restore hello.c from the index",
            "If you want to restore all C source files to match the version in the index, you can say",
            "$ git restore '*.c'",
            "Note the quotes around *.c. The file hello.c will also be restored, even though it is no",
            "longer in the working tree, because the file globbing is used to match entries in the index",
            "(not in the working tree by the shell).",
            "To restore all files in the current directory",
            "$ git restore .",
            "or to restore all working tree files with top pathspec magic (see gitglossary(7))",
            "$ git restore :/",
            "To restore a file in the index to match the version in HEAD (this is the same as using git-",
            "reset(1))",
            "$ git restore --staged hello.c",
            "or you can restore both the index and the working tree (this the same as using git-",
            "checkout(1))",
            "$ git restore --source=HEAD --staged --worktree hello.c",
            "or the short form which is more practical but less readable:",
            "$ git restore -s@ -SW hello.c"
        ],
        "see_also": [
            {
                "name": "git-checkout",
                "section": "1",
                "url": "https://www.chedong.com/phpMan.php/man/git-checkout/1/json"
            },
            {
                "name": "git-reset",
                "section": "1",
                "url": "https://www.chedong.com/phpMan.php/man/git-reset/1/json"
            }
        ],
        "section_outline": [
            {
                "name": "NAME",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "SYNOPSIS",
                "lines": 5,
                "subsections": []
            },
            {
                "name": "DESCRIPTION",
                "lines": 14,
                "subsections": []
            },
            {
                "name": "OPTIONS",
                "lines": 11,
                "subsections": [
                    {
                        "name": "-p, --patch",
                        "lines": 6,
                        "flag": "-p",
                        "long": "--patch"
                    },
                    {
                        "name": "-W, --worktree, -S, --staged",
                        "lines": 4,
                        "flag": "-S",
                        "long": "--staged"
                    },
                    {
                        "name": "-q, --quiet",
                        "lines": 2,
                        "flag": "-q",
                        "long": "--quiet"
                    },
                    {
                        "name": "--progress, --no-progress",
                        "lines": 4,
                        "long": "--no-progress"
                    },
                    {
                        "name": "--ours, --theirs",
                        "lines": 6,
                        "long": "--theirs"
                    },
                    {
                        "name": "-m, --merge",
                        "lines": 9,
                        "flag": "-m",
                        "long": "--merge"
                    },
                    {
                        "name": "--ignore-unmerged",
                        "lines": 4,
                        "long": "--ignore-unmerged"
                    },
                    {
                        "name": "--ignore-skip-worktree-bits",
                        "lines": 4,
                        "long": "--ignore-skip-worktree-bits"
                    },
                    {
                        "name": "--recurse-submodules, --no-recurse-submodules",
                        "lines": 7,
                        "long": "--no-recurse-submodules"
                    },
                    {
                        "name": "--overlay, --no-overlay",
                        "lines": 10,
                        "long": "--no-overlay"
                    },
                    {
                        "name": "--pathspec-file-nul",
                        "lines": 11,
                        "long": "--pathspec-file-nul"
                    }
                ]
            },
            {
                "name": "EXAMPLES",
                "lines": 48,
                "subsections": []
            },
            {
                "name": "SEE ALSO",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "GIT",
                "lines": 5,
                "subsections": []
            }
        ]
    }
}