git_restore: Restore working tree files

In gert: Simple Git Client for R

Restore working tree files

Description

Restores specified paths in the working tree from a given ref, equivalent to ⁠git restore --source=<ref> <path>⁠ (or the older ⁠git checkout <ref> -- <path>⁠). The ref must be reachable from the current HEAD. By default restores from HEAD, discarding any local modifications.

Usage

git_restore(path, ref = "HEAD", repo = ".")

Arguments

path	character vector with file paths to restore, relative to the repository root. Use "." to restore all tracked files.
ref	revision string with a branch/tag/commit to restore from. Defaults to "HEAD".
repo	The path to the git repository. If the directory is not a repository, parent directories are considered (see git_find()). To disable this search, provide the filepath protected with I(). When using this parameter, always explicitly call by name (i.e. ⁠repo = ⁠) because future versions of gert may have additional parameters.

Value

Invisibly, the git_status() after restoring.

See Also

Other git: git_archive, git_branch(), git_commit(), git_config(), git_diff(), git_fetch(), git_history, git_ignore, git_merge(), git_rebase(), git_remote, git_repo, git_reset(), git_revert(), git_signature(), git_stash, git_tag, git_worktree

Examples

repo <- file.path(tempdir(), "myrepo")
git_init(repo)

# Set a user if no default
if (!user_is_configured()) {
  git_config_set("user.name", "Jerry")
  git_config_set("user.email", "[e-mail]")
}

writeLines("hello", file.path(repo, "hello.txt"))
git_add("hello.txt", repo = repo)
git_commit("First commit", repo = repo)

# Modify the file, then restore it from HEAD
writeLines("oops", file.path(repo, "hello.txt"))
git_restore("hello.txt", repo = repo)
readLines(file.path(repo, "hello.txt"))  # "hello"

unlink(repo, recursive = TRUE)

gert documentation built on July 22, 2026, 5:07 p.m.