1% Generated by roxygen2: do not edit by hand
2% Please edit documentation in R/git.R
3\name{use_git_config}
4\alias{use_git_config}
5\title{Configure Git}
6\usage{
7use_git_config(scope = c("user", "project"), ...)
8}
9\arguments{
10\item{scope}{Edit globally for the current \strong{user}, or locally for the
11current \strong{project}}
12
13\item{...}{Name-value pairs, processed as
14<\code{\link[rlang:dyn-dots]{dynamic-dots}}>.}
15}
16\value{
17Invisibly, the previous values of the modified components, as a named
18list.
19}
20\description{
21Sets Git options, for either the user or the project ("global" or "local", in
22Git terminology). Wraps \code{\link[gert:git_config]{gert::git_config_set()}} and
23\code{\link[gert:git_config]{gert::git_config_global_set()}}. To inspect Git config, see
24\code{\link[gert:git_config]{gert::git_config()}}.
25}
26\examples{
27\dontrun{
28# set the user's global user.name and user.email
29use_git_config(user.name = "Jane", user.email = "jane@example.org")
30
31# set the user.name and user.email locally, i.e. for current repo/project
32use_git_config(
33  scope = "project",
34  user.name = "Jane",
35  user.email = "jane@example.org"
36)
37}
38}
39\seealso{
40Other git helpers:
41\code{\link{use_git_hook}()},
42\code{\link{use_git_ignore}()},
43\code{\link{use_git}()}
44}
45\concept{git helpers}
46