Tmux Plugin Manager
Go to file
Bruno Sutic db8b06c509
2014-11-21 23:55:05 +01:00
scripts Fix plugin freeze when installing non-existing plugins 2014-11-21 23:53:45 +01:00
tests Refactor the tests for travis 2014-11-20 02:09:24 +01:00
.gitignore First version of tests 2014-07-17 20:36:54 +02:00
.travis.yml Add travis.yml 2014-11-20 02:09:28 +01:00 v1.2.1 2014-11-21 23:55:05 +01:00 Change github organization for this and other plugins 2014-07-28 16:04:11 +02:00 Add README and license 2014-05-19 11:43:00 +02:00 v1.2.0 2014-11-20 02:28:20 +01:00
Vagrantfile Change testing directory structure 2014-07-17 22:55:42 +02:00
run-tests Refactor the tests for travis 2014-11-20 02:09:24 +01:00
tpm U key binding shows a list of installed plugins 2014-08-05 18:45:59 +02:00 Change testing directory structure 2014-07-17 22:55:42 +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 your .tmux.conf (backslashes at the end of the lines are required):

# List of plugins
# Supports `github_username/repo` or full git repo URLs
set -g @tpm_plugins '              \
  tmux-plugins/tpm                 \
  tmux-plugins/tmux-sensible       \
# Other examples:
# github_username/plugin_name    \
#     \
#  \

# Initializes TMUX plugin manager.
# Keep this line at the very bottom of tmux.conf.
run-shell '~/.tmux/plugins/tpm/tpm'

Reload TMUX environment so TPM is sourced:

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

That's it!

Installing plugins

  1. add a new plugin to the @tpm_plugins list
  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 plugin from @tpm_plugins list
  2. All the plugins are installed to ~/.tmux/plugins/. Find plugin directory there and just remove it.

Key bindings

prefix + I

  • installs new plugins from github or any other git repo
  • refreshes TMUX environment

prefix + U

  • updates plugin(s)

List of plugins

For more plugins, check here.

Wiki pages

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

Creating plugins

How to create a plugin. It's easy.


Tests run on travis.

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

# within project directory
$ ./run-tests