- Features
- Motivation
- Benchmarks
- Roadmap
- Limitations
- Installation
- Build
- FAQs
- Diagnostics
- Color Theme
- Key Bindings
- Sponsoring
- Inspiration
- Contributing
- Contributors
1. Features Top ▲
- Fast and intuitive keyboard only control
- Context based help (no need to memorize tons of hot-keys)
- Inspect, commit, and amend changes (incl. hooks: pre-commit,commit-msg,post-commit,prepare-commit-msg)
- Stage, unstage, revert and reset files, hunks and lines
- Stashing (save, pop, apply, drop, and inspect)
- Push / Fetch to / from remote
- Branch List (create, rename, delete, checkout, remotes)
- Browse / Search commit log, diff committed changes
- Responsive terminal UI
- Async git API for fluid control
- Submodule support
- gpg commit signing with shortcomings (see #97))
2. Motivation Top ▲
I do most of my git work in a terminal but I frequently found myself using git GUIs for some use-cases like: index, commit, diff, stash, blame and log.
Unfortunately popular git GUIs all fail on giant repositories or become unresponsive and unusable.
GitUI provides you with the user experience and comfort of a git GUI but right in your terminal while being portable, fast, free and opensource.
3. Benchmarks Top ▲
For a RustBerlin meetup presentation (slides) I compared lazygit,tig and gitui by parsing the entire Linux git repository (which contains over 900k commits):
| Time | Memory (GB) | Binary (MB) | Freezes | Crashes | |
|---|---|---|---|---|---|
gitui |
24 s ✅ | 0.17 ✅ | 10 | No ✅ | No ✅ |
lazygit |
57 s | 2.6 | 25 | Yes | Sometimes |
tig |
4 m 20 s | 1.3 | 0.6 ✅ | Sometimes | No ✅ |
4. Road(map) to 1.0 Top ▲
These are the high level goals before calling out 1.0:
5. Known Limitations Top ▲
- no sparse repo support (see #1226)
- no git-lfs support (see #1089)
- credential.helper for https needs to be explicitly configured (see #800)
Currently, this tool does not fully substitute the git shell, however both tools work well in tandem.
The priorities for gitui are on features that are making me mad when done on the git shell, like stashing, staging lines or hunks. Eventually, I will be able to work on making gitui a one stop solution - but for that I need help - this is just a spare time project for now.
All support is welcomed! Sponsors as well! ❤️
6. Installation Top ▲
GitUI is in beta and may contain bugs and missing features. However, for personal use it is reasonably stable and is being used while developing itself.
Install Instructions
pacman -S gituisudo dnf install gituiAvailable in dm9pZCAq overlay
sudo eselect repository enable dm9pZCAq
sudo emerge --sync dm9pZCAq
sudo emerge dev-vcs/gitui::dm9pZCAqsudo zypper install gituibrew install gituiport install gituiWinget (Windows)
winget install gitui
Scoop (Windows)
scoop install gitui
Chocolatey (Windows)
choco install gitui
Nix (Nix/NixOS)
Nixpkg
nix-env -iA nixpkgs.gitui
NixOS
nix-env -iA nixos.gitui
Termux (Android)
pkg install gitui
conda install -c conda-forge gitui
Available for download in releases
Binaries available for:
- gitui-linux-x86_64.tar.gz (linux musl statically linked)
- gitui-linux-aarch64.tar.gz (linux on 64 bit arm)
- gitui-linux-arm.tar.gz
- gitui-linux-armv7.tar.gz
All contain a single binary file
- gitui-mac.tar.gz (arm64)
- gitui-mac-x86.tar.gz (intel x86)
- gitui-win.tar.gz (single 64bit binary)
- gitui-win.msi (64bit Installer package)
see NIGHTLIES.md
7. Build Top ▲
-
Minimum supported
rust/cargoversion:1.70- See Install Rust
-
To build openssl dependency (see https://docs.rs/openssl/latest/openssl/)
- perl >= 5.12 (strawberry perl works for windows https://strawberryperl.com/)
- a c compiler (msvc, gcc or clang, cargo will find it)
-
To run the complete test suite python is required (and it must be invocable as
python)
The simplest way to start playing around with gitui is to have cargo build and install it with cargo install gitui --locked. If you are not familiar with rust and cargo: Getting Started with Rust
enable libgit2 tracing
works if libgit2 built with -DENABLE_TRACE=ON
this feature enabled by default, to disable: cargo install --no-default-features
8. FAQs Top ▲
see FAQs page
9. Diagnostics Top ▲
To run with logging enabled run gitui -l.
This will log to:
- macOS:
$HOME/Library/Caches/gitui/gitui.log - Linux using
XDG:$XDG_CACHE_HOME/gitui/gitui.log - Linux:
$HOME/.cache/gitui/gitui.log - Windows:
%LOCALAPPDATA%/gitui/gitui.log
10. Color Theme Top ▲
gitui should automatically work on both light and dark terminal themes.
However, you can customize everything to your liking: See Themes.
11. Key Bindings Top ▲
The key bindings can be customized: See Key Config on how to set them to vim-like bindings.
12. Sponsoring Top ▲
13. Inspiration Top ▲
- lazygit
- tig
- GitUp
- It would be nice to come up with a way to have the map view available in a terminal tool
- git-brunch
14. Contributing Top ▲
See CONTRIBUTING.md.
15. Contributors Top ▲
Thanks goes to all the contributors that help make GitUI amazing! ❤️
Wanna become a co-maintainer? We are looking for you!
![@dependabot[bot]](data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAEAAAABAEAIAAAB1mzrKAAAFjUlEQVR4nOyba0xTVxzAz+VSHpXB2uGrtR1FnVbmYwMmmBmCW30kGl+dw0wRG6wanRFmFOamWSZRhw98YcoEmXOuOhESZCr4mHPbBYQx/QBR3m2pII+WrmmVFrrA3YcaV3bbe+G0cn6fyJ/T/3n87rn39vDHG8fl8upqgICEF+wBjHSQAMggAZBBAiCDBEAGCYAMEgAZJAAySABkkADIeMMegHO8ly4S+XcIy7hcVgWV9qU/NTSYH2swnc6ybehH5woeJuCeZefqkCu40utNcJRK+x9Hl2cY9q49na1rGfrBuYSH3YLwnVSXnoQVg8/FSodyRHTxMAGvHkgAZJAAyCABkPEwAVUTVdeemWGPgkk87DU0sjmtoLEJeIMCx22sVoVCLB7OUdHBw3bAqwdjOwArxQRYdKzf1C/ZRdx9bAVezlRml/h3B0yYwOF4n5BKw8MDi+gnbZ1rIKxTCE39JHN+b3qfypZMPyfGVFVEjiCBzfstvjH6aNAG+tncmXMiIql7u0yda9JupJ+NgVtQmIGv9ItZOyYqKSiMfjb3Z2Cmc6YmjDvoe5J+NgYEiGXj0n1SsTJMCObQz+b+DMx01dtG/iXfSfSzoYcwZJAAyCABkEECIIMEQAYJgAwSABkkADJuKqB3W18zSDr/fSlh4N+tf5xrujl0fRVmPmQbN1T9qebBOOh2UwFpt39e0dGTsP5sbsvNhV9lGFXdD/7SRD1fwmwvxzm3vtDNWL7t1Fp18of6w9UqmTZDr7deYLaXwXH6MC5KGiryn3xn8464kPdZMXgIcLHmQM3vumodK2jhLvZus48rm+5fMVxfp8ip0ebZnziGGfhKX58H7D3doROp5LfNtqnAHxqg01kiBWXcmSyW/W8PNRcnds1LmZiHt52yjy8qmV4coCuM3doocOJYxfJD70MgjqlMVzRllR9vtJqDqX/W6R0wAXC4rBN0lj4lNC/v6UlRW2ph7S+7Kvp/JuOOlp4kYoxQ6x9PJT95+1qzJrta+7GoMjWzrk52Lbf8idy0sWe/baWjpSeJ/DUkxD/T2RmxPsFngBqhljuTWrmYPcP6F7HPU/NXtwcfUhUHdt4jI4ejios7P7h78HG+aV1Vh0r8zOflpY8TRi4Pmp+1Kb5jvBQAMOr/ejlClOR0rruYeb+1W05Gzi0hsvVJv/vUvWOqqM9ux3siXv7UDuGCb9+4tWfv4r7g80zNlwrDKmBWgcDgmw0ACHwxXrGraZQ5BQCgejG+YH/YtID0s5L1PF4APotqSZZoZ3CKzy6wGmwHGfbx+p72qv9a+kXG6VhA8wG/FX1jtroyK3oM60N4VU1EUeDSg+ErV47dMnhL8qovkGyJFRCsWf0bnHov0o/C/V+7QV7Rg7dcZJzuFdB8bp/Mxl9PPT+zQHgL+qxs/nzubUcayKX/bpNMzJM6u/T2HGjov6IdaSDjhX5bTwsWcvaxFV5PXOuFPtCqIkgNmBrDwO7dy/IfPX13VWLEvEBbzt8Jo3hSZ2tAHUFqmLZ4/Bnf7UlHLu1tq910K4bFMaZtXtY3+i4T86AL5LKUZIFEwk1LrpRIuPZhKbO9xF+NTgzKiAfRiUEAvMVsbrq46RexkYPTAlSzuzotEb3f9L9rD82QPI/nodbJtosaQtdl+dTZzzJQljJQdXNdqZTL+SNISVxcVlbL0cuXKysNC+nkQbcgyCABkEECIIMEQIYBAdoSvW54z9Ddgda5hjNWBr5TMCCAuNFgMZvv1D6Sm+T0s7k/d8yP5KavCU39UvMg/6VAFcaqo/FjXkLsSGzHlAS24vUadhF+jH5Od0NbotdbLxA3GnrMtbYom9pG0M/JmACEa6CHMGSQAMggAZBBAiCDBEAGCYAMEgAZJAAySABkkADI/BMAAP//mQrznkZAir0AAAAASUVORK5CYII=){kind=small}
