github.com/andrewrech/lazygit@v0.8.1/README.md (about)

     1  # lazygit [![CircleCI](https://circleci.com/gh/jesseduffield/lazygit.svg?style=svg)](https://circleci.com/gh/jesseduffield/lazygit) [![codecov](https://codecov.io/gh/jesseduffield/lazygit/branch/master/graph/badge.svg)](https://codecov.io/gh/jesseduffield/lazygit) [![Go Report Card](https://goreportcard.com/badge/github.com/jesseduffield/lazygit)](https://goreportcard.com/report/github.com/jesseduffield/lazygit) [![GolangCI](https://golangci.com/badges/github.com/jesseduffield/lazygit.svg)](https://golangci.com) [![GoDoc](https://godoc.org/github.com/jesseduffield/lazygit?status.svg)](http://godoc.org/github.com/jesseduffield/lazygit) [![GitHub tag](https://img.shields.io/github/tag/jesseduffield/lazygit.svg)]()
     2  
     3  A simple terminal UI for git commands, written in Go with the [gocui](https://github.com/jroimartin/gocui 'gocui') library.
     4  
     5  Are YOU tired of typing every git command directly into the terminal, but you're
     6  too stubborn to use Sourcetree because you'll never forgive Atlassian for making
     7  Jira? This is the app for you!
     8  
     9  ![Gif](/docs/resources/lazygit-example.gif)
    10  
    11  - [Installation](https://github.com/jesseduffield/lazygit#installation)
    12  - [Usage](https://github.com/jesseduffield/lazygit#usage),
    13    [Keybindings](/docs/keybindings)
    14  - [Cool Features](https://github.com/jesseduffield/lazygit#cool-features)
    15  - [Contributing](https://github.com/jesseduffield/lazygit#contributing)
    16  - [Video Tutorial](https://youtu.be/VDXvbHZYeKY)
    17  - [Twitch Stream](https://www.twitch.tv/jesseduffield)
    18  
    19  ## Installation
    20  
    21  ### Homebrew
    22  
    23  ```sh
    24  brew install lazygit
    25  ```
    26  
    27  ### Ubuntu
    28  
    29  Packages for Ubuntu 16.04, 18.04 and 18.10 are available via [Launchpad PPA](https://launchpad.net/~lazygit-team).
    30  
    31  **Release builds**
    32  
    33  Built from git tags. Supposed to be more stable.
    34  
    35  ```sh
    36  sudo add-apt-repository ppa:lazygit-team/release
    37  sudo apt-get update
    38  sudo apt-get install lazygit
    39  ```
    40  
    41  **Daily builds**
    42  
    43  Built from master branch once in 24 hours (or more sometimes).
    44  
    45  ```sh
    46  sudo add-apt-repository ppa:lazygit-team/daily
    47  sudo apt-get update
    48  sudo apt-get install lazygit
    49  ```
    50  
    51  ### Void Linux
    52  
    53  Packages for Void Linux are available in the distro repo
    54  
    55  They follow upstream latest releases
    56  
    57  ```sh
    58  sudo xbps-install -S lazygit
    59  ```
    60  
    61  ### Arch Linux
    62  
    63  Packages for Arch Linux are available via AUR (Arch User Repository).
    64  
    65  There are two packages. The stable one which is built with the latest release
    66  and the git version which builds from the most recent commit.
    67  
    68  - Stable: https://aur.archlinux.org/packages/lazygit/
    69  - Development: https://aur.archlinux.org/packages/lazygit-git/
    70  
    71  Instruction of how to install AUR content can be found here:
    72  https://wiki.archlinux.org/index.php/Arch_User_Repository
    73  
    74  ### Conda
    75  
    76  Released versions are available for different platforms, see https://anaconda.org/conda-forge/lazygit
    77  
    78  ```sh
    79  conda install -c conda-forge lazygit
    80  ```
    81  
    82  ### Binary Release (Windows/Linux/OSX)
    83  
    84  You can download a binary release [here](https://github.com/jesseduffield/lazygit/releases).
    85  
    86  ### Go
    87  
    88  ```sh
    89  go get github.com/jesseduffield/lazygit
    90  ```
    91  
    92  Please note:
    93  If you get an error claiming that lazygit cannot be found or is not defined, you
    94  may need to add `~/go/bin` to your \$PATH (MacOS/Linux), or `%HOME%\go\bin`
    95  (Windows). Not to be mistaked for `C:\Go\bin` (which is for Go's own binaries,
    96  not apps like Lazygit).
    97  
    98  ## Usage
    99  
   100  Call `lazygit` in your terminal inside a git repository. If you want, you can
   101  also add an alias for this with `echo "alias lg='lazygit'" >> ~/.zshrc` (or
   102  whichever rc file you're using).
   103  
   104  - Basic video tutorial [here](https://youtu.be/VDXvbHZYeKY).
   105  - List of keybindings
   106    [here](/docs/keybindings).
   107  
   108  ## Cool features
   109  
   110  - Adding files easily
   111  - Resolving merge conflicts
   112  - Easily check out recent branches
   113  - Scroll through logs/diffs of branches/commits/stash
   114  - Quick pushing/pulling
   115  - Squash down and rename commits
   116  
   117  ### Resolving merge conflicts
   118  
   119  ![Gif](/docs/resources/resolving-merge-conflicts.gif)
   120  
   121  ### Interactive Rebasing
   122  
   123  ![Interactive Rebasing](/docs/resources/interactive-rebase.png)
   124  
   125  ## Contributing
   126  
   127  We love your input! Please check out the [contributing guide](CONTRIBUTING.md).
   128  For contributor discussion about things not better discussed here in the repo, join the slack channel
   129  
   130  [![Slack](/docs/resources/slack_rgb.png)](https://join.slack.com/t/lazygit/shared_invite/enQtNDE3MjIwNTYyMDA0LTM3Yjk3NzdiYzhhNTA1YjM4Y2M4MWNmNDBkOTI0YTE4YjQ1ZmI2YWRhZTgwNjg2YzhhYjg3NDBlMmQyMTI5N2M)
   131  
   132  ## Donate
   133  
   134  If you would like to support the development of lazygit, please donate
   135  
   136  [![Donate](https://d1iczxrky3cnb2.cloudfront.net/button-medium-blue.png)](https://donorbox.org/lazygit)
   137  
   138  ## Work in progress
   139  
   140  This is still a work in progress so there's still bugs to iron out and as this
   141  is my first project in Go the code could no doubt use an increase in quality,
   142  but I'll be improving on it whenever I find the time. If you have any feedback
   143  feel free to [raise an issue](https://github.com/jesseduffield/lazygit/issues)/[submit a PR](https://github.com/jesseduffield/lazygit/pulls).
   144  
   145  ## Social
   146  
   147  If you want to see what I (Jesse) am up to in terms of development, follow me on
   148  [twitter](https://twitter.com/DuffieldJesse) or watch me program on
   149  [twitch](https://www.twitch.tv/jesseduffield).
   150  
   151  ## Alternatives
   152  
   153  If you find that lazygit doesn't quite satisfy your requirements, these may be a better fit:
   154  
   155  - [tig](https://github.com/jonas/tig)