A light-weight, dependency-free, application programming interface (API) to access system-level Git commands from within R. Contains wrappers and defaults for common data science workflows as well as Zsh plugin aliases (see below). A generalized API syntax is also available. A system installation of Git is required.
If you run into any issues/problems with gitr full documentation of the most recent release can be found at the pkgdown website. If the issue persists I encourage you to consult the issues page and, if appropriate, submit an issue and/or feature request.
Use at own risk 😺, however, PRs are encouraged for ideas that I’ve missed. The functionality contained in gitr are heavily influenced by my personal data science workflows and may not suit all users. However, if you have an idea that would make the package better, more widely usable, and/or efficient, please submit an issue or pull request.
The easiest way to install gitr is to install directly from CRAN
Alternatively install the development version from GitHub:
remotes::install_github("stufield/gitr")
To install a specific tagged release, use:
remotes::install_github("stufield/gitr@v0.0.2")
Here are some basic examples of the functionality grouped by common actions:
git_version() #> [1] "2.49.0"
gitr_current_br() #> [1] "main"
gitr_default_br() #> [1] "main"
gitr_local_br() #> [1] "main"
(git("branch foo"))
#> Running git branch foo
#> $status
#> [1] 0
#>
#> $stdout
#> [1] ""
#>
#> $stderr
#> [1] ""
git("branch -av")$stdout |>
cat(sep = "\n")
#> Running git branch -av
#> foo c3b92f7 Added release_notes to Makefile
#> * main c3b92f7 Added release_notes to Makefile
#> remotes/origin/HEAD -> origin/main
#> remotes/origin/bugfix-get-pr-sha ce27db7 Fix bug in get_pr_sha() (#11)
#> remotes/origin/gh-pages 7b2749c Built site for gitr@0.1.0.9000: c3b92f7
#> remotes/origin/main c3b92f7 Added release_notes to Makefile
#> remotes/origin/prep-for-cran bb5a9bf Clean up URLs
#> remotes/origin/submit-cran-0.1.0 9d30397 Increment version number
#> remotes/origin/update-pkgdown-new-look 0018001 Update GHAs
git("branch -D foo")$stdout
#> Running git branch -D foo
#> [1] "Deleted branch foo (was c3b92f7)."
gitr_commit_msgs(n = 3L) #> Running git log --format=%H -n 3 #> [[1]] #> [1] "Added release_notes to Makefile" "" #> attr(,"sha") #> [1] "c3b92f7" #> attr(,"author") #> [1] "stu.g.field@gmail.com" #> #> [[2]] #> [1] "Bump to dev version" "" #> attr(,"sha") #> [1] "e8843c7" #> attr(,"author") #> [1] "stu.g.field@gmail.com" #> #> [[3]] #> [1] "Increment version number" "" #> attr(,"sha") #> [1] "9d30397" #> attr(,"author") #> [1] "stu.g.field@gmail.com"
glog(5L) #> Running git log --oneline --graph --decorate -n 5 #> * c3b92f7 (HEAD -> main, origin/main, origin/HEAD) Added release_notes to Makefile #> * e8843c7 Bump to dev version #> * 9d30397 (tag: v0.1.0, origin/submit-cran-0.1.0) Increment version number #> * dac226e Update CRAN comments for release #> * a475a5e Update NEWS for v0.1.0
git_unstage("DESCRIPTION") Secure Hash Algorithm (SHA-1)
is_sha("d670c93733f3e1d7c95df7f61ebf6ca0476f14e3")
#> [1] TRUE
is_sha(c("foo", "d670c93")) # vectorized
#> [1] FALSE TRUE
gitr_trim_sha("d670c93733f3e1d7c95df7f61ebf6ca0476f14e3")
#> [1] "d670c93"
gitr_trim_sha(c("foo", "d670c93")) # vectorized
#> [1] "foo" "d670c93"
gitr_current_sha()
#> Running git rev-parse HEAD
#> [1] "c3b92f7"
gitr_recent_tag() #> [1] "v0.1.0"
gitr_tag_info() #> tag tag_sha target_sha message author email user #> v0.1.0 v0.1.0 160b5d7 9d30397 Release of v0.1.0 Stu Field <stu.g.field@gmail.com> stu.g.field #> v0.0.2 v0.0.2 4c4805d 2ffe6bd Release of v0.0.2 Stu Field <stu.g.field@gmail.com> stu.g.field #> v0.0.1 v0.0.1 fc7e99a 5e98f89 Release of v0.0.1 Stu Field <stu.g.field@gmail.com> stu.g.field #> tagdate size path #> v0.1.0 Mon Apr 21 08:44:43 2025 -0600 148 /Users/runner/work/gitr/gitr/.git #> v0.0.2 Sat Apr 12 15:50:09 2025 -0600 148 /Users/runner/work/gitr/gitr/.git #> v0.0.1 Wed Feb 15 12:53:58 2023 -0700 148 /Users/runner/work/gitr/gitr/.git
gitr_sitrep() #> Using Git version: 2.49.0 #> #> Current branch: main #> Default branch: main #> #> Repo status: #> Running git status -s #> #> #> Branches: #> Running git branch -a #> * main #> remotes/origin/HEAD -> origin/main #> remotes/origin/bugfix-get-pr-sha #> remotes/origin/gh-pages #> remotes/origin/main #> remotes/origin/prep-for-cran #> remotes/origin/submit-cran-0.1.0 #> remotes/origin/update-pkgdown-new-look #> #> Local status: #> ✓ OK #> #> Upstream remotes: origin #> * main c3b92f7 [origin/main] Added release_notes to Makefile #> #> Commit log: main #> Running git log --oneline --graph --decorate -n 5 #> * c3b92f7 (HEAD -> main, origin/main, origin/HEAD) Added release_notes to Makefile #> * e8843c7 Bump to dev version #> * 9d30397 (tag: v0.1.0, origin/submit-cran-0.1.0) Increment version number #> * dac226e Update CRAN comments for release #> * a475a5e Update NEWS for v0.1.0ZSH-aliases available in
gitr alias git command ga() git add gst() git status gss() git status -s gau() git add -u gaa() git add --all gb() git branch gba() git branch -a gbd() git branch -d/-D gdf() git diff <file> gbnm() git branch --no-merged gbmm() git branch --merged gbr() git branch --remote gac(), gcn git commit --no-verify --no-edit --amend gcc() git commit gco() git checkout gcb() git checkout -b gcm() git checkout git_default_br() gcf() git config --list gnuke() git reset --hard && git clean -dfx gcmsg() git commit -m gp() git push gpu() git push -u gpd() git push --dry-run gpf() git push --force-with-lease gpr() git pull --rebase --autostash -v glog() git log --oneline --decorate --graph gwip() git add -u && commit --no-verify -m "wip" gclean() git clean -f -d grm() git rm grmc() git rm --cached gsta() git stash gstl() git stash list gpop(),gstp() git stash pop gstaa() git stash apply gstd() git stash drop gstc() git stash clear gsts() git stash show --text gtn() git tag -n grba() git rebase --abort grbc() git rebase --continue grbs() git rebase --skip grbm() git rebase git_default_br() grv() git remote -v
For general reference, here is a list of the available aliases via the git-plugin from Oh-My-Zsh.
See also Oh-My-Zsh for general installation.
alias git commandgapa git add --patch gav git add --verbose gloga git log --oneline --decorate --graph --all gup git pull --rebase gupv git pull --rebase -v gupa git pull --rebase --autostash gupav git pull --rebase --autostash -v gap git apply gapt git apply --3way gbda git branch --no-color --merged | command grep -vE ^([+*] | \s*($(git_main_branch) | $(git_develop_branch))\s*$) | command xargs git branch -d 2>/dev/null gbl git blame -b -w gbs git bisect gbsb git bisect bad gbsg git bisect good gbsr git bisect reset gbss git bisect start gca git commit -v -a gca! git commit -v -a --amend gcan! git commit -v -a --no-edit --amend gcans! git commit -v -a -s --no-edit --amend gcam git commit -a -m gcsm git commit -s -m gcas git commit -a -s gcasm git commit -a -s -m gcl git clone --recurse-submodules gcor git checkout --recurse-submodules gcd git checkout $(git_develop_branch) gcount git shortlog -sn gcp git cherry-pick gcpa git cherry-pick --abort gcpc git cherry-pick --continue gcs git commit -S gcss git commit -S -s gcssm git commit -S -s -m gdca git diff --cached gdcw git diff --cached --word-diff gdct git describe --tags $(git rev-list --tags --max-count=1) gds git diff --staged gdt git diff-tree --no-commit-id --name-only -r gdup git diff @{upstream} gdw git diff --word-diff gf git fetch gfo git fetch origin gfg git ls-files | grep gg git gui citool gga git gui citool --amend ggpur ggu ggpull git pull origin $(git_current_branch) ggpush git push origin $(git_current_branch) ggsup git branch --set-upstream-to=origin/$(git_current_branch) gpsup git push --set-upstream origin $(git_current_branch) ghh git help gignore git update-index --assume-unchanged gignored git ls-files -v | grep "^[[:lower:]]" git-svn-dcommit-push git svn dcommit && git push github $(git_main_branch):svntrunk gl git pull glg git log --stat glgp git log --stat -p glgg git log --graph glgga git log --graph --decorate --all glgm git log --graph --max-count=10 glo git log --oneline --decorate glol git log --graph --pretty glols="git log --graph --pretty %Cred%h%Creset -%C(auto)%d%Creset %s %Cgreen(%ar) %C(bold blue)<%an>%Creset' --stat" glod="git log --graph --pretty %Cred%h%Creset -%C(auto)%d%Creset %s %Cgreen(%ad) %C(bold blue)<%an>%Creset'" glods="git log --graph --pretty %Cred%h%Creset -%C(auto)%d%Creset %s %Cgreen(%ad) %C(bold blue)<%an>%Creset' --date=short" glola="git log --graph --pretty %Cred%h%Creset -%C(auto)%d%Creset %s %Cgreen(%ar) %C(bold blue)<%an>%Creset' --all" gm git merge gmom git merge origin/$(git_main_branch) gmtl git mergetool --no-prompt gmtlvim git mergetool --no-prompt --tool=vimdiff gmum git merge upstream/$(git_main_branch) gma git merge --abort gpf! git push --force gpoat git push origin --all && git push origin --tags gpv git push -v gr git remote gra git remote add grb git rebase grbd git rebase $(git_develop_branch) grbi git rebase -i grbo git rebase --onto grev git revert grh git reset grhh git reset --hard groh git reset origin/$(git_current_branch) --hard grmv git remote rename grrm git remote remove grs git restore grset git remote set-url grss git restore --source grst git restore --staged grt cd $(git rev-parse --show-toplevel || echo .) gru git reset -- grup git remote update gsb git status -sb gsd git svn dcommit gsh git show gsi git submodule init gsps git show --pretty=short --show-signature gsr git svn rebase gstu gsta --include-untracked gstall git stash --all gsu git submodule update gsw git switch gswc git switch -c gswm git switch $(git_main_branch) gswd git switch $(git_develop_branch) gts git tag -s gtv git tag | sort -V gtl gtl(){ git tag --sort=-v:refname -n -l ${1}* }; noglob gtl gunignore git update-index --no-assume-unchanged gunwip git log -n 1 | grep -q -c "\-\-wip\-\-" && git reset HEAD~1 glum git pull upstream $(git_main_branch) gwch git whatchanged -p --abbrev-commit --pretty=medium gam git am gamc git am --continue gams git am --skip gama git am --abort gamscp git am --show-current-patch
Please note that this package is released with a LICENSE. By using in this package you agree to abide by its terms.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4