Repository files navigation

despell maps commands to icons intmux's status line

• 🗺️ Map commands to nerdfont icons
• 🎨 Customization options for colors and emojis
• 🔄 Easy to override default mappings
• ⚡ Fast (Instant lookup timeO(1))
• 🔧 Simple to use and integrate with other themes

cargo install despell

NoteMake sure that$HOME/.cargo/bin is in yourPATH environment variable

despell requires your terminal to use aNerd Fonts-patched font.

At its core,despell takes a string (process name) as input and returns a string (icon) as output.

To usedespell in your existing config, replace all occurrences of

#W

with

#(despell #W) #W

in your~/.tmux.conf.

If you don't have a~/.tmux.conf yet, have a look at the example configs below to get started.

You can start usingdespell by using the example config from the screenshot. Copy of the config below into yourown~/.tmux.conf to get started.

# Colorstmux_active_fg=#a6accdtmux_active_bg=#414863tmux_inactive_fg=defaulttmux_statusbar_bg=#232235# Window status separatorset-window-option -g window-status-separator''# Status barset-option -g status-style bg=$tmux_statusbar_bgset-option -g status-left""set-option -g status-right""# Justify status barset -g status-justify centre# Activeset-window-option -g window-status-current-format"\#[bg=$tmux_active_bg] #(despell -c #W)\#[fg=$tmux_active_fg bg=$tmux_active_bg] #W"# Inactiveset-window-option -g window-status-format"\#[fg=$tmux_inactive_fg,bg=$tmux_statusbar_bg] #(despell -c #W)\#[fg=$tmux_inactive_fg,dim bg=$tmux_statusbar_bg] #W"

To center the status line instead of left aligned (default), add the following command toyour~/.tmux.conf:

# Set alignmentset -g status-justify centre

To configure how oftentmux refreshes its status line, add the following command toyour~/.tmux.conf:

# Update the status line every X secondsset -g status-interval 5

To letdespell set the icon color and override your theme settings, rundespell with the-c or--color flag:

#(despell -c #W)

To use emojis instead of Nerd Fonts, rundespell with the-e or--emoji flag:

#(despell -e #W)

To override any of the default mappings, rundespell with the-u or--custom flag. Place aconfig.toml in~/.config/despell/config.toml with your custom mappings.

All fields are optional, so if you don't use emojis, you can safely omit the fields from theTOML.

[default]nerdfont ="◒"color ="none"emoji ="🐠"[icons.command1]nerdfont ="◇"color ="blue"emoji ="🌐"[icons.command2]nerdfont ="❤"color ="magenta"emoji ="💙"

Let me know by opening an Issue, Discussion or PR.