chezmoi/dot_tmux/plugins/tmux/README.md

Catppuccin for Tmux

Themes

• 🌻 Latte
• 🪴 Frappé
• 🌺 Macchiato
• 🌿 Mocha

Usage

TPM

1. Install TPM
2. Add the Catppuccin plugin:

set -g @plugin 'catppuccin/tmux'
# ...alongside
set -g @plugin 'tmux-plugins/tpm'

3. (Optional) Set your preferred flavour, it defaults to "mocha":

set -g @catppuccin_flavour 'latte' # or frappe, macchiato, mocha

Manual

1. Copy your desired theme's configuration contents into your Tmux config (usually stored at ~/.tmux.conf)
2. Reload Tmux by either restarting the session or reloading it with tmux source-file ~/.tmux.conf

Configuration options

All flavours support certain levels of customization that match our Catppuccin Style Guide. To add these customizations, add any of the following options to your Tmux configuration.

In order to have the correct icons displayed please use your favorite nerd fonts patched font.

Enable window tabs

By default, the theme places the window-status in the status-right. With @catppuccin_window_tabs_enabled set to on, the theme will place the directory within the status-right and move the window names to the window-status format variables.

set -g @catppuccin_window_tabs_enabled on # or off to disable window_tabs

Configure separator

By default, the theme will use a round separator for left and right. To overwrite it use @catppuccin_left_separator and @catppuccin_right_separator

set -g @catppuccin_left_separator "█"
set -g @catppuccin_right_separator "█"

Enable DateTime

By default, the date_time component is set to off. It can be enabled by specifying any tmux date and time format.

set -g @catppuccin_date_time "%Y-%m-%d %H:%M"

Enable User

By default, the user component is set to off. It can be enabled by toggling it on.

set -g @catppuccin_user "on"

Enable Host

By default, the host component is set to off. It can be enabled by toggling it on.

set -g @catppuccin_host "on"

Customize Icons

Each of the components comes with their own default icon, which can be changed to fit your preference or requirements of your font.

Note: NerdFont Icons do not render properly in the Github UI, so the below example does not use them

set -g @catppuccin_datetime_icon "A"
set -g @catppuccin_user_icon "B"
set -g @catppuccin_directory_icon "C"
set -g @catppuccin_window_icon "D"
set -g @catppuccin_session_icon "E"
set -g @catppuccin_host_icon "F"

💝 Thanks to

• Pocco81
• vinnyA3
• rogeruiz

 

Copyright © 2021-present Catppuccin Org