2019-05-21 16:53:11 +08:00
# git plugin
2013-06-05 21:16:51 +08:00
2019-05-21 16:53:11 +08:00
The git plugin provides many [aliases ](#aliases ) and a few useful [functions ](#functions ).
2013-07-12 21:26:04 +08:00
2019-05-21 16:53:11 +08:00
To use it, add `git` to the plugins array in your zshrc file:
2013-07-12 21:26:04 +08:00
2019-05-21 16:53:11 +08:00
```zsh
plugins=(... git)
```
2013-07-12 21:26:04 +08:00
2019-05-21 16:53:11 +08:00
## Aliases
2013-07-12 21:26:04 +08:00
2023-01-12 20:41:47 +08:00
| Alias | Command |
| :------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| g | git |
| ga | git add |
| gaa | git add --all |
| gapa | git add --patch |
| gau | git add --update |
| gav | git add --verbose |
| gap | git apply |
| gapt | git apply --3way |
| gb | git branch |
| gba | git branch --all |
| gbd | git branch --delete |
| gbda | git branch --no-color --merged \| grep -vE "^([+*]\|\s*(< span > $</ span > (git_main_branch)\|< span > $</ span > (git_develop_branch))\s*< span > $</ span > )" \| xargs git branch --delete 2>/dev/null |
| gbD | git branch --delete --force |
2023-02-20 22:35:58 +08:00
| gbg | git branch -vv | grep ": gone\]" |
| gbgd | local res=$(git branch -vv | grep ": gone\]" | awk '{print $1}') && [[ $res ]] && echo $res | xargs git branch -d |
| gbgD | local res=$(git branch -vv | grep ": gone\]" | awk '{print $1}') && [[ $res ]] && echo $res | xargs git branch -D |
2023-01-12 20:41:47 +08:00
| gbl | git blame -b -w |
| gbnm | git branch --no-merged |
| gbr | git branch --remote |
| gbs | git bisect |
| gbsb | git bisect bad |
| gbsg | git bisect good |
| gbsr | git bisect reset |
| gbss | git bisect start |
| gc | git commit --verbose |
| gc! | git commit --verbose --amend |
| gcn! | git commit --verbose --no-edit --amend |
| gca | git commit --verbose --all |
| gca! | git commit --verbose --all --amend |
| gcan! | git commit --verbose --all --no-edit --amend |
| gcans! | git commit --verbose --all --signoff --no-edit --amend |
| gcam | git commit --all --message |
| gcas | git commit --all --signoff |
| gcasm | git commit --all --signoff --message |
| gcsm | git commit --signoff --message |
| gcb | git checkout -b |
| gcf | git config --list |
| gcl | git clone --recurse-submodules |
| gccd | git clone --recurse-submodules "< span > $</ span > @" && cd "< span > $</ span > (basename < span > $</ span > \_ .git)" |
| gclean | git clean --interactive -d |
| gpristine | git reset --hard & & git clean -dffx |
| gcm | git checkout $(git_main_branch) |
| gcd | git checkout $(git_develop_branch) |
| gcmsg | git commit --message |
| gco | git checkout |
| gcor | git checkout --recurse-submodules |
| gcount | git shortlog --summary -n |
| gcp | git cherry-pick |
| gcpa | git cherry-pick --abort |
| gcpc | git cherry-pick --continue |
| gcs | git commit -S |
2023-01-12 20:56:26 +08:00
| gcss | git commit -S -s |
| gcssm | git commit -S -s -m |
2023-01-12 20:41:47 +08:00
| gd | git diff |
| 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 |
| gdnolock | git diff $@ ":(exclude)package-lock.json" ":(exclude)\*.lock" |
| gdup | git diff @{upstream} |
| gdv | git diff -w $@ \| view - |
| gdw | git diff --word-diff |
| gf | git fetch |
| gfa | git fetch --all --prune |
| gfg | git ls-files \| grep |
| gfo | git fetch origin |
| gg | git gui citool |
| gga | git gui citool --amend |
| ggf | git push --force origin $(current_branch) |
| ggfl | git push --force-with-lease origin $(current_branch) |
| ggl | git pull origin $(current_branch) |
| ggp | git push origin $(current_branch) |
| ggpnp | ggl & & ggp |
| ggpull | git pull origin "$(git_current_branch)" |
| ggpur | ggu |
| ggpush | git push origin "$(git_current_branch)" |
| ggsup | git branch --set-upstream-to=origin/$(git_current_branch) |
| ggu | git pull --rebase origin $(current_branch) |
| gpsup | git push --set-upstream origin $(git_current_branch) |
2023-02-06 19:07:40 +08:00
| gpsupf | git push --set-upstream origin $(git_current_branch) --force-with-lease --force-if-includes (git version >= 2.30) |
| gpsupf | git push --set-upstream origin $(git_current_branch) --force-with-lease (git version < 2.30 ) |
2023-01-12 20:41:47 +08:00
| 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 |
| gk | gitk --all --branches & ! |
| gke | gitk --all $(git log --walk-reflogs --pretty=%h) & ! |
| gl | git pull |
| glg | git log --stat |
| glgp | git log --stat --patch |
| 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='%Cred%h%Creset -%C(auto)%d%Creset %s %Cgreen(%ar) %C(bold blue)< %an>%Creset' |
| 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 |
| glog | git log --oneline --decorate --graph |
| gloga | git log --oneline --decorate --graph --all |
| glp | git log --pretty=\<format\> |
| gm | git merge |
2023-04-08 19:36:54 +08:00
| gms | git merge --squash |
2023-01-12 20:41:47 +08:00
| 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 |
| gp | git push |
| gpd | git push --dry-run |
2023-02-06 19:07:40 +08:00
| gpf | git push --force-with-lease --force-if-includes (git version >= 2.30) |
| gpf | git push --force-with-lease (git version < 2.30 ) |
2023-01-12 20:41:47 +08:00
| gpf! | git push --force |
| gpoat | git push origin --all & & git push origin --tags |
2023-02-18 00:29:10 +08:00
| gpod | git push origin --delete |
2023-01-12 20:41:47 +08:00
| gpr | git pull --rebase |
| gpu | git push upstream |
| gpv | git push --verbose |
| gr | git remote |
| gra | git remote add |
| grb | git rebase |
| grba | git rebase --abort |
| grbc | git rebase --continue |
| grbd | git rebase $(git_develop_branch) |
| grbi | git rebase --interactive |
| grbm | git rebase $(git_main_branch) |
| grbom | git rebase origin/$(git_main_branch) |
| grbo | git rebase --onto |
| grbs | git rebase --skip |
| grev | git revert |
| grh | git reset |
| grhh | git reset --hard |
| groh | git reset origin/$(git_current_branch) --hard |
| grm | git rm |
| grmc | git rm --cached |
| 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 |
| grv | git remote --verbose |
| gsb | git status --short -b |
| gsd | git svn dcommit |
| gsh | git show |
| gsi | git submodule init |
| gsps | git show --pretty=short --show-signature |
| gsr | git svn rebase |
| gss | git status --short |
| gst | git status |
2023-01-12 20:56:26 +08:00
| gsta | git stash push (git version >= 2.13) |
| gsta | git stash save (git version < 2.13 ) |
2023-01-12 20:41:47 +08:00
| gstaa | git stash apply |
| gstc | git stash clear |
| gstd | git stash drop |
| gstl | git stash list |
| gstp | git stash pop |
| gsts | git stash show --text |
| gstu | git stash --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 --list ${1}\* }; noglob gtl |
| gunignore | git update-index --no-assume-unchanged |
2023-05-26 15:43:17 +08:00
| gunwip | git rev-list --max-count=1 --format="%s" HEAD \| grep -q "\-\-wip\-\-" && git reset HEAD~1 |
2023-01-12 20:41:47 +08:00
| gup | git pull --rebase |
| gupv | git pull --rebase --verbose |
| gupa | git pull --rebase --autostash |
| gupav | git pull --rebase --autostash --verbose |
| gupom | git pull --rebase origin $(git_main_branch) |
| gupomi | git pull --rebase=interactive origin $(git_main_branch) |
| glum | git pull upstream $(git_main_branch) |
| gluc | git pull upstream $(git_current_branch) |
| gwch | git whatchanged -p --abbrev-commit --pretty=medium |
| gwip | git add -A; git rm $(git ls-files --deleted) 2> /dev/null; git commit --no-verify --no-gpg-sign --message "--wip-- [skip ci]" |
| gam | git am |
| gamc | git am --continue |
| gams | git am --skip |
| gama | git am --abort |
| gamscp | git am --show-current-patch |
2023-01-12 20:56:26 +08:00
| gwt | git worktree |
| gwtls | git worktree list |
| gwtmv | git worktree move |
| gwtrm | git worktree remove |
2019-05-21 16:53:11 +08:00
2020-07-04 01:03:04 +08:00
### Main branch preference
Following the recent push for removing racially-charged words from our technical vocabulary, the git plugin favors using
a branch name other than `master` . In this case, we favor the shorter, neutral and descriptive term `main` . This means
2020-07-15 23:02:49 +08:00
that any aliases and functions that previously used `master` , will use `main` if that branch exists. We do this via the
function `git_main_branch` .
2020-07-04 01:03:04 +08:00
2020-03-12 02:57:46 +08:00
### Deprecated aliases
2019-05-21 16:53:11 +08:00
These are aliases that have been removed, renamed, or otherwise modified in a way that may, or may not, receive further support.
2020-02-19 04:05:52 +08:00
| Alias | Command | Modification |
| :----- | :----------------------------------------------------- | :----------------------------------------------------- |
| gap | `git add --patch` | new alias `gapa` |
| gcl | `git config --list` | new alias `gcf` |
| gdc | `git diff --cached` | new alias `gdca` |
| gdt | `git difftool` | no replacement |
| ggpull | `git pull origin $(current_branch)` | new alias `ggl` (`ggpull` still exists for now though) |
| ggpur | `git pull --rebase origin $(current_branch)` | new alias `ggu` (`ggpur` still exists for now though) |
| ggpush | `git push origin $(current_branch)` | new alias `ggp` (`ggpush` still exists for now though) |
| gk | `gitk --all --branches` | now aliased to `gitk --all --branches` |
| glg | `git log --stat --max-count = 10` | now aliased to `git log --stat --color` |
| glgg | `git log --graph --max-count = 10` | now aliased to `git log --graph --color` |
| gwc | `git whatchanged -p --abbrev-commit --pretty = medium` | new alias `gwch` |
2019-05-21 16:53:11 +08:00
## Functions
### Current
2021-08-10 22:31:49 +08:00
| Command | Description |
2023-01-12 20:56:26 +08:00
| :--------------------- | :------------------------------------------------------------------------------------------------------- |
2021-08-10 22:31:49 +08:00
| `grename <old> <new>` | Rename `old` branch to `new` , including in origin remote |
| current_branch | Return the name of the current branch |
| git_current_user_name | Returns the `user.name` config value |
| git_current_user_email | Returns the `user.email` config value |
| git_main_branch | Returns the name of the main branch: `main` if it exists, `master` otherwise |
| git_develop_branch | Returns the name of the develop branch: `dev` , `devel` , `development` if they exist, `develop` otherwise |
2019-05-21 16:53:11 +08:00
### Work in Progress (WIP)
These features allow to pause a branch development and switch to another one (_"Work in Progress"_, or wip). When you want to go back to work, just unwip it.
| Command | Description |
2023-01-12 20:56:26 +08:00
| :--------------- | :---------------------------------------------- |
2019-05-21 16:53:11 +08:00
| work_in_progress | Echoes a warning if the current branch is a wip |
| gwip | Commit wip branch |
| gunwip | Uncommit wip branch |
2023-06-05 16:38:54 +08:00
| gunwipall | Uncommit `--wip--` commits recursively |
2019-05-21 16:57:37 +08:00
2020-03-12 02:57:46 +08:00
### Deprecated functions
2019-05-21 16:57:37 +08:00
2023-01-12 20:56:26 +08:00
| Command | Description | Reason |
| :----------------- | :-------------------------------------- | :-------------------------------------------------------------- |
| current_repository | Return the names of the current remotes | Didn't work properly. Use `git remote -v` instead (`grv` alias) |
