Gitmux shows git status in your tmux status bar

• easy. Install and forget about it
• minimal. Just shows what you need, when you need it
• discrete. Get out of your way if current directory is not in a Git tree
• shell-agnostic. Does not rely on shell-features so works with all of them
• customizable. Colors, symbols and layout are configurable

Prerequisites

Works with all decently recent tmux versions.

Installing

Binary release

Download the latest binary for your platform/architecture and uncompress it.

From source

Download and install a Go compiler (Go 1.10 or later). Run

go get

gitmux

go get -u github.com/arl/gitmux

Getting started

If your

tmux

pane_current_path

.tmux.conf

set -g status-right '#(gitmux "#{pane_current_path}")'

If your

tmux

pane_current_path

gitmux

Note that

tmux v2.1

Customizing

gitmux

The gitmux configuration file is in YAML format.

tmux:
  symbols:
    branch: '⎇ '
    hashprefix: ':'
    ahead: ↑·
    behind: ↓·
    staged: '● '
    conflict: '✖ '
    modified: '✚ '
    untracked: '… '
    stashed: '⚑ '
    clean: ✔
  styles:
    clear: '#[fg=default]'
    state: '#[fg=red,bold]'
    branch: '#[fg=white,bold]'
    remote: '#[fg=cyan]'
    staged: '#[fg=green,bold]'
    conflict: '#[fg=red,bold]'
    modified: '#[fg=red,bold]'
    untracked: '#[fg=magenta,bold]'
    stashed: '#[fg=cyan,bold]'
    clean: '#[fg=green,bold]'
    divergence: "#[fg=yellow]"    
  layout: [branch, .., remote, " - ", flags]
  options:
    branch_max_len: 0

First, save the default configuration to a new file:

gitmux -printcfg > .gitmux.conf

Modify the line in

.tmux.conf

gitmux

gitmux -cfg .gitmux.conf

Open

.gitmux.conf

In

tmux

gitmux

gitmux

symbols

styles

layout

gitmux

options

Symbols

The

symbols

gitmux

  symbols:
    branch: '⎇ '      # Shown before a branch
    hashprefix: ':'    # Shown before a Git hash (in 'detached HEAD' state)
    ahead: ↑·          # Shown before the 'ahead count' when local and remote branch diverge
    behind: ↓·         # Shown before the 'behind count' when local/remote branch diverge
    staged: '● '       # Shown before the 'staged' files count
    conflict: '✖ '     # Shown before the 'conflicts' count
    modified: '✚ '     # Shown before the 'modified' files count
    untracked: '… '    # Shown before the 'untracked' files count
    stashed: '⚑ '      # Shown before the 'stash' count
    clean: ✔           # Shown when the working tree is clean (empty staging area)

Styles

Styles are tmux format strings used to specify text colors and attributes. See

tmux

  styles:
    clear: '#[fg=default]'          # Style clearing previous styles (printed before each component)
    state: '#[fg=red,bold]'         # Style of the special states strings like [rebase], [merge], etc.
    branch: '#[fg=white,bold]'      # Style of the local branch name
    remote: '#[fg=cyan]'            # Style of the remote branch name
    divergence: "#[fg=yellow]"      # Style of the 'divergence' string
    staged: '#[fg=green,bold]'      # Style of the 'staged' files count
    conflict: '#[fg=red,bold]'      # Style of the 'conflicts' count
    modified: '#[fg=red,bold]'      # Style of the 'modified' files count
    untracked: '#[fg=magenta,bold]' # Style of the 'modified' files count
    stashed: '#[fg=cyan,bold]'      # Style of the 'stash' entries count
    clean: '#[fg=green,bold]'       # Style of the 'clean' symbol

Layout components

The layout is a list of the components

gitmux

tmux

For example, the default

gitmux

layout: [branch, .., remote-branch, divergence, " - ", flags]

It shows, in that order: - the local branch name, - 2 dots characters

..

-

Note that elements only appear when they make sense, for example if local and remote branch are aligned, the divergence string won't show up. Same thing for the remote branch, etc.

But you can anyway choose to never show some components if you wish, or to present them in a different order.

This is the list of the possible components of the

layout

| Layout component | Description | Example | | :--------------: | :------------------------------------------------- | :------------------: | |

branch

main

remote-branch

origin/main

divergence

↓·2↑·1

remote

remote-branch

divergence

origin/main ↓·2↑·1

flags

✚ 1 ⚑ 1 … 2

foo

foo

Some example layouts:

• default layout:

layout: [branch, .., remote-branch, divergence, " - ", flags]

• some more minimal layouts:

layout: [branch, divergence, " - ", flags]

layout: [flags, " ", branch]

Additional options

This is the list of additional configuration

options

| Option | Description | Default | | :--------------- | :--------------------------------------------------------- | :------------- | |

branch_max_len

0

Troubleshooting

Please report anything by filing an issue.

Contributing

Pull requests are welcome.
For major changes, please open an issue first to open a discussion.

License: MIT