README.md

Customizing modules

Every module (except the module "session") supports the following overrides:

Override the specific module icon

set -g @catppuccin_[module_name]_icon "icon"

Override the specific module color

set -g @catppuccin_[module_name]_color "color"

Override the specific module background color

(NB: Only when @catppuccin_status_fill is icon)

set -g @catppuccin_status_[module_name]_bg_color "color"

Override the specific module text

set -g @catppuccin_[module_name]_text "text"

Removing a specific module option

set -g @catppuccin_[module_name]_[option] "null"

This is for the situation where you want to remove the icon from a module. Ex:

set -g @catppuccin_date_time_icon "null"

Notes for TPM users

Make sure you load the catppuccin theme prior to setting the status-left and/or status-left options. This ensures the catppuccin options (such as colors and status modules) are defined so they can then be used.

After status-left and/or status-left have been set, make sure to run TPM to load the modules. This runs any plugins that may replace text in the status line.

# load catppuccin theme ...
run '~/.config/tmux/plugins/tmux/catppuccin.tmux' # or where this file is located on your machine

# ... and then set status-left & status-right ...
set -g status-left "#{E:@catppuccin_status_session}"

set -g status-right "#{E:@catppuccin_status_[module_name]}"
set -ag status-right "#{E:@catppuccin_status_[module_name]}"
set -agF status-right "#{E:@catppuccin_status_[module_name]}"

# ... and finally start TPM
run '~/.tmux/plugins/tpm/tpm'

set -g @plugin 'catppuccin/tmux#v1.0.1' # See https://github.com/catppuccin/tmux/tags for additional tags
set -g @plugin 'tmux-plugins/tpm'

Battery module

Requirements

This module depends on tmux-battery.

Install

The preferred way to install tmux-battery is using TPM.

Configure

Load tmux-battery after you load catppuccin.

set -g @plugin 'catppuccin/tmux'
...
set -g @plugin 'tmux-plugins/tmux-battery'

Add the battery module to the status modules list.

set -ag status-right "... #{E:@catppuccin_status_battery} ..."

CPU module

Requirements

This module depends on tmux-cpu.

Install

The preferred way to install tmux-cpu is using TPM.

Configure

Load tmux-cpu after you load catppuccin.

set -g @plugin 'catppuccin/tmux'
...
set -g @plugin 'tmux-plugins/tmux-cpu'

Add the cpu module to the status modules list.

set -agF status-right "... #{E:@catppuccin_status_cpu} ..."

Weather modules

tmux-weather

Requirements

This module depends on tmux-weather.

Install

The preferred way to install tmux-weather is using TPM.

Configure

Load tmux-weather after you load catppuccin.

set -g @plugin 'catppuccin/tmux'
...
set -g @plugin 'xamut/tmux-weather'

Add the weather module to the status modules list:

set -agF status-right "... #{E:@catppuccin_status_weather} ..."

tmux-clima

Requirements

This module depends on tmux-clima.

Install

The preferred way to install tmux-clima is using TPM.

Configure

Load tmux-clima after you load catppuccin.

set -g @plugin 'catppuccin/tmux'
...
set -g @plugin 'vascomfnunes/tmux-clima'

Add the weather module to the status modules list.

set -agF status-right "... #{E:@catppuccin_status_clima} ..."

Load module

Requirements

This module depends on tmux-loadavg.

Install

The preferred way to install tmux-loadavg is using TPM.

Configure

Load tmux-loadavg after you load catppuccin.

set -g @plugin 'catppuccin/tmux'
...
set -g @plugin 'jamesoff/tmux-loadavg'

Add the load module to the status modules list.

set -agF status-right "... #{E:@catppuccin_status_load} ..."

Gitmux module

Requirements

This module depends on gitmux.

Install

To install gitmux, follow the instructions in the gitmux documentation.

Configure

Add the gitmux module to the status modules list.

set -agF status-right "... #{E:@catppuccin_status_gitmux} ..."

To customize the gitmux module, you can follow the instrucctions in the gitmux documentation and add this line in your tmux configuration:

set -g @catppuccin_gitmux_text "#(gitmux -cfg $HOME/.gitmux.conf \"#{pane_current_path}\")"

Pomodoro module

Requirements

This module depends on tmux-pomodoro-plus.

Install

The preferred way to install tmux-pomodoro-plus is using TPM.

Configure

Load tmux-pomodoro-plus after you load catppuccin.

set -g @plugin 'catppuccin/tmux'
...
set -g @plugin 'olimorris/tmux-pomodoro-plus'

Add the pomodoro module to the status modules list.

set -agF status-right "... #{E:@catppuccin_status_pomodoro_plus} ..."

Kube module

Requirements

This module depends on kube-tmux.

Install

The preferred way to install kube-tmux is using TPM.

Configure

set -g @plugin 'catppuccin/tmux'
...
set -g @plugin 'jonmosco/kube-tmux'

Add the tmux module to the status modules list.

set -agF status-right "... #{E:@catppuccin_status_kube} ..."

Optionally override the kube-tmux colors

set -g @catppuccin_kube_context_color "#{@thm_red}"
set -g @catppuccin_kube_namespace_color "#{@thm_sky}"

Create a custom module

It is possible to use the options set by the plugin to create your own modules.

For further details, see the documentation in custom/README.md