mirror of
https://github.com/jesseduffield/lazygit.git
synced 2024-11-24 08:52:21 +02:00
122 lines
4.5 KiB
Markdown
122 lines
4.5 KiB
Markdown
# lazygit [](https://goreportcard.com/report/github.com/jesseduffield/lazygit)
|
|
|
|
A simple terminal UI for git commands, written in Go with the [gocui](https://github.com/jroimartin/gocui "gocui") library.
|
|
|
|
Are YOU tired of typing every git command directly into the terminal, but you're
|
|
too stubborn to use Sourcetree because you'll never forgive Atlassian for making
|
|
Jira? This is the app for you!
|
|
|
|
|
|
|
|
|
|
* [Installation](https://github.com/jesseduffield/lazygit#installation)
|
|
* [Usage](https://github.com/jesseduffield/lazygit#usage),
|
|
[Keybindings](https://github.com/jesseduffield/lazygit/blob/master/docs/Keybindings.md)
|
|
* [Cool Features](https://github.com/jesseduffield/lazygit#cool-features)
|
|
* [Contributing](https://github.com/jesseduffield/lazygit#contributing)
|
|
* [Video Tutorial](https://www.youtube.com/watch?v=VDXvbHZYeKY)
|
|
* [Twitch Stream](https://www.twitch.tv/jesseduffield)
|
|
|
|
## Installation
|
|
|
|
### Homebrew
|
|
```sh
|
|
brew tap jesseduffield/lazygit
|
|
brew install lazygit
|
|
```
|
|
|
|
### Ubuntu
|
|
Packages for Ubuntu 16.04, 18.04 and 18.10 are available via [Launchpad PPA](https://launchpad.net/~lazygit-team).
|
|
|
|
They are built daily, straight from master branch.
|
|
|
|
```sh
|
|
sudo add-apt-repository ppa:lazygit-team/daily
|
|
sudo apt-get update
|
|
sudo apt-get install lazygit
|
|
```
|
|
|
|
### Void Linux
|
|
Packages for Void Linux are available in the distro repo
|
|
|
|
They follow upstream latest releases
|
|
|
|
```sh
|
|
sudo xbps-install -S lazygit
|
|
```
|
|
|
|
### Arch Linux
|
|
Packages for Arch Linux are available via AUR (Arch User Repository).
|
|
|
|
There are two packages. The stable one which is built with the latest release
|
|
and the git version which builds from the most recent commit.
|
|
|
|
* Stable: https://aur.archlinux.org/packages/lazygit/
|
|
* Development: https://aur.archlinux.org/packages/lazygit-git/
|
|
|
|
Instruction of how to install AUR content can be found here:
|
|
https://wiki.archlinux.org/index.php/Arch_User_Repository
|
|
|
|
### Binary Release (Windows/Linux/OSX)
|
|
You can download a binary release [here](https://github.com/jesseduffield/lazygit/releases).
|
|
|
|
### Go
|
|
```sh
|
|
go get github.com/jesseduffield/lazygit
|
|
```
|
|
|
|
Please note:
|
|
If you get an error claiming that lazygit cannot be found or is not defined, you
|
|
may need to add `~/go/bin` to your $PATH (MacOS/Linux), or `%HOME%\go\bin`
|
|
(Windows). Not to be mistaked for `C:\Go\bin` (which is for Go's own binaries,
|
|
not apps like Lazygit).
|
|
|
|
## Usage
|
|
Call `lazygit` in your terminal inside a git repository. If you want, you can
|
|
also add an alias for this with `echo "alias lg='lazygit'" >> ~/.zshrc` (or
|
|
whichever rc file you're using).
|
|
|
|
* Basic video tutorial [here](https://www.youtube.com/watch?v=VDXvbHZYeKY).
|
|
* List of keybindings
|
|
[here](https://github.com/jesseduffield/lazygit/blob/master/docs/Keybindings.md).
|
|
|
|
## Cool features
|
|
* Adding files easily
|
|
* Resolving merge conflicts
|
|
* Easily check out recent branches
|
|
* Scroll through logs/diffs of branches/commits/stash
|
|
* Quick pushing/pulling
|
|
* Squash down and rename commits
|
|
|
|
### Resolving merge conflicts
|
|
|
|
|
|
### Viewing commit diffs
|
|
|
|
|
|
## Milestones
|
|
- [x] Easy Installation (homebrew, release binaries)
|
|
- [ ] Configurable Keybindings
|
|
- [ ] Configurable Color Themes
|
|
- [ ] Spawning Subprocesses (help needed - have a look at https://github.com/jesseduffield/lazygit/pull/18)
|
|
- [ ] Maintainability
|
|
- [ ] Performance
|
|
- [ ] i18n
|
|
|
|
## Contributing
|
|
We love your input! Please check out the [contributing guide](CONTRIBUTING.md).
|
|
For contributor discussion about things not better discussed here in the repo, join the slack channel
|
|
|
|
[](https://join.slack.com/t/lazygit/shared_invite/enQtNDE3MjIwNTYyMDA0LTM3Yjk3NzdiYzhhNTA1YjM4Y2M4MWNmNDBkOTI0YTE4YjQ1ZmI2YWRhZTgwNjg2YzhhYjg3NDBlMmQyMTI5N2M)
|
|
|
|
## Work in progress
|
|
This is still a work in progress so there's still bugs to iron out and as this
|
|
is my first project in Go the code could no doubt use an increase in quality,
|
|
but I'll be improving on it whenever I find the time. If you have any feedback
|
|
feel free to [raise an issue](https://github.com/jesseduffield/lazygit/issues)/[submit a PR](https://github.com/jesseduffield/lazygit/pulls).
|
|
|
|
## Social
|
|
If you want to see what I (Jesse) am up to in terms of development, follow me on
|
|
[twitter](https://twitter.com/DuffieldJesse) or watch me program on
|
|
[twitch](https://www.twitch.tv/jesseduffield).
|