Custom_Command_Keybindings.md

Custom Command Keybindings

You can add custom command keybindings in your config.yml (accessible by pressing 'o' on the status panel from within lazygit) like so:

customCommands:
  - key: '<c-r>'
    command: 'hub browse -- "commit/{{.SelectedLocalCommit.Sha}}"'
    context: 'commits'
  - key: 'a'
    command: "git {{if .SelectedFile.HasUnstagedChanges}} add {{else}} reset {{end}} {{.SelectedFile.Name}}"
    context: 'files'
    description: 'toggle file staged'
  - key: 'C'
    command: "git commit"
    context: 'global'
    subprocess: true
  - key: 'n'
    prompts:
      - type: 'menu'
        title: 'What kind of branch is it?'
        options:
          - name: 'feature'
            description: 'a feature branch'
            value: 'feature'
          - name: 'hotfix'
            description: 'a hotfix branch'
            value: 'hotfix'
          - name: 'release'
            description: 'a release branch'
            value: 'release'
      - type: 'input'
        title: 'What is the new branch name?'
        initialValue: ''
    command: "git flow {{index .PromptResponses 0}} start {{index .PromptResponses 1}}"
    context: 'localBranches'
    loadingText: 'creating branch'

Looking at the command assigned to the 'n' key, here's what the result looks like:

Custom command keybindings will appear alongside inbuilt keybindings when you view the options menu by pressing 'x':

For a given custom command, here are the allowed fields:

field	description	required
key	the key to trigger the command. Use a single letter or one of the values from here	yes
command	the command to run	yes
context	the context in which to listen for the key (see below)	yes
subprocess	whether you want the command to run in a subprocess (necessary if you want to view the output of the command or provide user input)	no
prompts	a list of prompts that will request user input before running the final command	no
loadingText	text to display while waiting for command to finish	no
description	text to display in the keybindings menu that appears when you press 'x'	no

Contexts

The permitted contexts are:

context	description
status	the 'Status' tab
files	the 'Files' tab
localBranches	the 'Local Branches' tab
remotes	the 'Remotes' tab
remoteBranches	the context you get when pressing enter on a remote in the remotes tab
tags	the 'Tags' tab
commits	the 'Commits' tab
reflogCommits	the 'Reflog' tab
subCommits	the context you see when pressing enter on a branch
commitFiles	the context you see when pressing enter on a commit or stash entry (warning, might be renamed in future)
stash	the 'Stash' tab
global	this keybinding will take affect everywhere

Prompts

The permitted prompt fields are:

field	description	required
type	one of 'input' or 'menu'	yes
title	the title to display in the popup panel	no
initialValue	(only applicable to 'input' prompts) the initial value to appear in the text box	no
options	(only applicable to 'menu' prompts) the options to display in the menu	no

The permitted option fields are:

field	description	required
name	the string which will appear first on the line	no
description	the string which will appear second on the line	no
value	the value that will be stored in .PromptResponses if the option is selected	yes

If an option has no name the value will be displayed to the user in place of the name, so you're allowed to only include the value like so:

    prompts:
      - type: 'menu'
        title: 'What kind of branch is it?'
        options:
          - value: 'feature'
          - value: 'hotfix'
          - value: 'release'

Placeholder values

Your commands can contain placeholder strings using Go's template syntax. The template syntax is pretty powerful, letting you do things like conditionals if you want, but for the most part you'll simply want to be accessing the fields on the following objects:

SelectedLocalCommit
SelectedReflogCommit
SelectedSubCommit
SelectedFile
SelectedLocalBranch
SelectedRemoteBranch
SelectedRemote
SelectedTag
SelectedStashEntry
SelectedCommitFile
CheckedOutBranch

To see what fields are available on e.g. the SelectedFile, see here (all the modelling lives in the same directory). Note that the custom commands feature does not guarantee backwards compatibility (until we hit lazygit version 1.0 of course) which means a field you're accessing on an object may no longer be available from one release to the next. Typically however, all you'll need is {{.SelectedFile.Name}}, {{.SelectedLocalCommit.Sha}} and {{.SelectedBranch.Name}}. In the future we will likely introduce a tighter interface that exposes a limited set of fields for each model.

Keybinding collisions

If your custom keybinding collides with an inbuilt keybinding that is defined for the same context, only the custom keybinding will be executed. This also applies to the global context. However, one caveat is that if you have a custom keybinding defined on the global context for some key, and there is an in-built keybinding defined for the same key and for a specific context (say the 'files' context), then the in-built keybinding will take precedence. See how to change in-built keybindings here

Debugging

If you want to verify that your command actually does what you expect, you can wrap it in an 'echo' call and set subprocess: true so that it doesn't actually execute the command but you can see how the placeholders were resolved. Alternatively you can run lazygit in debug mode with lazygit --debug and in another terminal window run lazygit --logs to see which commands are actually run

More Examples

See the wiki page for more examples, and feel free to add your own custom commands to this page so others can benefit!