Tmux Plugin Manager
Go to file
Bruno Sutic 79d90f90f7
Refactor 'tpm' script
2015-08-03 15:20:40 +02:00
bin Enable removing plugins via CLI executable 2015-08-03 00:33:38 +02:00
bindings Helper functions refactoring 2015-08-03 15:17:07 +02:00
docs Fix docs typo 2015-08-03 01:29:53 +02:00
lib New version of 'tmux-test' w/ updated .travis.yml 2015-08-01 22:56:36 +02:00
scripts Refactor 'tpm' script 2015-08-03 15:20:40 +02:00
tests Refactor how TPM path is set 2015-08-03 01:11:39 +02:00
.gitignore Switch to using `tmux-test` framework 2015-08-01 22:19:06 +02:00
.gitmodules Switch to using `tmux-test` framework 2015-08-01 22:19:06 +02:00
.travis.yml Manually update .travis.yml 2015-08-01 23:02:27 +02:00 TPM path refactoring 2015-08-03 00:59:13 +02:00 Move to a directory 2015-07-10 17:05:09 +02:00 Add README and license 2014-05-19 11:43:00 +02:00 Enable removing plugins via CLI executable 2015-08-03 00:33:38 +02:00
tpm Refactor 'tpm' script 2015-08-03 15:20:40 +02:00

Tmux Plugin Manager

Build Status

Installs and loads TMUX plugins.


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

Clone TPM:

$ git clone ~/.tmux/plugins/tpm

Put this at the bottom of .tmux.conf:

# 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 ''
# set -g @plugin ''

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

Reload TMUX environment so TPM is sourced:

# type this in terminal
$ tmux source ~/.tmux.conf

That's it!

(Note: using set -g @tpm_plugins is deprecated, but still works alongside new syntax)

Installing plugins

  1. add new plugin to .tmux.conf with set -g @plugin '...'
  2. hit prefix + I (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

  1. remove (or comment out) plugin from the list
  2. hit prefix + alt + u (u as in uinstall) 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 repo
  • 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.


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


Tests for this project run on travis.

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

You might want to follow @brunosutic on twitter if you want to hear about new tmux plugins or feature updates.