- Features
- Motivation
- Benchmarks
- Roadmap
- Limitations
- Installation
- Build
- FAQs
- Diagnostics
- Color Theme
- Key Bindings
- Sponsoring
- Inspiration
- Contributing
- Contributors
1.FeaturesTop ▲
- Fast and intuitivekeyboard onlycontrol
- Context based help (no need to memorizetons 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 /Searchcommit log, diff committed changes
- Responsive terminal UI
- Async git API for fluid control
- Submodule support
- gpg commit signing with shortcomings (see#97))
2.MotivationTop ▲
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.BenchmarksTop ▲
For aRustBerlin meetup presentation(slides) I comparedlazygit
,tig
andgitui
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.0Top ▲
These are the high level goals before calling out1.0
:
5.Known LimitationsTop ▲
- no sparse repo support (see#1226)
- no git-lfs support (see#1089)
- credential.helperfor https needs to beexplicitlyconfigured (see#800)
Currently, this tool does not fully substitute thegit shell,however both tools work well in tandem.
The priorities forgitui
are on features that are making me mad when done on thegit shell,like stashing, staging lines or hunks. Eventually, I will be able to work on makinggitui
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.InstallationTop ▲
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 gitui
sudo dnf install gitui
Available indm9pZCAq overlay
sudo eselect repositoryenabledm9pZCAq
sudo emerge --sync dm9pZCAq
sudo emerge dev-vcs/gitui::dm9pZCAq
sudo zypper install gitui
brew install gitui
port install gitui
Winget(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)
seeNIGHTLIES.md
7.BuildTop ▲
-
Minimum supported
rust
/cargo
version:1.70
- SeeInstall Rust
-
To build openssl dependency (seehttps://docs.rs/openssl/latest/openssl/)
- perl >= 5.12 (strawberry perl works for windowshttps://strawberryperl /)
- 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 withgitui
is to havecargo
build and install it withcargo install gitui --locked
.If you are not familiar with rust and cargo:Getting Started with Rust
enablelibgit2
tracing
works iflibgit2
built with-DENABLE_TRACE=ON
this feature enabled by default, to disable:cargo install --no-default-features
8.FAQsTop ▲
seeFAQs page
9.DiagnosticsTop ▲
To run with logging enabled rungitui -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 ThemeTop ▲
gitui
should automatically work on both light and dark terminal themes.
However, you can customize everything to your liking: SeeThemes.
11.Key BindingsTop ▲
The key bindings can be customized: SeeKey Configon how to set them tovim
-like bindings.
12.SponsoringTop ▲
13.InspirationTop ▲
- 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.ContributingTop ▲
SeeCONTRIBUTING.md.
15.ContributorsTop ▲
Thanks goes to all the contributors that help make GitUI amazing! ❤️
Wanna become a co-maintainer? We are looking foryou!