Skip to content
Git in your tmux status bar
Go
Branch: master
Clone or download
arl Fix error check function (#15)
When current directory was not a Git working tree, git command
were failing, as expected. But a recent commit made a change in
the error check function, and the program was not exit anymore in
the event of an error. Instead it was continuing with a bogus
gitstatus varriable, leading to panics. Unless running in -dbg
mode, those panic had no effect whatsoever and gitmux was usable
as before. It's just that the program was silently crashing
instead of silently terminating.
Latest commit 57f0f80 Jan 6, 2020
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
format Sensible defaults (#11) Dec 24, 2019
.goreleaser.yml releases: place only the binary in the archives Nov 7, 2019
.travis.yml ci: cache downloaded go modules Nov 7, 2019
LICENSE Initial commit Oct 28, 2019
README.md Update README.md (#13) Jan 6, 2020
formater.go Update to gitstatus@v0.4.1 (#4) Nov 6, 2019
gitmux.go
go.mod Issue 9/add git no optional lock (#10) Dec 17, 2019
go.sum update go.sum Dec 17, 2019

README.md

Gitmux shows git status in your tmux status bar


travis-ci goreport

demo

  • easy. Install it once and forget about it
  • minimal. Only show what you need when you need it
  • discrete. Disappear when current directory is not managed by Git
  • shell-independent. Work with sh, bash, zsh, fish, etc.
  • highly configurable. Colors and symbols can be customized
  • automatic. Information auto-updates with respect to the current working directory

Prerequisites

Works with all 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 to build and install gitmux:

go get -u github.com/arl/gitmux

Getting started

Add this line to your .tmux.conf:

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

Customizing

gitmux output can be customized via a configuration file in YAML format.

First, save the default configuration to a new file

gitmux -printcfg > .gitmux.conf

Open .gitmux.conf and modify it, replacing symbols and colors to suit your needs.
Ensure the file is valid by adding the -dbg flag

gitmux -dbg -cfg .gitmux.conf

Modify the line in .tmux.conf, passing the path of the configuration file as argument to gitmux

gitmux -cfg .gitmux.conf

gitmux configuration is split into 2 sections:

  • symbols: they are just strings of unicode characters
  • styles: they are tmux format strings (man tmux for reference)

Troubleshooting

Please report anything by filing an issue.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

License: MIT

You can’t perform that action at this time.