use_git_config {usethis} | R Documentation |
Configure Git
Description
Sets Git options, for either the user or the project ("global" or "local", in
Git terminology). Wraps gert::git_config_set()
and
gert::git_config_global_set()
. To inspect Git config, see
gert::git_config()
.
Usage
use_git_config(scope = c("user", "project"), ...)
Arguments
scope |
Edit globally for the current user, or locally for the current project |
... |
Name-value pairs, processed as
< |
Value
Invisibly, the previous values of the modified components, as a named list.
See Also
Other git helpers:
use_git()
,
use_git_hook()
,
use_git_ignore()
Examples
## Not run:
# set the user's global user.name and user.email
use_git_config(user.name = "Jane", user.email = "jane@example.org")
# set the user.name and user.email locally, i.e. for current repo/project
use_git_config(
scope = "project",
user.name = "Jane",
user.email = "jane@example.org"
)
## End(Not run)
[Package usethis version 3.0.0 Index]