Tmux Status Line

About

This is a fork of janoamaral/tokyo-night-tmux. This fork exists because I wanted this tmux plugin to give users more freedom, not just restrict them to the Tokyo Night theme. It now accepts any colors you specify in your tmux config file, and defaults to your terminal’s standard ANSI colors if none are provided.

Requirements

This theme has the following hard requirements:

• Any patched Nerd Fonts (v3 or higher)
• Bash 4.2 or newer

The following are recommended for full support of all widgets and features:

• Noto Sans Symbols 2 (for segmented digit numbers)
• bc (for netspeed and git widgets)
• jq, [gh], [glab] (for git widgets)

macOS

macOS still ships with bash 3.2 so you must provide a newer version. You can easily install all dependencies via Homebrew:

brew install --cask font-monaspace-nerd-font font-noto-sans-symbols-2
brew install bash bc coreutils gawk gh glab gsed jq nowplaying-cli

Linux

Alpine Linux

apk add bash bc coreutils gawk git jq playerctl sed

Arch Linux

pacman -Sy bash bc coreutils git jq playerctl

Ubuntu

apt-get install bash bc coreutils gawk git jq playerctl

Check documentation for installing on other operating systems.

Installation using TPM

In your tmux.conf:

set -g @plugin "lukejans/tmux-status-line"

Configuration

Themes

Use following option to change theme preference:

set -g @tmux-status-line storm   # storm | day | default to 'night'
set -g @tmux-status-line 1       # 1 or 0

Number styles

Run these commands in your terminal:

tmux set @tmux-status-line_window_id_style digital
tmux set @tmux-status-line_pane_id_style hsquare
tmux set @tmux-status-line_zoom_id_style dsquare

Alternatively, add these lines to your .tmux.conf:

set -g @tmux-status-line_window_id_style digital
set -g @tmux-status-line_pane_id_style hsquare
set -g @tmux-status-line_zoom_id_style dsquare

Window styles

# Icon styles
set -g @tmux-status-line_terminal_icon 
set -g @tmux-status-line_active_terminal_icon 

# No extra spaces between icons
set -g @tmux-status-line_window_tidy_icons 0

Widgets

For widgets add following lines in you .tmux.conf

Date and Time widget

This widget is enabled by default. To disable it:

set -g @tmux-status-line_show_datetime 0
set -g @tmux-status-line_date_format MYD
set -g @tmux-status-line_time_format 12H

Available Options

• YMD: (Year Month Day), 2024-01-31

• MDY: (Month Day Year), 01-31-2024

• DMY: (Day Month Year), 31-01-2024

• 24H: 18:30

• 12H: 6:30 PM

Netspeed widget

set -g @tmux-status-line_show_netspeed 1
set -g @tmux-status-line_netspeed_iface "wlan0" # Detected via default route
set -g @tmux-status-line_netspeed_showip 1      # Display IPv4 address (default 0)
set -g @tmux-status-line_netspeed_refresh 1     # Update interval in seconds (default 1)

Path Widget

set -g @tmux-status-line_show_path 1
set -g @tmux-status-line_path_format relative # 'relative' or 'full'

Battery Widget

set -g @tmux-status-line_show_battery_widget 1
set -g @tmux-status-line_battery_name "BAT1"  # some linux distro have 'BAT0'
set -g @tmux-status-line_battery_low_threshold 21 # default

Set variable value 0 to disable the widget. Remember to restart tmux after changing values.

Hostname Widget

set -g @tmux-status-line_show_hostname 1

Styles

• hide: hide number
• none: no style, default font
• digital: 7 segment number (🯰...🯹) (needs Unicode support)
• roman: roman numbers (󱂈...󱂐) (needs nerdfont)
• fsquare: filled square (󰎡...󰎼) (needs nerdfont)
• hsquare: hollow square (󰎣...󰎾) (needs nerdfont)
• dsquare: hollow double square (󰎡...󰎼) (needs nerdfont)
• super: superscript symbol (⁰...⁹)
• sub: subscript symbols (₀...₉)

Tmux Status Line Highlights

• Local git stats.
• Web based git server (GitHub/GitLab) stats.
  • Open PR count
  • Open PR reviews count
  • Issue count
• Remote branch sync indicator.
• Great terminal icons.
• Prefix highlight incorporated.
• Now Playing status bar, supporting playerctl/nowplaying-cli
• Windows has custom pane number indicator.
• Pane zoom mode indicator.
• Date and time.

TODO

• Add configurations
  • remote fetch time
  • number styles
  • indicators order
  • disable indicators

Contributing

Important

Please read the contribution guide first.

Feel free to open an issue or pull request with any suggestions or improvements.

Ensure your editor follows the style guide provided by .editorconfig. pre-commit hooks are also provided to ensure code consistency, and will be run against any raised PRs.