mirror of https://github.com/tmux-plugins/tpm.git synced 2024-11-19 02:48:46 +00:00

Go to file

Bruno Sutic fbd9ea1c88 How to plugin typos		2015-07-07 02:23:49 +02:00
scripts	New and old plugin syntax work together	2015-07-07 01:04:26 +02:00
tests	Use new plugin syntax all around	2015-07-07 01:49:33 +02: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	New and old plugin syntax work together	2015-07-07 01:04:26 +02:00
HOW_TO_PLUGIN.md	How to plugin typos	2015-07-07 02:23:49 +02:00
LICENSE.md	Add README and license	2014-05-19 11:43:00 +02:00
README.md	Update readme with new plugin syntax	2015-07-07 01:46:53 +02:00
run-tests	Refactor the tests for travis	2014-11-20 02:09:24 +01:00
tpm	Use new plugin syntax all around	2015-07-07 01:49:33 +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

README.md

Tmux Plugin Manager

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 .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 '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 '~/.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

add new plugin to .tmux.conf with set -g @plugin '...'
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

remove (or comment out) plugin from the list
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

uninstall plugins that are not on the plugin list

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

License

MIT