_______________________________
( ____ \__ __|__ __( ___ )
| ( \/ ) ( ) ( | ( ) |
| | | | | | | (___) |
| | ____ | | | | | ___ |
| | \_ ) | | | | | ( ) |
| (___) |__) (___ | | | ) ( |
(_______)_______/ )_( |/ \| v0.12
This tool does two things
- display the status of multiple git repos such as branch, modification, commit message side by side
- (batch) delegate git commands/aliases from any working directory
If several repos are related, it helps to see their status together. I also hate to change directories to execute git commands.
In the screenshot, the gita remote nowhub
command translates to git remote -v
for the nowhub
repo, even though we are at the blog
repo.
To see the pre-defined sub-commands, run gita -h
or take a look at
cmds.yml.
To add your own sub-commands, see the customization section.
To run arbitrary git
command, see the superman mode section.
To run arbitrary shell command, see the shell mode section.
The branch color distinguishes 5 situations between local and remote branches:
- white: local has no remote
- green: local is the same as remote
- red: local has diverged from remote
- purple: local is ahead of remote (good for push)
- yellow: local is behind remote (good for merge)
The choice of purple for ahead and yellow for behind is motivated by
blueshift and redshift,
using green as baseline.
You can change the color scheme using the gita color
sub-command.
See the customization section.
The additional status symbols denote
+
: staged changes*
: unstaged changes_
: untracked files/folders
The bookkeeping sub-commands are
gita add <repo-path(s)>
: add repo(s) togita
gita clone <config-file>
: clone repos inconfig-file
(generated bygita freeze
) to current directory.gita context
: context sub-commandgita context
: show current contextgita context none
: remove contextgita context <group-name>
: set context togroup-name
, all operations then only apply to repos in this group
gita color
: color sub-commandgita color [ll]
: Show available colors and the current coloring schemegita color set <situation> <color>
: Use the specified color for the local-remote situation
gita freeze
: print information of all repos such as URL, name, and path.gita group
: group sub-commandgita group add <repo-name(s)> -n <group-name>
: add repo(s) to a new group or existing groupgita group [ll]
: display existing groups with reposgita group ls
: display existing group namesgita group rename <group-name> <new-name>
: change group namegita group rm <group-name(s)>
: delete group(s)gita group rmrepo <repo-name(s)> -n <group-name>
: remove repo(s) from existing group
gita info
: info sub-commandgita info [ll]
: display the used and unused information itemsgita info add <info-item>
: enable information itemgita info rm <info-item>
: disable information item
gita ll
: display the status of all reposgita ll <group-name>
: display the status of repos in a groupgita ls
: display the names of all reposgita ls <repo-name>
: display the absolute path of one repogita rename <repo-name> <new-name>
: rename a repogita rm <repo-name(s)>
: remove repo(s) fromgita
(won't remove files from disk)gita -v
: display gita version
The git
delegating sub-commands are of two formats
gita <sub-command> [repo-name(s) or group-name(s)]
: optional repo or group input, and no input means all repos.gita <sub-command> <repo-name(s) or groups-name(s)>
: required repo name(s) or group name(s) input
They translate to git <sub-command>
for the corresponding repos.
By default, only fetch
and pull
take optional input. In other words,
gita fetch
and gita pull
apply to all repos.
To see the pre-defined sub-commands, run gita -h
or take a look at
cmds.yml.
To add your own sub-commands or override the default behaviors, see the customization section.
To run arbitrary git
command, see the superman mode section.
If more than one repos are specified, the git
command runs asynchronously,
with the exception of log
, difftool
and mergetool
,
which require non-trivial user input.
Repo paths are saved in $XDG_CONFIG_HOME/gita/repo_path
(most likely ~/.config/gita/repo_path
).
To install the latest version, run
pip3 install -U gita
If you prefer development mode, download the source code and run
pip3 install -e <gita-source-folder>
In either case, calling gita
in terminal may not work,
then you can put the following line in the .bashrc
file.
alias gita="python3 -m gita"
Windows users may need to enable the ANSI escape sequence in terminal for the branch color to work. See this stackoverflow post for details.
Download .gita-completion.bash or .gita-completion.zsh and source it in the corresponding rc file.
The superman mode delegates any git
command or alias.
Usage:
gita super [repo-name(s) or group-name(s)] <any-git-command-with-or-without-options>
Here repo-name(s)
or group-name(s)
are optional, and their absence means all repos.
For example,
gita super checkout master
puts all repos on the master branchgita super frontend-repo backend-repo commit -am 'implement a new feature'
executesgit commit -am 'implement a new feature'
forfrontend-repo
andbackend-repo
The shell mode delegates any shell command. Usage:
gita shell [repo-name(s) or group-name(s)] <any-shell-command>
Here repo-name(s)
or group-name(s)
are optional, and their absence means all repos.
For example,
gita shell ll
lists contents for all reposgita shell repo1 mkdir docs
create a new directorydocs
in repo1
Custom delegating sub-commands can be defined in $XDG_CONFIG_HOME/gita/cmds.yml
(most likely ~/.config/gita/cmds.yml
).
And they shadow the default ones if name collisions exist.
Default delegating sub-commands are defined in
cmds.yml.
For example, gita stat <repo-name(s)>
is registered as
stat:
cmd: diff --stat
help: show edit statistics
which executes git diff --stat
for the specified repo(s).
If the delegated git
command is a single word, the cmd
tag can be omitted.
See push
for an example.
To disable asynchronous execution, set the disable_async
tag to be true
.
See difftool
for an example.
If you want a custom command to behave like gita fetch
, i.e., to apply the
command to all repos when no repo is specified,
set the allow_all
option to be true
.
For example, the following snippet creates a new command
gita comaster [repo-name(s)]
with optional repo name input.
comaster:
cmd: checkout master
allow_all: true
help: checkout the master branch
You can see the default color scheme and the available colors via gita color
.
To change the color coding, use gita color set <situation> <color>
.
The configuration is saved in $XDG_CONFIG_HOME/gita/color.yml
.
You can customize the information displayed by gita ll
.
The used and unused information items are shown with gita info
, and the
configuration is saved in $XDG_CONFIG_HOME/gita/info.yml
.
For example, the default information items setting corresponds to
- branch
- commit_msg
Gita requires Python 3.6 or higher, due to the use of f-string and asyncio module.
Under the hood, gita uses subprocess
to run git commands/aliases.
Thus the installed git version may matter.
I have git 1.8.3.1
, 2.17.2
, and 2.20.1
on my machines, and
their results agree.
To contribute, you can
- report/fix bugs
- request/implement features
- star/recommend this project
To run tests locally, simply pytest
.
More implementation details are in
design.md.
A step-by-step guide to reproduce this project is here.
You can also sponsor me on GitHub. Any amount is appreciated!
I haven't tried them but I heard good things about them.