tmux-remote is a simple plugin that allows for toggling your tmux session's keybindings. This is especially useful when in nested remote tmux sessions that use the same prefix key as the host.
Tested and working on macOS and Linux. Requires tmux 2.1+.
Install using tpm (tmux Plugin Manager)
By adding the following in your .tmux.conf:
set -g @plugin 'danyim/tmux-remote'Then hit prefix + I to fetch the plugin and source it.
Clone the repo:
$ git clone https://github.com/danyim/tmux-remote
Add this line to the bottom of .tmux.conf:
run-shell ~/path/to/tmux-remote/remote.tmuxThen reload your tmux environment with $ tmux source-file ~/.tmux.conf.
After installing the plugin, simply press F12 to toggle remote-mode on and off.
| Key | Action |
|---|---|
| F10 | Turns on remote mode |
| F11 | Turns off remote mode |
| F12 | Toggles the remote mode |
# Change the default on keybinding (F10)
set -g @remote-on-key F10
# Change the default off keybinding (F11)
set -g @remote-off-key F11
# Change the default toggle keybinding (F12)
set -g @remote-toggle-key F12When remote mode is active, a status-left indicator is shown. You can customize its text, foreground color, and background color:
# Change the indicator text (default: " REMOTE >>> ")
set -g @remote-indicator-text " REMOTE >>> "
# Change the indicator foreground color (default: colour228)
set -g @remote-indicator-fg "colour228"
# Change the indicator background color (default: colour52)
set -g @remote-indicator-bg "colour52"Tests run automatically via GitHub Actions on push and PR.
- Tmux in practice: local and nested remote tmux sessions Medium article by Alexey Samoshkin that inspired this plugin
- Nested tmux article by Dan Stahlke outlining the method for toggling keybindings