Home

Awesome

<h1 align="center"> <img width="300px" src="assets/logo.png" />

CI crates MIT UNSAFE TWEET dep_status discord

</h1> <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>

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):

TimeMemory (GB)Binary (MB)FreezesCrashes
gitui24 s0.1710NoNo
lazygit57 s2.625YesSometimes
tig4 m 20 s1.30.6SometimesNo

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:

5. <a name="limitations"></a> Known Limitations <small><sup>Top ▲</sup></small>

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
Nix (Nix/NixOS)

Nixpkg

nix-env -iA nixpkgs.gitui

NixOS

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

All contain a single binary file

macOS

Windows

Nightly Builds

see NIGHTLIES.md

7. <a name="build"></a> Build <small><sup>Top ▲</sup></small>

Requirements

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 tracing

works 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:

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>

github

13. <a name="inspiration"></a> Inspiration <small><sup>Top ▲</sup></small>

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/extrawurst/gitui/graphs/contributors"> <img src="https://contrib.rocks/image?repo=extrawurst/gitui" /> </a>