The gitr Package

GitHub version CRAN status R-CMD-check Codecov test coverage Lifecycle: stable License: MIT


A light-weight, dependency-free, API to access system-level git commands from within R. It contains wrappers and defaults for common data science workflows as well as Z-shell and it’s plugins (see below). 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 :smiley_cat:, 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:


To install a specific tagged release, use:





Here are some basic examples of the functionality grouped by common actions:


#> [1] "2.39.1"
#> [1] "main"
#> [1] "main"

Core Engine

(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                          0c9ac89 Elaborate examples in README.Rmd
#> * main                         0c9ac89 Elaborate examples in README.Rmd
#>   remotes/origin/gh-pages      592df67 Built site for gitr:
#>   remotes/origin/main          0c9ac89 Elaborate examples in README.Rmd
#>   remotes/origin/prep-for-cran bb5a9bf Clean up URLs

git("branch", "-D", "foo")$stdout
#> Running git branch -D foo
#> [1] "Deleted branch foo (was 0c9ac89)."


get_commit_msgs(n = 3)
#> Running git log --format=%H -n 3
#> [[1]]
#> [1] "Elaborate examples in README.Rmd" ""                                
#> attr(,"sha")
#> [1] "0c9ac89"
#> attr(,"author")
#> [1] ""
#> [[2]]
#> [1] "Update README.Rmd to include `git_tag_info()`" ""                                             
#> attr(,"sha")
#> [1] "d670c93"
#> attr(,"author")
#> [1] ""
#> [[3]]
#> [1] "Git tag info no longer errors out" ""                                 
#> [3] "- informs user and returns NULL"   ""                                 
#> attr(,"sha")
#> [1] "45fc4c7"
#> attr(,"author")
#> [1] ""
#> Running git log --oneline --graph --decorate -n 5 
#> * 0c9ac89 (HEAD -> main, origin/main) Elaborate examples in README.Rmd
#> * d670c93 Update README.Rmd to include `git_tag_info()`
#> * 45fc4c7 Git tag info no longer errors out
#> * 892e59f Ensure `git_sitrep()` doesn't return color non-interactive
#> * 2016312 Update '_pkgdown.yml' with new 'sha' topic
#> Running git diff HEAD~2..HEAD~1 
#> diff --git a/README.Rmd b/README.Rmd
#> index 7feba10..8960baf 100644
#> --- a/README.Rmd
#> +++ b/README.Rmd
#> @@ -96,10 +96,6 @@ library(gitr)
#>  git_version()
#>  ```
#> -```{r sitrep}
#> -git_sitrep()
#> -```
#> -
#>  ```{r current}
#>  git_current_br()
#>  ```
#> @@ -112,6 +108,14 @@ git_default_br()
#>  glog()
#>  ```
#> +```{r sitrep}
#> +git_sitrep()
#> +```
#> +
#> +```{r tag-info}
#> +git_tag_info()
#> +```
#> +
#>  --------


#> [1] "d670c93"


#> Running git tag -n
#> [1] ""
#> ℹ No tags in repository ...

Situation Report

#> Using Git version: 2.39.1 
#> Current branch: main
#> Default branch: main 
#> Repo status:
#> Running git status -s 
#> Branches:
#> Running git branch -a 
#> * main
#>   remotes/origin/gh-pages
#>   remotes/origin/main
#>   remotes/origin/prep-for-cran
#> Local status:
#> ✓ OK
#> Upstream remotes: origin 
#> * main 0c9ac89 [origin/main] Elaborate examples in README.Rmd
#> Commit log: main 
#> Running git log --oneline --graph --decorate -n 5 
#> * 0c9ac89 (HEAD -> main, origin/main) Elaborate examples in README.Rmd
#> * d670c93 Update README.Rmd to include `git_tag_info()`
#> * 45fc4c7 Git tag info no longer errors out
#> * 892e59f Ensure `git_sitrep()` doesn't return color non-interactive
#> * 2016312 Update '_pkgdown.yml' with new 'sha' topic

ZSH-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

Full list of ZSH-aliases

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 command
gapa 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 package is released with a LICENSE. By using in this package you agree to abide by its terms.

Created by Rmarkdown (v2.20) and R version 4.2.2 (2022-10-31).