Empowering your tmux (status bar) experience!

---

including these top contributors:

Intro

tmux-powerline is a tmux tpm plugin that gives you a slick and hackable powerline status bar consisting of segments. It's easily extensible with custom segments and themes. The plugin itself is implemented purely in bash, thus minimizing system requirements. However, you can make segments in any language you want (with a shell wrapper).

Some examples of segments available that you can add to your tmux status bar are (full list here):

• LAN & WAN IP addresses
• Now Playing for MPD, Spotify (GNU/Linux native or wine, macOS), iTunes (macOS), Rhythmbox, Banshee, MOC, Audacious, Rdio (macOS), cmus, Pithos and Last.fm (last scrobbled track).
• New mail count for GMail, Maildir, mbox, mailcheck, and Apple Mail
• GNU/Linux and macOS battery status (uses richo/dotfiles/bin/battery)
• Weather in Celsius, Fahrenheit, and Kelvin using Yahoo Weather
• System load, CPU usage, and uptime
• Git, SVN, and Mercurial branch in CWD
• Date and time
• Hostname
• tmux info
• tmux mode indicator (normal/prefix, mouse, copy modes)
• CWD in pane
• Current X keyboard layout
• Network download/upload speed
• Earthquake warnings

Screenshots

Full screenshot

left-status

Current tmux session, window, pane, hostname, and LAN & WAN IP address.

right-status

New mails, now playing, average load, weather, date, and time.

Now I've read my inbox, thus the mail segment disappears!

After pausing the music, there's no need to show the Now Playing segment anymore. Also, the weather has become much nicer!

Laptop mode: a battery segment.

dual-line status

Co-Maintainer

@xx4h is helping out with developing, maintaining, and managing this project!

Requirements

Requirements for the lib to work are:

• tmux -V >= 2.9
• bash --version >= 3.2 (Does not have to be your default shell.)
• Nerd Font. Follow instructions at Font Installation. However, you can use other substitute symbols as well; see config.sh.

Segment Requirements

Some segments have their own requirements. If you enable them in your theme, make sure all requirements are met for those.

• cpu_temp.sh: lm_sensors for Linux, smctemp for Macos
• dropbox_status.sh: dropbox-cli
• github_notifications.sh: jq, curl
• ifstat.sh: ifstat (there is a simpler segment ifstat_sys.sh not using ifstat)
• mailcount.sh
  • gmail: wget
  • mailcheck: mailcheck
• now_playing.sh
  • mpd: libmpdclient
  • last.fm: jq, curl
• rainbarf.sh: rainbarf
• tmux_continuum*.sh: tmux-continuum
• tmux_mem_cpu_load.sh: tmux-mem-cpu-load
• wan_ip.sh: curl
• weather.sh:
  • Provider yrno: jq, curl
• xkb_layout.sh: X11, XKB

Installation

1. Install tpm and make sure it's working.
2. Install tmux-powerline as a plugin by adding a line to tmux.conf:

    set -g @plugin 'erikw/tmux-powerline'
   

3. Install the plugin with <prefix>I, unless you changed tpm's keybindings.
   • The default powerline should already be visible now!
4. Continue to the Configuration section below.

[!NOTE] Note that tpm plugins should be at the bottom of your tmux.conf. This plugin will then override some tmux settings like status-left, status-right, etc. If you had already set those in your tmux config, it is a good opportunity to remove or comment them out. Take a look at main.tmux for exactly which settings are overridden.

Configuration

tmux-powerline stores the custom config, themes, and segments at $XDG_CONFIG_HOME/tmux-powerline/.

To make the following example easier, let's assume the following:

• $XDG_CONFIG_HOME has the default value of ~/.config
• tmux-powerline was installed to the XDG path ~/.config/tmux/plugins/tmux-powerline

Adapt the commands below if your paths differ from this.

Configuration File

Start by generating your own configuration file:

~/.config/tmux/plugins/tmux-powerline/generate_config.sh
mv ~/.config/tmux-powerline/config.sh.default ~/.config/tmux-powerline/config.sh
$EDITOR ~/.config/tmux-powerline/config.sh

Go through the default config and adjust it to your needs!

Custom Theme

