gitui/README.md
2020-03-31 11:41:54 +02:00

2.3 KiB

gitui

CI crates MIT LOC UNSAFE

blazing fast terminal-ui for git written in rust

img

features

  • fast and intuitive key only control
  • context based help (no need to remember any hot-key)
  • inspect/commit changes
  • (un)stage files, revert/reset files
  • scalable ui layout
  • async input polling and
  • async git API for fluid control

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, therefore I do not distribute binary versions yet, however feel free to build gitui and let me know what you think!

requirements

install 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 to ~/.gitui/gitui.log:

GITUI_LOGGING=true gitui

todo for 0.1 (first release)

  • better help command
  • confirm destructive commands (revert/reset)
  • (un)staging selected hunks
  • publish as homebrew-tap

inspiration