Ora

How to reload tmux config?

Published in Tmux Configuration 3 mins read

The most straightforward way to reload your tmux configuration is by using a dedicated shortcut within your tmux session, which typically re-sources your configuration file. This allows you to apply changes to your ~/.tmux.conf without restarting your tmux server or sessions.

Reloading Configuration via Shortcut

To efficiently reload your tmux configuration file (~/.tmux.conf) without interrupting your active sessions, you can leverage a custom key binding. This is a common and highly recommended practice among tmux users for quick updates.

Standard Reload Binding

A widely adopted method is to include the following line in your ~/.tmux.conf file:

bind r source-file ~/.tmux.conf \; display-message "Config reloaded..."

Understanding the Command:

  • bind r: This part of the command binds the r key to an action. When you press r immediately after your tmux leader key (which is Ctrl+b by default), it triggers the subsequent commands.
  • source-file ~/.tmux.conf: This is the core command that instructs tmux to read and execute the commands within your ~/.tmux.conf file. This process effectively reloads all your settings and applies any changes you've made.
  • \;: This crucial separator allows you to chain multiple commands together on a single line within your tmux configuration.
  • display-message "Config reloaded...": After the configuration file has been successfully reloaded, this command conveniently displays a brief confirmation message at the bottom of your tmux pane, letting you know the changes have been applied.

How to Execute the Reload Shortcut

Once you have added the binding to your ~/.tmux.conf file and either sourced it initially (by starting a new tmux session or manually sourcing it once using leader + : followed by source-file ~/.tmux.conf) or restarted tmux, you can reload your configuration at any time by following these steps:

  1. Press your tmux leader key: By default, this is Ctrl+b.
  2. Release the leader key, then press r: After pressing the leader key, release it, and then quickly press the r key.

Upon successful execution, you will observe the "Config reloaded..." message briefly appear at the bottom of your tmux pane, confirming that your configuration has been updated.

Quick Reference for Tmux Key Bindings

Action Default Leader Key Shortcut Key Command (in ~/.tmux.conf)
Reload Configuration Ctrl+b r bind r source-file ~/.tmux.conf \; display-message "Config reloaded..."
Enter Command Mode Ctrl+b : (Activates the tmux command prompt for manual input)

This method provides an efficient way to apply changes to your tmux setup without disrupting your active sessions or workflows.