The theme is specified by setting the environment variable $TMUX_POWERLINE_THEME in the config file above. It will use a default theme, and you probably want to use your own. The default config has set the custom theme path to be ~/.config/tmux-powerline/themes/.

Make a copy of the default theme and make your own, say my-theme:

mkdir -p ~/.config/tmux-powerline/themes
cp ~/.config/tmux/plugins/tmux-powerline/themes/default.sh ~/.config/tmux-powerline/themes/my-theme.sh
$EDITOR ~/.config/tmux-powerline/themes/my-theme.sh

[!IMPORTANT] Remember to update the configuration file to use the new theme by setting TMUX_POWERLINE_THEME=my-theme

Custom Segments

In the same was as themes, you can create your own segments at TMUX_POWERLINE_DIR_USER_SEGMENTS which defaults to ~/.config/tmux-powerline/segments.

To get started, copy an existing segment that is similar to the segment that you want to create.

mkdir -p ~/.config/tmux-powerline/segments
cp ~/.config/tmux/plugins/tmux-powerline/segments/date.sh ~/.config/tmux-powerline/segments/my-segment.sh
$EDITOR ~/.config/tmux-powerline/segments/my-segment.sh

Now you can add my-segment to your own theme!

Also see How to make a segment below for more details.

Debugging

Some segments might not work on your system for various reasons, such as missing programs or different versions not having the same options. To find out which segment is not working, it may help to enable the debug setting in ~/.config/tmux-powerline/config.sh.

Next step would be to enable the error logging in general or even with a scope, see TMUX_POWERLINE_ERROR_LOGS_ENABLED and TMUX_POWERLINE_ERROR_LOGS_SCOPES in your config.

However, this may not be enough to determine the error, so you can inspect all executed bash commands (will be a long output) by doing

bash -x powerline.sh (left|right)

To debug smaller portions of code, say if you think the problem lies in a specific segment, insert these lines at the top and bottom of the relevant code portions e.g., inside a function:

set -x
exec 2>/tmp/tmux-powerline.log
<code to debug>
set +x

and then inspect the outputs like

less /tmp/tmux-powerline.log
tail -f /tmp/tmux-powerline.log # or follow output like this.

You can also enable the debug mode in your config file. Look for the TMUX_POWERLINE_DEBUG_MODE_ENABLED environment variable and set it to true.

If you can not solve the problems, you can post an issue and be sure to include relevant information about your system and script output (from bash -x) and/or screenshots if needed. Be sure to search in the resolved issues section for similar problems you're experiencing before posting.

Common Problems

Nothing is Displayed

You have edited ~/.tmux.conf, but no powerline is displayed. This might be because tmux is not aware of the changes, so you have to restart your tmux session or reload that file by typing this on the command line (or in tmux command mode with prefix :)

tmux source-file ~/.tmux.conf

Multiple lines in bash or no powerline in Zsh using iTerm (macOS)

If your tmux looks like this, then you may have to, in iTerm, uncheck [Unicode East Asian Ambiguous characters are wide] in Preferences -> Settings -> Advanced.

Hacking (Development)

[!IMPORTANT] Please read and follow the CONTRIBUTING.md guidelines!

This project can only gain positively from contributions. Fork today and make your own enhancements and segments to share back!

Codespaces Devcontainer

You can fork this project and then start coding right away with GitHub Codespaces, as this project is set up to install all development dependencies and install tmux-powerline on the devcontainer. See devcontainer.json and devcontainer_postCreateCommand.sh. After starting the devcontainer, just type tmux in the terminal, and you should see a working tmux-powerline already to start playing with.

[!IMPORTANT] If you have set up your own dotfiles to be installed with GitHub Codespaces, and there were some tmux config files installed from your dotfiles to the devcontainer, then you might have to run this script to wipe your config in favour of the setup provided by this repo's initialization:

./scripts/devcontainer_postCreateCommand.sh

How To Make a Segment

Please section How To Make a Segment at CONTRIBUTING.md.

Releasing

Create a new version of this project by using semver-cli.

vi CHANGELOG.md
semver up minor
ver=$(semver get release)
git commit -am "Bump version to $ver" && git tag $ver && git push --atomic origin main $ver

More Tmux Plugins

I have another tmux plugin that might interest you:

• tmux-dark-notify - A plugin that makes tmux's theme follow macOS dark/light mode.