Tmux Plugin Manager

Installs and loads tmux plugins.

Tested and working on Linux, OSX, and Cygwin.

Installation

Requirements: tmux version 1.9 (or higher), git, bash.

Clone TPM:

$ git clone https://github.com/tmux-plugins/tpm ~/.tmux/plugins/tpm

Put this at the bottom of ~/.tmux.conf ($XDG_CONFIG_HOME/tmux/tmux.conf works too):

# List of plugins
set -g @plugin 'tmux-plugins/tpm'
set -g @plugin 'tmux-plugins/tmux-sensible'

# Other examples:
# set -g @plugin 'github_username/plugin_name'
# set -g @plugin 'github_username/plugin_name#branch'
# set -g @plugin 'git@github.com/user/plugin'
# set -g @plugin 'git@bitbucket.com/user/plugin'

# Initialize TMUX plugin manager (keep this line at the very bottom of tmux.conf)
run -b '~/.tmux/plugins/tpm/tpm'

Reload TMUX environment so TPM is sourced:

# type this in terminal if tmux is already running
$ tmux source ~/.tmux.conf

That's it!

Installing plugins

Add new plugin to ~/.tmux.conf with set -g @plugin '...'
Press prefix + I (capital i, as in Install) to fetch the plugin.

You're good to go! The plugin was cloned to ~/.tmux/plugins/ dir and sourced.

Uninstalling plugins

Remove (or comment out) plugin from the list.
Press prefix + alt + u (lowercase u as in uninstall) to remove the plugin.

All the plugins are installed to ~/.tmux/plugins/ so alternatively you can find plugin directory there and remove it.

Key bindings

prefix + I

Installs new plugins from GitHub or any other git repository
Refreshes TMUX environment

prefix + U

updates plugin(s)

prefix + alt + u

remove/uninstall plugins not on the plugin list

More plugins

For more plugins, check here.

Docs

Help, tpm not working - problem solutions

More advanced features and instructions, regular users probably do not need this:

Tests

Tests for this project run on Travis CI.

When run locally, vagrant is required. Run tests with:

# within project directory
$ ./run_tests

Other goodies

tmux-copycat - a plugin for regex searches in tmux and fast match selection
tmux-yank - enables copying highlighted text to system clipboard
tmux-open - a plugin for quickly opening highlighted file or a url
tmux-continuum - automatic restoring and continuous saving of tmux env

License

MIT

3.2 KiB Raw Blame History