gitui/README.md
Stephan Dilly 8552269ed7 todo
2020-03-19 20:54:46 +01:00

35 lines
No EOL
1.1 KiB
Markdown

# gitui
blazing fast terminal-ui for git written in rust
![img](assets/main.jpg)
## 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](https://git-fork.com) because it was not bloated, snappy and free. Unfortunately the *free* part will [change soon](https://github.com/ForkIssues/TrackerWin/issues/571) and so I decided to build a fast & simple terminal tool myself to copy the fork features i am using the most.
# todo
* [x] (un)stage files
* [x] inspect diffs
* [x] commit
* [x] [input polling in thread](assets/perf_compare.jpg)
* [ ] support non-root git folder wd
* [ ] show content of new files
* [ ] indicate file status (modified,added,removed)
* [ ] discard untracked files (remove)
* [ ] use [notify](https://crates.io/crates/notify) to watch git
* [ ] log view
* [ ] stashing support
# resources (quick links)
* https://docs.rs/git2/
* https://libgit2.org
* https://docs.rs/tui/
* https://docs.rs/crossterm/
# alternatives
* https://github.com/jesseduffield/lazygit