LazyGit Custom Commands and Keybindings: Extend Your Git TUI

Extending LazyGit with Commands

Go beyond the default LazyGit experience. Create custom commands, define your own keybindings, and build a git workflow tailored to your team's conventions.

LazyGit gives Git a visual interface in the terminal. Stage individual lines, resolve rebase conflicts visually, and never type git add -p again.

By the end of this 10 min guide, you'll have a working Lazygit setup and practical LazyGit workflows you can use immediately.

• Understand what Lazygit does and why it matters for Development
• Install and configure Lazygit for your environment
• Build LazyGit-specific workflows with real examples
• Troubleshoot common Lazygit issues with concrete fixes

Config File & Custom Command Syntax

Install Lazygit:

brew install lazygit

• Development environment with appropriate permissions
• No prior LazyGit experience needed
• A terminal with true color support
• Git for version-controlling your config

Writing Useful Custom Commands

Run lg in any repo. Five panels — Status, Files, Branches, Commits, Stash — with vim-style navigation. The bottom bar shows context-aware keys.

Here's a foundational configuration to start with:

# config.yml
gui:
mouseEvents: true
showIcons: true
customCommands:
- key: "C"
command: "git commit --amend --no-edit"
context: "files"

• Begin with this config and make small, incremental changes
• Document each setting with inline comments
• Test changes one at a time to isolate issues
• Keep your config in a Git repo for easy rollback and sharing

Keybinding Customization

With Lazygit configured, these LazyGit-specific workflows will save you time every day:

• Space stage/unstage files or hunks
• c commit with editor
• Enter view diff or commit details
• p pull, P push
• e edit hunks before staging

Integration with Shell Scripts

Once you're comfortable with Lazygit basics, these advanced techniques will transform your LazyGit workflow:

• Custom commands with {{.SelectedFile.Name}} context
• Interactive rebase without memorizing commands
• Stash management: S stash, Shift+S pop
• Configurable keybindings per panel context

Command Errors & Recovery

Here are the most common Lazygit issues and how to fix them:

• No mouse? Set gui: mouseEvents: true
• Can't edit message? Ensure $EDITOR is set
• Rebase gone wrong? git rebase --abort outside LazyGit
• Colors wrong? Set terminal to 256-color mode

Your Custom Git Stack

Congratulations — you now have a solid Lazygit foundation. Here's where to go next:

• Explore the official Lazygit documentation for features not covered here
• Join the LazyGit community (GitHub Discussions, Discord, or Reddit)
• Check the related tutorials below for deeper LazyGit dives
• Build your own Lazygit configuration and share it with the community