create_from_github {usethis} | R Documentation |
Creates a new local Git repository from a repository on GitHub. It is highly
recommended that you pre-configure or pass a GitHub personal access token
(PAT), which is facilitated by browse_github_token()
. In particular, a PAT
is required in order for create_from_github()
to do "fork and clone". It is also required
by use_github()
, which connects existing local projects to GitHub.
create_from_github(repo_spec, destdir = NULL, fork = NA, rstudio = NULL, open = interactive(), protocol = git_protocol(), credentials = NULL, auth_token = github_token(), host = NULL)
repo_spec |
GitHub repo specification in this form: |
destdir |
The new folder is stored here. Defaults to user's Desktop. |
fork |
If |
rstudio |
Initiate an RStudio Project?
Defaults to |
open |
If
|
protocol |
Optional. Should be "ssh" or "https", if specified. Defaults
to the option |
credentials |
A git2r credential object produced with
|
auth_token |
GitHub personal access token (PAT). |
host |
GitHub API host to use. Override with the endpoint-root for your GitHub enterprise instance, for example, "https://github.hostname.com/api/v3". |
use_github()
for GitHub setup advice. git_protocol()
and
git_credentials()
for background on protocol
and credentials
.
use_course()
for one-time download of all files in a Git repo, without
any local or remote Git operations.
## Not run: create_from_github("r-lib/usethis") ## End(Not run)