Skip to content
Get packs

Guide · Open source

How to use lazygit: a terminal UI for git, step by step

Updated · written with AI from the project's own documentation and checked against our catalogue data

Lazygit is a simple terminal user interface (TUI) for git, the version control system used to track changes in code. Instead of typing git commands one at a time, you work through keyboard-driven panels to view status, stage changes, commit and push. This guide explains what you need, how to get the project, and what kinds of work it suits, so you can decide whether it fits your workflow.

lazygitjesseduffield/lazygit · ★ 83.6k · MIT

Quick start

  1. 1Check git is installed. Lazygit requires git. Confirm git is available on your system before anything else.
  2. 2Get the project. Clone the repository from GitHub or use a package manager, following the current instructions in the README.
  3. 3Open a terminal in a repository. Lazygit works on a git repository, so move into the project folder you want to manage.
  4. 4Review status. Use the panels to see which files have changed and what is staged.
  5. 5Stage and commit. Choose the changes you want, stage them, and write a commit.
  6. 6Push. Push the commit to its remote from the same interface.

What lazygit is and what you need first

Lazygit wraps git operations in a terminal interface. The project's README describes it simply as a terminal UI for git commands. It is licensed under MIT and written in Go.

The only prerequisite listed in the source is git itself. Lazygit exposes git operations directly, so you should already understand basic git concepts such as changes, staging and commits.

  • Requires: git
  • Runs in: a terminal (it is not a graphical desktop app)
  • Licence: MIT
  • Language: Go

Get lazygit onto your machine

The README's install instructions show how to clone the repository from GitHub. The project's listing describes the install method as a package manager. The README also links a Homebrew formula badge, so check the project's README for the current package-manager instructions for your system.

Clone the repository with the command below if you want the source from GitHub.

git clone https://github.com/jesseduffield/lazygit

Use the panels to check status, stage and commit

Lazygit shows your repository in keyboard-driven panels. You use them to view status, choose which changes to stage, and write a commit, instead of typing each git command by hand.

The demo in the README shows a commit and push flow, which is the core loop the tool is built around.

  • View the status of your repository in one place
  • Stage the changes you want to include
  • Commit the staged changes
  • Push the commit to its remote

Know when lazygit fits your workflow

Lazygit suits developers who already use git from the command line and want a faster overview of a repository. It also suits people who prefer working in a terminal rather than a graphical app.

It is less suited to people new to git, since it does not hide git concepts. It is also not a fit if you need a desktop GUI or work mainly inside an IDE, because it runs only in a terminal. The README does not describe pull request or issue workflows on hosting platforms, so do not assume those are supported.

Compare lazygit with similar tools

The projects most often compared with lazygit are gitui, tig and GitHub Desktop. Each takes a different approach to working with git.

Choose by your preference: lazygit and gitui are terminal tools, tig is also a terminal tool, and GitHub Desktop is a graphical app.

  • gitui: another terminal interface for git
  • tig: a text-mode interface for git
  • GitHub Desktop: a graphical desktop app

What people use it for

  • Reviewing what has changed in a repository before committing
  • Staging only some of your changes without memorizing git flags
  • Committing and pushing from a terminal session without switching to a GUI
  • Getting a faster overview of a repository you already work in with git

Frequently asked questions

Is lazygit free?

The project is released under the MIT licence, as listed in its details. MIT is a permissive open-source licence, so check the repository's licence file for the exact terms.

What do I need to run lazygit?

The source lists git as the prerequisite. Lazygit runs in a terminal, so you need a terminal and a git repository to work with.

Is lazygit a good choice for beginners to git?

The README does not position it as a learning tool. Lazygit exposes git operations directly, so it is better suited to people who already know basic git concepts.

Does lazygit have a graphical version?

No. Lazygit runs only in a terminal, so if you need a graphical desktop app, a tool such as GitHub Desktop may suit you better.

How does lazygit compare with gitui or tig?

All three are terminal-based interfaces for git. Lazygit is a simple TUI built around panels for status, staging, committing and pushing, while gitui and tig are separate projects with their own approaches.

Does lazygit support pull requests and issues?

The README does not describe pull request or issue workflows as supported, so do not rely on them. Use your hosting platform for those tasks.

New agent skills, repos and AI tools — every week

The best new skills and open-source projects, the fastest-growing repos, and one free prompt. Five minutes to read. Unsubscribe anytime.

Our verdict

Lazygit is a good fit for developers who already use git and prefer a fast, keyboard-driven terminal view for staging, committing and pushing. It is a poor fit for people still learning git, for anyone who needs a graphical app or IDE integration, or for teams who depend on hosting-platform features the README does not cover.

Install options & downloads