Skip to content

Latest commit

 

History

History
245 lines (169 loc) · 4.88 KB

INSTALL.md

File metadata and controls

245 lines (169 loc) · 4.88 KB
Raw

tmux

Install using tpm

If you are a tpm user, you can install the theme and keep up to date by adding the following to your .tmux.conf file:

set -g @plugin 'gruvbox/tmux'

Add any configuration options below this line in your tmux config.

Install with Nix

If you're using home-manager, an example config would look similar to this: Then run home-manager switch, the Activating theme section doesn't apply here.

programs.tmux = {
	enable = true;
	clock24 = true;
	plugins = with pkgs.tmuxPlugins; [
		sensible
		yank
		{
			plugin = gruvbox;
			extraConfig = ''
				set -g @gruvbox-show-battery false
				set -g @gruvbox-show-powerline true
				set -g @gruvbox-refresh-rate 10
			'';
		}
	];

	extraConfig = ''
		set -g mouse on
	'';
};

Activating theme

  1. Make sure run -b '~/.tmux/plugins/tpm/tpm' is at the bottom of your .tmux.conf
  2. Run tmux
  3. Use the tpm install command: prefix + I (default prefix is ctrl+b)

Configuration

To enable plugins set up the @gruvbox-plugins option in you .tmux.conf file, separate plugin by space. The order that you define the plugins will be the order on the status bar left to right.

# available plugins: battery, cpu-usage, git, gpu-usage, ram-usage, network, network-bandwidth, network-ping, weather, time
set -g @gruvbox-plugins "cpu-usage gpu-usage ram-usage"

For each plugin is possible to customize background and foreground colors

# available colors: white, gray, dark_gray, light_purple, dark_purple, cyan, green, orange, red, pink, yellow
# set -g @gruvbox-[plugin-name]-colors "[background] [foreground]"
set -g @gruvbox-cpu-usage-colors "pink dark_gray"

Status bar options

Enable powerline symbols

set -g @gruvbox-show-powerline true

Switch powerline symbols

# for left
set -g @gruvbox-show-left-sep 

# for right symbol (can set any symbol you like as seperator)
set -g @gruvbox-show-right-sep 

Enable window flags

set -g @gruvbox-show-flags true

Adjust the refresh rate for the status bar

# the default is 5, it can accept any number
set -g @gruvbox-refresh-rate 5

Switch the left smiley icon

# it can accept `session`, `smiley`, `window`, or any character.
set -g @gruvbox-show-left-icon session

Add padding to the left smiley icon

# default is 1, it can accept any number and 0 disables padding.
set -g @gruvbox-left-icon-padding 1

Enable high contrast pane border

set -g @gruvbox-border-contrast true

cpu-usage options

Customize label

set -g @gruvbox-cpu-usage-label "CPU"

Show system load average instead of CPU usage percentage (default)

set -g @gruvbox-cpu-display-load true

CPU usage percentage (default) - in percentage (output: %) Load average – is the average system load calculated over a given period of time of 1, 5 and 15 minutes (output: x.x x.x x.x)

battery options

Customize label

set -g @gruvbox-battery-label "Battery"

gpu-usage options

Customize label

set -g @gruvbox-gpu-usage-label "GPU"

ram-usage options

Customize label

set -g @gruvbox-ram-usage-label "RAM"

network-ping options

You can configure which server (hostname, IP) you want to ping and at which rate (in seconds). Default is google.com at every 5 seconds.

set -g @gruvbox-ping-server "google.com"
set -g @gruvbox-ping-rate 5

time options

Disable timezone

set -g @gruvbox-show-timezone false

Swap date to day/month

set -g @gruvbox-day-month true

Enable military time

set -g @gruvbox-military-time true

git options

Hide details of git changes

set -g @gruvbox-git-disable-status true

Set symbol to use for when branch is up to date with HEAD

# default is ✓. Avoid using non unicode characters that bash uses like $, * and !
set -g @gruvbox-git-show-current-symbol ✓

Set symbol to use for when branch diverges from HEAD

# default is unicode !. Avoid bash special characters
set -g @gruvbox-git-show-diff-symbol !

Set symbol or message to use when the current pane has no git repo

# default is unicode no message
set -g @gruvbox-git-no-repo-message ""

Hide untracked files from being displayed as local changes

# default is false
set -g @gruvbox-git-no-untracked-files true

Show remote tracking branch together with diverge/sync state

# default is false
set -g @gruvbox-git-show-remote-status true

weather options

Switch from default fahrenheit to celsius

set -g @gruvbox-show-fahrenheit false

Set your location manually

set -g @gruvbox-fixed-location "Some City"

Hide your location

set -g @gruvbox-show-location false