knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)

fgitR

Lifecycle: stable Codecov test coverage

FastGit works as a mirror of GitHub to make significant accelerations.

fgitR is a package to do git operation with FastGit automatically.

Installation

figtR has been released in CRAN. You can install the released version of fgitR from CRAN with:

# Install from CRAN
install.packages("fgitR")

# Compiling from Source
remotes::install_github("FastGitORG/fgitR")

# For upgrade installed `fgitR`
fgitR::fgit_install("FastGitORG/fgitR")

Install package from Source

library(fgitR)

# fgitR can install package by Repository's Name
# fgitR_install("https://github.com/r-lib/diffviewer")

# fgitR can install package by Repository's URL
fgit_install("r-lib/diffviewer")

List all branch from Remote

branch_ls <-
  fgit_branch("FastGitORG/fgitR")

branch_ls

Reinventing the wheel?

For the initially consideration, we believe it is necessary to add following functions:

Due to git is not only clone to local, but also contribute back. But in the git clone or fgit clone procedure, the remote will be set as fastgit.org or other mirror domain. Hence, there is nothing special to make further operations.

Bug report

Feel free to let me know once it's broken or just open an Issue.

Code of Conduct

Please note that the fgitR project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.



FastGitORG/fgitR documentation built on March 18, 2022, 7:52 a.m.