Tmux Plugin Manager
Go to file
Bruno Sutic f8923b05d4 Change plugin update wording 2014-08-05 20:57:08 +02:00
scripts Change plugin update wording 2014-08-05 20:57:08 +02:00
tests Update tests to pass 2014-07-28 16:07:35 +02:00
.gitignore First version of tests 2014-07-17 20:36:54 +02:00
CHANGELOG.md Plugin installation does not perform update 2014-08-05 18:13:11 +02:00
HOW_TO_PLUGIN.md Change github organization for this and other plugins 2014-07-28 16:04:11 +02:00
LICENSE.md Add README and license 2014-05-19 11:43:00 +02:00
PLUGINS.md Change github organization for this and other plugins 2014-07-28 16:04:11 +02:00
README.md Remove README about section 2014-08-05 17:20:55 +02:00
Vagrantfile Change testing directory structure 2014-07-17 22:55:42 +02:00
run-tests Change testing directory structure 2014-07-17 22:55:42 +02:00
tpm U key binding shows a list of installed plugins 2014-08-05 18:45:59 +02:00
vagrant_provisioning.sh Change testing directory structure 2014-07-17 22:55:42 +02:00

README.md

Tmux Plugin Manager

Installs and loads TMUX plugins.

Installation

Requirements: tmux version 1.9 (or higher), git

Clone TPM:

$ git clone https://github.com/tmux-plugins/tpm ~/.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 URLs
set -g @tpm_plugins "              \
  tmux-plugins/tpm                 \
  tmux-plugins/tmux-sensible       \
"
# Other examples:
# github_username/plugin_name    \
# git@github.com/user/plugin     \
# git@bitbucket.com/user/plugin  \

# initializes TMUX plugin manager
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.

Key bindings

TPM provides only 1 key binding: prefix + I. Here's what it does:

  • clones new plugins from github or any other git repo
  • pulls updates for already installed plugins
  • refreshes TMUX environment

After you press prefix + I, everything should be up to date.

List of plugins

For more plugins, check here.

Creating plugins

How to create a plugin. It's easy.

Tests

Requirements: vagrant

To run a test suite:

$ ./run-tests

License

MIT