Repository files navigation

This package is a joint effort fromrOpenSci and theTidyverse team.

Tools for Managing SSH and Git Credentials

Setup and retrieve HTTPS and SSH credentials for use with 'git' andother services. For HTTPS remotes the package interfaces the 'git-credential'utility which 'git' uses to store HTTP usernames and passwords. For SSHremotes we provide convenient functions to find or generate appropriate SSHkeys. The package both helps the user to setup a local git installation, andalso provides a back-end for git/ssh client libraries to authenticate withexisting user credentials.

Automatically populate yourGITHUB_PAT environment variable from the native git credential store. The credential manager will safely prompt the user for credentials when needed.

credentials::set_github_pat()

Use this function in your.Rprofile if you want to automatically setGITHUB_PAT for each R session, without hardcoding your secret in plain text.

Load or prompt the user for GitHub username and password:

library(credentials)git_credential_ask('https://github.com')

See which credential helper back-end yourgit-credential store is using:

credentials::credential_helper_get()

Lookup the appropriate key, or prompt the user to generate one:

library(credentials)ssh_key_info()

You can copy-paste the public key directly to yourGitHub profile!

Use the openssl package to read the user private key in R for encryption / signatures:

user<- ssh_key_info()key<- ssh_read_key(user$key)openssl::write_pem(key)