https://github.com/kristijanhusak/tmux-simple-git-status

Add simple git status to your tmux statusline.
https://github.com/kristijanhusak/tmux-simple-git-status

Last synced: 12 days ago
JSON representation

Add simple git status to your tmux statusline.

• Host: GitHub
• URL: https://github.com/kristijanhusak/tmux-simple-git-status
• Owner: kristijanhusak
• License: mit
• Created: 2018-05-08T09:59:26.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2020-11-15T10:33:02.000Z (almost 4 years ago)
• Last Synced: 2024-10-04T12:49:41.536Z (about 1 month ago)
• Language: Shell
• Size: 6.84 KB
• Stars: 27
• Watchers: 3
• Forks: 9
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-tmux - tmux-simple-git-status

README

        
# Tmux simple git status

Prints current pane git branch and uncommitted changes (if available).

![screenshot](https://i.imgur.com/SzOftNt.png)

## Installation

### Installation with [Tmux Plugin Manager](https://github.com/tmux-plugins/tpm) (recommended)

Add plugin to the list of TPM plugins in `.tmux.conf`:

    set -g @plugin 'kristijanhusak/tmux-simple-git-status'

Add `#{simple_git_status}` to your `status-left` or `status-right` tmux option:

```

set -g status-left "#{simple_git_status}"

```

Hit `prefix + I` to fetch the plugin and source it.

### Manual Installation

Clone the repo:

    $ git clone https://github.com/kristijanhusak/tmux-simple-git-status ~/clone/path

Add this line to the bottom of `.tmux.conf`:

    run-shell ~/clone/path/simple_git_status.tmux

Add `#{simple_git_status}` to your `status-left` or `status-right` tmux option:

```

set -g status-left "#{simple_git_status}"

```

Reload TMUX environment:

    $ tmux source-file ~/.tmux.conf

## FAQ

*Q: Status is not updating in real time.*

A: Frequency of update depends on tmux `status-interval` option. To refresh the status every 5 seconds, add `set -g status-interval 5` to your `.tmux.conf`

*Q: There is a space before and after the status.*

A: Those are added in order to allow easier styling and highlighting (like on screenshot). If you would add an empty space by yourself, you would get empty blocks in your statusline that doesn't hold anything. If you really want it to be removed, please file an issue.