use_git_config: Configure Git
In r-lib/usethis: Automate Package and Project Setup

use_git_config

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 <`dynamic-dots`>.

Value

Invisibly, the previous values of the modified components, as a named list.

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)

r-lib/usethis documentation built on Nov. 28, 2024, 7:11 a.m.