Manage multiple git repos
Project description
Gita: a command-line tool to manage multiple git repos
This tool does two things
- display the status of multiple git repos such as branch, modification, commit message side by side
- delegate git commands/aliases from any working directory
If several repos need to be compiled against each other, it helps to see their status together. I also hate to change directories to execute git commands.
Here the colors denote the 5 situations between local and remote branches:
- white: local branch has no remote branch
- green: local branch is the same as remote branch
- red: local branch has diverged from remote branch
- purple: local branch is ahead of remote branch (good for push)
- yellow: local branch is behind remote branch (good for merge)
The choice of purple for ahead and yellow for behind is motivated by blueshift and redshift, using green as baseline.
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 rm <repo-name(s)>
: remove repo(s) fromgita
(won't remove files from disk)gita ll
: display the status of all reposgita ls
: display the names of all reposgita ls <repo-name>
: display the absolute path of one repogita -v
: display gita version
Repo paths are saved in $XDG_CONFIG_HOME/gita/repo_path
(most likely ~/.config/gita/repo_path
).
The delegated git sub-commands are of two formats
gita <sub-command> [repo-name(s)]
with optional input, and no input means all repos.gita <sub-command> <repo-name(s)>
with required repo name(s) input
By default, only fetch
and pull
take optional input.
Sub-commands with required input include branch
, clean
, diff
, difftool
,
log
, merge
, mergetool
, patch
, push
, rebase
, reflog
, remote
,
stash
, stat
, and status
.
If more than one repos are specified, the git command will run asynchronously,
with the exception of difftool
and mergetool
, which require non-trivial user input.
Customization
Custom git commands/aliases can be placed in $XDG_CONFIG_HOME/gita/cmds.yml
(most likely ~/.config/gita/cmds.yml
).
And they shadow the default ones if name collisions exist.
Delegation details for the default commands are 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
.
If the delegated git command is a single word, the cmd
tag can be omitted.
See push
as an example.
To disable asynchronous execution, set the disable_async
tag to be true
.
See difftool
as an example.
If you want a custom command to behave like gita fetch
, i.e., to apply
command to all repos if nothing 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
Superman mode
The superman mode delegates any git command/alias. Usage:
gita super [repo-name(s)] <command/alias>
Here repo-name(s)
is optional, and absence means all repos.
For example,
gita super myrepo1 commit -am 'fix a bug'
executesgit commit -am 'fix a bug'
formyrepo1
gita super checkout master
puts all repos on the master branch (also see the customization example)gita super frontend_repo backend_repo checkout new-feature
puts the two chosen repos on thenew-feature
branch
Requirements
Gita requires Python 3.6 or higher, due to the use of f-string and asyncio module.
Installation
To install the latest version, run
pip3 install -U gita
If development mode is preferred,
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"
Auto-completion
For auto completion, download
.gita-completion.bash
and source it in .bashrc
.
Contributing
To contribute, you can
- report/fix bugs
- request/implement features
- star/recommend this project
To run tests locally, simply pytest
.
Other multi-repo tools
I haven't tried them but I heard good things about them.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.