https://github.com/0phoff/gitmux

git repository information in tmux environment variables
https://github.com/0phoff/gitmux

git statusbar tmux tpm-plugin

Last synced: about 1 year ago
JSON representation

git repository information in tmux environment variables

• Host: GitHub
• URL: https://github.com/0phoff/gitmux
• Owner: 0phoff
• Created: 2017-09-19T19:12:03.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2020-01-29T14:47:16.000Z (over 6 years ago)
• Last Synced: 2025-04-23T01:59:00.166Z (about 1 year ago)
• Topics: git, statusbar, tmux, tpm-plugin
• Language: Shell
• Size: 80.1 KB
• Stars: 10
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
GITMUX

======

This tmux plugin sets some tmux environment variables with information about the current git repository.  

It is based of [tmux-gitbar](https://github.com/aurelien-rainone/tmux-gitbar), but gives the user more freedom to create his own statusbar with the variables.

## Installation

Install this plugin with [tpm](https://github.com/tmux-plugins/tpm).

  > set -g @plugin '0phoff/gitmux'

## Usage

### Tmux

In your tmux config, you can use the following variables

  - __GITMUX_SCRIPT__         : Path to the update script _(This is a global tmux variable, access it with tmux showenv -g)_

  - __GITMUX_REPO__           : This value is non-zero if the current pane is in a git repository

  - __GITMUX_BRANCH__         : Name of the current branch

  - __GITMUX_REMOTE__         : Name of the tracking branch (0 if none)

  - __GITMUX_COMMITS_AHEAD__  : Number of commits the current branch is ahead of the remote tracking branch

  - __GITMUX_COMMITS_BEHIND__ : Number of commits the current branch is behind of the remote tracking branch

  - __GITMUX_STAGED__         : Number of files that are staged for the next commit

  - __GITMUX_CHANGED__        : Number of files that have changed since last commit (but not staged)

  - __GITMUX_UNTRACKED__      : Number of untracked files

  - __GITMUX_STASHED__        : Number of stashes

  - __GITMUX_CONFLICTS__      : Number of files with conflicts

  - __GITMUX_CLEAN__          : This value is 1 when there are no files untracked,changed or staged, no stashes and no conflicts

### Vim

If you want to update your statusbar whenever you save a file in Vim, add the following line to your vim config:

  > autocmd BufWritePost * silent! !eval $(tmux display -p "\#{GITMUX_SCRIPT}")

### Neovim

Alternative for neovim, that uses the jobcontrol feature to run the command asynchronously (and thus does not block the editor whilst running the command)

  > autocmd BufWritePost * silent! jobstart(['bash', '-c', 'eval $(tmux display -p "\#{GITMUX_SCRIPT}")'])

### Terminal

If you use the PROMPT_COMMAND variable in your terminal configuration, be sure to have it in this format:

  > PROMPT_COMMAND=" …your_functions_here… ;$PROMPT_COMMAND"

__NOTE:__  

Some distributions like ubuntu, reset the $PROMPT_COMMAND upon loading a terminal, which causes this plugin to fail.  

If the plugin does not seem to update when you enter a git repository check the files ``/etc/bash.bashrc`` and ``/etc/profile`` and all the files they source.  

Eg. for ubuntu, you need to comment out the following line, at the end of the file ``/etc/profile.d/vte-2.91.sh``:

```bash

[ -n "$BASH_VERSION" ] && PROMPT_COMMAND="__vte_prompt_command"

```

## Examples

Here is an example of how I use this plugin to show information on my status bar.

```tmux

# Shorted version, only important parts are shown

set -g status-right '#{?GITMUX_REPO,#[fg=red]#{GITMUX_UNTRACKED} #[fg=yellow]#{GITMUX_CHANGED} #[fg=green]●#{GITMUX_STAGED} #[fg=white] #[fg=green]↑#{GITMUX_COMMITS_AHEAD} #[fg=red]↓#{GITMUX_COMMITS_BEHIND} #[fg=white] ⎇ #{GITMUX_BRANCH} , }'

# Actual full version of the statusline I use

set -g status-right '#{?GITMUX_REPO,#[fg=brightblack]#[bg=black]#[fg=white]#[bg=brightblack] #[fg=red]#{GITMUX_UNTRACKED} #[fg=yellow]#{GITMUX_CHANGED} #[fg=green]●#{GITMUX_STAGED} #[fg=white] #[fg=green]↑#{GITMUX_COMMITS_AHEAD} #[fg=red]↓#{GITMUX_COMMITS_BEHIND} #[fg=white] #{?GITMUX_REMOTE,⎇ #{GITMUX_BRANCH},#[fg=red]⎇ #[fg=white]#{GITMUX_BRANCH}} #[fg=black], }#[fg=blue,bg=black]#[fg=black,bg=blue] #U  #H '

```

![Screenshot](docs/example.png)

## Contributing

Please report bugs and file issues with possible improvements.  

If you used this plugin, feel free to share the code and a screenshot of it, so I can add it to the README.