GitButler ⧓

GuidesCLI Tutorial

Configuration and Aliases

How to customize your GitButler CLI experience

We've already covered but config a bit in dealing with forges and target branches.

You can also use it for some basic user configuration, such as setting your name and email address for commits and your default editor.

$ but config user

User Configuration:

    Name: Scott Chacon (global)
   Email: schacon@gmail.com (global)
  Editor: nvim (global)

To set values:
  but config user set name "Your Name"
  but config user set --global email your@email.com

Aliases

GitButler also has a built in aliasing system in case you want to provide some shorthands.

$ but alias
User aliases:

  stf        status -f (local)
  stfu       status -f -u (local)

Default aliases (overridable):

  default    status
  st         status
  stf        status --files  (overridden)

To add a new alias, you can run but alias add <alias> <expansion>, which you can also provide a -g or --global if you want it to be a global alias. This will put this data in your local or global Git config file.

You will notice that there is a default alias, which is what runs when you just run but with no arguments. If you overwrite the default alias, you can set up something other than status to run by default.

Last updated on

On this page

Edit on GitHubGive us feedback