2020-03-19 03:36:27 +03:00
# gitui
2020-03-23 16:59:46 +03:00
2020-03-26 19:34:51 +03:00
![CI][s0] [![crates][s1]][l1] ![MIT][s2] [![LOC][s3]][l3]
2020-03-24 23:40:19 +03:00
2020-03-26 19:34:51 +03:00
[s0]: https://github.com/extrawurst/gitui/workflows/CI/badge.svg
2020-03-24 23:40:19 +03:00
[s1]: https://img.shields.io/crates/v/gitui.svg
[l1]: https://crates.io/crates/gitui
2020-03-23 16:59:46 +03:00
[s2]: https://img.shields.io/badge/license-MIT-blue.svg
2020-03-26 19:34:51 +03:00
[s3]: https://tokei.rs/b1/github/extrawurst/gitui
[l3]: https://github.com/extrawurst/gitui
2020-03-23 16:59:46 +03:00
2020-03-18 13:40:54 +03:00
blazing fast terminal-ui for git written in rust
2020-03-16 19:20:28 +03:00
2020-03-23 16:30:13 +03:00
2020-03-18 02:58:31 +03:00
2020-03-23 17:16:54 +03:00
## features
2020-03-24 11:58:43 +03:00
* fast key only control
2020-03-23 17:16:54 +03:00
* inspect changes
* (un)stage files
2020-03-24 11:55:51 +03:00
* revert/reset files
* commit changes
2020-03-27 03:55:26 +03:00
* scalable ui layout
2020-03-23 17:16:54 +03:00
* async [input polling ](assets/perf_compare.jpg ) and
* async git API for fluid control
2020-03-18 02:58:31 +03:00
## motivation
2020-03-19 19:59:31 +03:00
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.
2020-03-18 02:23:06 +03:00
2020-03-20 04:12:19 +03:00
## installation
2020-03-20 12:37:35 +03:00
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
2020-03-24 23:34:11 +03:00
### cargo install
2020-03-24 23:57:25 +03:00
the simplest way to start playing around with `gitui` is to have `cargo` build/install it:
2020-03-20 04:12:19 +03:00
```
2020-03-24 23:57:25 +03:00
cargo install gitui
2020-03-20 04:12:19 +03:00
```
2020-03-24 23:57:25 +03:00
### diagnostics:
2020-03-20 04:12:19 +03:00
2020-03-24 23:57:25 +03:00
to enable logging to `~/.gitui/gitui.log` :
2020-03-20 04:12:19 +03:00
```
2020-03-24 23:57:25 +03:00
GITUI_LOGGING=true gitui
2020-03-20 04:12:19 +03:00
```
2020-03-23 17:16:54 +03:00
# todo for 0.1 (first release)
2020-03-16 19:20:28 +03:00
2020-03-27 01:45:57 +03:00
* [ ] fix: diff broken at end of file
2020-03-26 15:26:51 +03:00
* [ ] fix: reset unstaged file also resets staged hunks
2020-03-24 20:02:58 +03:00
* [ ] better help command
2020-03-24 23:57:25 +03:00
* [ ] -> fix: dont show scroll option when any popup open
2020-03-24 13:07:27 +03:00
* [ ] confirm destructive commands (revert/reset)
2020-03-19 23:56:59 +03:00
* [ ] (un)staging selected hunks
2020-03-23 17:16:54 +03:00
* [ ] publish as homebrew-tap
2020-03-16 20:25:53 +03:00
2020-03-25 15:02:09 +03:00
# inspiration
2020-03-18 02:58:31 +03:00
2020-03-25 15:02:09 +03:00
* https://github.com/jesseduffield/lazygit
2020-03-25 18:00:03 +03:00
* https://github.com/jonas/tig
2020-03-25 15:02:09 +03:00
* https://github.com/git-up/GitUp (would be nice to comeup with a way to have the map view available in a terminal tool)
