Repository: gitui-org/gitui
Stars: 21784
README.md
<h1 align="center">
<img width="300px" src="assets/logo.png" />
[![CI][s0]][l0] [![crates][s1]][l1] ![MIT][s2] [![UNSAFE][s3]][l3] [![TWEET][s6]][l6] [![dep_status][s7]][l7] [![discord][s8]][l8]
</h1>
[s0]: https://github.com/gitui-org/gitui/workflows/CI/badge.svg
[l0]: https://github.com/gitui-org/gitui/actions
[s1]: https://img.shields.io/crates/v/gitui.svg
[l1]: https://crates.io/crates/gitui
[s2]: https://img.shields.io/badge/license-MIT-blue.svg
[s3]: https://img.shields.io/badge/unsafe-forbidden-success.svg
[l3]: https://github.com/rust-secure-code/safety-dance/
[s6]: https://img.shields.io/twitter/follow/extrawurst?label=follow&style=social
[l6]: https://twitter.com/intent/follow?screen_name=extrawurst
[s7]: https://deps.rs/repo/github/gitui-org/gitui/status.svg
[l7]: https://deps.rs/repo/github/gitui-org/gitui
[s8]: https://img.shields.io/discord/1176858176897953872
[l8]: https://discord.gg/rQNeEnMhus
<h5 align="center">GitUI provides you with the comfort of a git GUI but right in your terminal</h1>
<a name="table-of-contents"></a> Table of Contents
1. Features
2. Motivation
3. Benchmarks
4. Roadmap
5. Limitations
6. Installation
7. Build
8. FAQs
9. Diagnostics
10. Color Theme
11. Key Bindings
12. Sponsoring
13. Inspiration
14. Contributing
15. Contributors
1. <a name="features"></a> Features <small><sup>Top ▲</sup></small>
- 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. <a name="motivation"></a> Motivation <small><sup>Top ▲</sup></small>
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. <a name="bench"></a> Benchmarks <small><sup>Top ▲</sup></small>
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. <a name="roadmap"></a> Road(map) to 1.0 <small><sup>Top ▲</sup></small>
These are the high level goals before calling out 1.0:
* visualize branching structure in log tab (#81)
* interactive rebase (#32)
- no git-lfs support (see #2812)
5. <a name="limitations"></a> Known Limitations <small><sup>Top ▲</sup></small>
- no sparse repo support (see #1226)
- 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. <a name="installation"></a> Installation <small><sup>Top ▲</sup></small>
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.
<a href="https://repology.org/project/gitui/versions">
<img src="https://repology.org/badge/vertical-allrepos/gitui.svg" alt="Packaging status" align="right">
</a>
Various Package Managers
<details>
<summary>Install Instructions</summary>
##### Arch Linux
pacman -S gitui##### Fedora
sudo dnf install gitui##### Gentoo
Available in dm9pZCAq overlay
sudo eselect repository enable dm9pZCAq
sudo emerge --sync dm9pZCAq
sudo emerge dev-vcs/gitui::dm9pZCAq##### openSUSE
sudo zypper install gitui##### Homebrew (macOS)
brew install gitui##### MacPorts (macOS)
port install gitui##### Winget (Windows)
winget install gitui##### Scoop (Windows)
scoop install gitui##### Chocolatey (Windows)
choco install gitui##### Mise
mise use -g gitui@latest##### Nix (Nix/NixOS)
Nixpkg
nix-env -iA nixpkgs.gituiNixOS
nix-env -iA nixos.gitui##### Termux (Android)
pkg install gitui##### Anaconda
conda install -c conda-forge gitui</details>
Release Binaries
Available for download in releases
Binaries available for:
#### Linux
- 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
#### macOS
- gitui-mac.tar.gz (arm64)
- gitui-mac-x86.tar.gz (intel x86)
#### Windows
- gitui-win.tar.gz (single 64bit binary)
- gitui-win.msi (64bit Installer package)
Nightly Builds
see NIGHTLIES.md
7. <a name="build"></a> Build <small><sup>Top ▲</sup></small>
Requirements
- Minimum supported rust/cargo version: 1.88
- 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)
Cargo Install
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
Cargo Features
#### trace-libgit
enable
libgit2 tracingworks if libgit2 built with -DENABLE_TRACE=ON
this feature enabled by default, to disable: cargo install --no-default-features
8. <a name="faqs"></a> FAQs <small><sup>Top ▲</sup></small>
see FAQs page
9. <a name="diagnostics"></a> Diagnostics <small><sup>Top ▲</sup></small>
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. <a name="theme"></a> Color Theme <small><sup>Top ▲</sup></small>
gitui should automatically work on both light and dark terminal themes.
However, you can customize everything to your liking: See Themes.
11. <a name="bindings"></a> Key Bindings <small><sup>Top ▲</sup></small>
The key bindings can be customized: See Key Config on how to set them to vim-like bindings.
12. <a name="sponsoring"></a> Sponsoring <small><sup>Top ▲</sup></small>
13. <a name="inspiration"></a> Inspiration <small><sup>Top ▲</sup></small>
- 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. <a name="contributing"></a> Contributing <small><sup>Top ▲</sup></small>
See CONTRIBUTING.md.
15. <a name="contributors"></a> Contributors <small><sup>Top ▲</sup></small>
Thanks goes to all the contributors that help make GitUI amazing! ❤️
Wanna become a co-maintainer? We are looking for you!
<a href="https://github.com/gitui-org/gitui/graphs/contributors">
<img src="https://contrib.rocks/image?repo=gitui-org/gitui" />
</a>