1
0
Fork 0
mirror of synced 2024-05-30 14:01:10 -04:00
Tmux Plugin Manager
Go to file
2014-11-20 02:21:22 +01:00
scripts Fix unexpanded glob case 2014-11-19 11:12:10 +13: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
CHANGELOG.md Add travis.yml 2014-11-20 02:09:28 +01: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
README.md Travis badge in the readme now links to travis 2014-11-20 02:21:22 +01: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
vagrant_provisioning.sh Change testing directory structure 2014-07-17 22:55:42 +02:00
Vagrantfile Change testing directory structure 2014-07-17 22:55:42 +02:00

Tmux Plugin Manager

Build Status

Installs and loads TMUX plugins.

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 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.
# 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

Tests run on travis.

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

# within project directory
$ ./run-tests

License

MIT