Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/extrawurst/gitui

Blazing πŸ’₯ fast terminal-ui for git written in rust πŸ¦€
https://github.com/extrawurst/gitui

async bash command-line-interface command-line-tool git hacktoberfest rust terminal tui

Last synced: 24 days ago
JSON representation

Blazing πŸ’₯ fast terminal-ui for git written in rust πŸ¦€

Lists

README 

        





[![CI][s0]][l0] [![crates][s1]][l1] ![MIT][s2] [![UNSAFE][s3]][l3] [![ITCH][s4]][l4] [![TWEET][s6]][l6] [![dep_status][s7]][l7]






[s0]: https://github.com/extrawurst/gitui/workflows/CI/badge.svg

[l0]: https://github.com/extrawurst/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/

[s4]: https://img.shields.io/badge/itch.io-ok-green

[l4]: https://extrawurst.itch.io/gitui

[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/extrawurst/gitui/status.svg

[l7]: https://deps.rs/repo/github/extrawurst/gitui



GitUI provides you with the comfort of a git GUI but right in your terminal



![](demo.gif)



##  Table of Contents



1. [Features](#features)

2. [Motivation](#motivation)

3. [Benchmarks](#bench)

4. [Roadmap](#roadmap)

5. [Limitations](#limitations)

6. [Installation](#installation)

7. [Build](#build)

8. [FAQs](#faqs)

9. [Diagnostics](#diagnostics)

10. [Color Theme](#theme)

11. [Key Bindings](#bindings)

12. [Sponsoring](#sponsoring)

13. [Inspiration](#inspiration)



## 1.  Features [Top β–²](#table-of-contents)



- 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



## 2.  Motivation [Top β–²](#table-of-contents)



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 β–²](#table-of-contents)



For a [RustBerlin meetup presentation](https://youtu.be/rpilJV-eIVw?t=5334) ([slides](https://github.com/extrawurst/gitui-presentation)) 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** βœ…  | 1.4         | **No** βœ…  | **No** βœ…  |

| `lazygit` | 57 s       | 2.6         | 16          | Yes       | Sometimes |

| `tig`     | 4 m 20 s   | 1.3         | **0.6** βœ…   | Sometimes | **No** βœ…  |



## 4.  Road(map) to 1.0 [Top β–²](#table-of-contents)



These are the high level goals before calling out `1.0`:



* visualize branching structure in log tab ([#81](https://github.com/extrawurst/gitui/issues/81))

* interactive rebase ([#32](https://github.com/extrawurst/gitui/issues/32))



## 5.  Known Limitations [Top β–²](#table-of-contents)



- no sparse repo support (see [#1226](https://github.com/extrawurst/gitui/issues/1226))

- no support for GPG signing (see [#97](https://github.com/extrawurst/gitui/issues/97))

- no git-lfs support (see [#1089](https://github.com/extrawurst/gitui/discussions/1089))

- *credential.helper* for https needs to be **explicitly** configured (see [#800](https://github.com/extrawurst/gitui/issues/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 β–²](#table-of-contents)



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.





    Packaging status




### Various Package Managers



  Install Instructions



##### [Arch Linux](https://archlinux.org/packages/extra/x86_64/gitui/)



```sh

pacman -S gitui

```



##### Fedora



```sh

sudo dnf install gitui

```



##### Gentoo

Available in [dm9pZCAq overlay](https://github.com/gentoo-mirror/dm9pZCAq)



```sh

sudo eselect repository enable dm9pZCAq

sudo emerge --sync dm9pZCAq

sudo emerge dev-vcs/gitui::dm9pZCAq

```



##### [openSUSE](https://software.opensuse.org/package/gitui)



```sh

sudo zypper install gitui

```



##### Homebrew (macOS)



```sh

brew install gitui

```



##### [MacPorts (macOS)](https://ports.macports.org/port/gitui/details/)



```sh

port install gitui

```



##### [Winget](https://github.com/microsoft/winget-pkgs/tree/master/manifests/s/StephanDilly/gitui) (Windows)



```

winget install gitui

```



##### [Scoop](https://github.com/ScoopInstaller/Main/blob/master/bucket/gitui.json) (Windows)



```

scoop install gitui

```



##### [Chocolatey](https://chocolatey.org/packages/gitui) (Windows)



```

choco install gitui

```



##### [Nix](https://search.nixos.org/packages?channel=unstable&show=gitui&from=0&size=50&sort=relevance&query=gitui) (Nix/NixOS)



Nixpkg

```

nix-env -iA nixpkgs.gitui

```

NixOS

```

nix-env -iA nixos.gitui

```



##### [Termux](https://github.com/termux/termux-packages/tree/master/packages/gitui) (Android)



```

pkg install gitui

```



##### [Anaconda](https://anaconda.org/conda-forge/gitui)

```

conda install -c conda-forge gitui 

```



### Release Binaries



[Available for download in releases](https://github.com/extrawurst/gitui/releases)



Binaries available for:



### Linux



- gitui-linux-musl.tar.gz (linux on x86_64)

- 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 (intel Mac, uses Rosetta on Apple silicon, single binary)



### Windows



- gitui-win.tar.gz (single 64bit binary)

- gitui.msi (64bit Installer package)



## 7.  Build [Top β–²](#table-of-contents)



### Requirements



- Minimum supported `rust`/`cargo` version: `1.65`

  - See [Install Rust](https://www.rust-lang.org/tools/install)



- 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 invokable 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`. If you are not familiar with rust and cargo: [Getting Started with Rust](https://doc.rust-lang.org/book/ch01-00-getting-started.html)

### Cargo Features

#### trace-libgit

enable `libgit2` tracing



works if `libgit2` builded with `-DENABLE_TRACE=ON`



this feature enabled by default, to disable: `cargo install --no-default-features`



## 8.  FAQs [Top β–²](#table-of-contents)



see [FAQs page](./FAQ.md)



## 9.  Diagnostics [Top β–²](#table-of-contents)



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 β–²](#table-of-contents)



![](assets/light-theme.png)



`gitui` should automatically work on both light and dark terminal themes.



However, you can customize everything to your liking: See [Themes](THEMES.md).



## 11.  Key Bindings [Top β–²](#table-of-contents)



The key bindings can be customized: See [Key Config](KEY_CONFIG.md) on how to set them to `vim`-like bindings.



## 12.  Sponsoring [Top β–²](#table-of-contents)



[![github](https://img.shields.io/badge/-GitHub%20Sponsors-fafbfc?logo=GitHub%20Sponsors)](https://github.com/sponsors/extrawurst)



## 13.  Inspiration [Top β–²](#table-of-contents)



- [lazygit](https://github.com/jesseduffield/lazygit)

- [tig](https://github.com/jonas/tig)

- [GitUp](https://github.com/git-up/GitUp)

  - It would be nice to come up with a way to have the map view available in a terminal tool

- [git-brunch](https://github.com/andys8/git-brunch)