extrawurst/gitui
1
1
Fork 0
mirror of https://github.com/extrawurst/gitui.git synced 2024-11-27 10:15:07 +03:00
Code Issues Projects Releases Wiki Activity
Blazing 💥 fast terminal-ui for git written in rust 🦀
622 Commits 13 Branches 61 Tags 91 MiB
Rust 99.7%
Makefile 0.3%
e445933abc
Go to file
Stephan Dilly e445933abc new demo gif
2020-06-15 12:17:28 +02:00
.github cleanup 2020-06-06 19:44:57 +02:00
.vscode Move status tab into its own component 2020-05-11 17:20:34 +02:00
assets new demo gif 2020-06-15 12:17:28 +02:00
asyncgit fix reset hunk in untracked file 2020-06-14 23:34:54 +02:00
scopetime chore: Add LICENSE file into the sub-crates 2020-05-28 16:11:54 +02:00
src Fix textinput cursor was not reset after msg.clear 2020-06-15 12:09:22 +02:00
.gitignore Replace unwrap calls in asyncgit with error handling - closes #53 2020-05-15 15:15:26 +02:00
Cargo.lock uprade libgit to fix reset of folder 2020-06-12 13:14:42 +02:00
Cargo.toml version bump 2020-06-09 18:06:56 +02:00
CHANGELOG.md changelog 2020-06-15 01:39:42 +02:00
LICENSE.md add license 2020-03-16 15:42:56 +01:00
Makefile print bundled size after build 2020-06-15 02:25:18 +02:00
README.md more features 2020-06-13 02:16:06 +02:00
rustfmt.toml formating to shorter lines 2020-03-18 15:14:13 +01:00
THEMES.md Move config directory 2020-06-15 01:36:13 +02:00

README.md

CI crates MIT UNSAFE ITCH

blazing fast terminal-ui for git written in rust

features

  • fast and intuitive key only control
  • context based help (no need to remember tons of hot-keys)
  • inspect/commit/amend changes (incl. hooks: commit-msg/post-commit)
  • (un)stage files/hunks, revert/reset files/hunk
  • stashing (save, apply, drop, inspect content)
  • browse commit log, diff committed changes
  • scalable terminal ui layout
  • async input polling and
  • async git API for fluid control

benchmarks

For a RustBerlin meetup presentation I compared lazygit,tig and gitui parsing the entire linux git repository (~900k commits):

lazygit tig gitui
time 57s 4m 20s 24s
mem 2.6 gb 1.3 gb 170 mb
binary 16 mb 600 kb 1.4 mb
freezes yes soso no
crashes sometimes no no

presentation slides: https://github.com/extrawurst/gitui-presentation

known limitations

motivation

I do most of my git usage in a terminal but I frequently found myself using git UIs for some use cases like: index/commit, diff, stash and log.

Over the last 2 years my go-to GUI tool for this was fork because it was not bloated, snappy and free. Unfortunately the free part will change soon and so I decided to build a fast & simple terminal tool myself to copy the fork features i am using the most.

installation

For the time being this product is considered alpha and not production ready.

Arch Linux

There is an AUR package for gitui:

git clone https://aur.archlinux.org/gitui.git
cd gitui
makepkg -si

Fedora

sudo dnf install gitui

homebrew (macos)

brew install extrawurst/tap/gitui

release binaries

see releases

install from source

requirements

install latest rust/cargo: https://www.rust-lang.org/tools/install

cargo install

the simplest way to start playing around with gitui is to have cargo build/install it:

cargo install gitui

diagnostics

to enable logging:

gitui -l

this will log to:

  • $HOME/Library/Caches/gitui/gitui.log (mac)
  • $XDG_CACHE_HOME/gitui/gitui.log (linux using XDG)
  • $HOME/.cache/gitui/gitui.log (linux)

color theme

In general gitui should automatically work on dark and light terminal themes. However you can customize everything to your liking: see THEMES.md

inspiration