tmux-gruvbox

Gruvbox color scheme for Tmux.

GPL-3.0 License

Stars
502

Theme with 'retro groove' flavor for Tmux, based on Pavel Pertsev's gruvbox colorscheme and inspired by work of Gordon Chiam. Subthemes switching inspired by tmux-color-solarized.

Screenshot made from macOS alacritty terminal with xterm-256color and Hack Nerd Font Regular. Backgrounds by Aleksandar Pasaric and Vishnu Murali.

Installation

Available Themes

  • dark
  • light
  • dark-transparent (experimental)
  • light-transparent (experimental)

Install manually

The simplest way is just:

[!TIP] Always make a backup of your config files before any action.

cat tmux-gruvbox-dark.conf >> ~/.tmux.conf

Install through Tmux Plugin Manager

Add plugin to the list of TPM plugins in .tmux.conf and select desired theme.

set -g @plugin 'egel/tmux-gruvbox'
set -g @tmux-gruvbox 'dark' # or 'light', 'dark-transparent', 'light-transparent'

Hit prefix + I to fetch the plugin and source it. Your Tmux should be updated with the theme at this point.

Development

To run project locally:

  1. clone the repo to desired place

    cd $HOME/projects/
    git clone ...
    
  2. create symlink in plugin dir to the cloned repo:

    # cd to tmux plugin directory
    cd ~/.tmux/plugins/
    
    # create simlink to cloned repo
    ln -sf $HOME/projects/tmux-gruvbox/ tmux-gruvbox
    
  3. and in ~/.tmux.conf set

    # add plugin
    set -g @plugin 'egel/tmux-gruvbox'
    # set desired options...
    set -g @tmux-gruvbox 'dark'
    

Linters & formatters

To keep the files clean we use few program to help us achieve it:

  1. Editorconfig (make sure your editor have it)
  2. Markdown (prettier/prettierd)
  3. Shell (shellcheck, shfmt)

License

GPLv3 - Maciej Sypień