tmux nerd font window name plugin

Automatically add Nerd Font support to your tmux window names!

Requirements

• tmux
• A Nerd Font installed and configured in your terminal

Installation

tpm

Add the following line to your tmux configuration file:

set -g @plugin 'joshmedeski/tmux-nerd-font-window-name'

Run <prefix>+I to trigger the tpm installer which will download and source the plugin.

Nix (flakes)

Add the flake input to your configuration:

{
  inputs = {
    tmux-nerd-font-window-name.url = "github:joshmedeski/tmux-nerd-font-window-name";
  };
}

Then use the plugin in your tmux configuration via Home Manager:

{ inputs, pkgs, ... }:

{
  programs.tmux = {
    enable = true;
    plugins = [
      inputs.tmux-nerd-font-window-name.packages.${pkgs.system}.default
    ];
  };
}

Or using the overlay:

{
  nixpkgs.overlays = [
    inputs.tmux-nerd-font-window-name.overlays.default
  ];

  programs.tmux.plugins = [
    pkgs.tmuxPlugins.tmux-nerd-font-window-name
  ];
}

Configuration

You can configure this plugin by creating a ~/.config/tmux/tmux-nerd-font-window-name.yml file. The following options can be changed:

config:
  fallback-icon: "?" # show when no definition is found
  multi-pane-icon: "" # show when window has multiple panes (blank by default)
  show-name: true # show the window name with the icon (defaults to false)
  always-show-fallback-name: false # always show the name alongside the fallback icon, even when show-name is false (defaults to false)
  icon-position: "left" # show the icon to the "left" or "right" of the window name (defaults to left)

icons:
  zsh: "" # overwrite with your own symbol (Nerd Font icon, emoji, whatever!)
  cmatrix: "🤯" # add new entries that aren't included

Custom Configuration File Path

By default, the plugin looks for the configuration file at:

~/.config/tmux/tmux-nerd-font-window-name.yml

You can override this path by adding the following line to your tmux.conf file:

set -g @tmux-nerd-font-window-name-config-file "/your/custom/path.yml"

Custom Placeholder Support

If you prefer to define your own automatic-rename-format, you can include a placeholder that lets this plugin inject its icon output.

For example:

set -g automatic-rename-format "#{window_icon} #{b:pane_current_path}"

Contributing

Contributions are welcome! See CONTRIBUTING.md for guidelines on adding icons, running tests, and submitting pull requests.

Intro Video

Here is the introduction blog post and video that I made for this plugin:

Additional tmux plugins

I've authored a few other tmux plugins that you might find useful:

• sesh - tmux session manager
• tmux-fzf-url - Quickly open urls with fzf