tmux/arl.gitmux
1
0
Fork 0
mirror of https://github.com/arl/gitmux.git synced 2026-09-10 07:26:18 -04:00
Code Issues Actions Packages Projects Releases Wiki Activity
Author: "Gitmux shows git status in your tmux status bar"
16 commits 3 branches 36 tags 1.9 MiB
Go 95.8%
Shell 4.2%
Go to file
Aurélien Rainone d826bfc431
Update README.md (#13) 
* .github: add ISSUE_TEMPLATE.md

* Update README.md

Fixes #3

* Improve README
2020-01-06 18:51:00 +01:00
.github Update README.md (#13) 2020-01-06 18:51:00 +01:00
format Sensible defaults (#11) 2019-12-24 01:05:17 +01:00
.goreleaser.yml releases: place only the binary in the archives 2019-11-07 10:03:30 +01:00
.travis.yml ci: cache downloaded go modules 2019-11-07 10:08:59 +01:00
formater.go Update to gitstatus@v0.4.1 (#4) 2019-11-06 23:13:46 +01:00
gitmux.go Sensible defaults (#11) 2019-12-24 01:05:17 +01:00
go.mod Issue 9/add git no optional lock (#10) 2019-12-17 10:12:45 +01:00
go.sum update go.sum 2019-12-17 10:56:22 +01:00
LICENSE Initial commit 2019-10-28 08:38:41 +01:00
README.md Update README.md (#13) 2020-01-06 18:51:00 +01:00

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