bfc7a2c2cb
Fixes #43, closes #45 |
||
---|---|---|
bin | ||
bindings | ||
docs | ||
lib | ||
scripts | ||
tests | ||
.gitignore | ||
.gitmodules | ||
.travis.yml | ||
CHANGELOG.md | ||
HOW_TO_PLUGIN.md | ||
LICENSE.md | ||
README.md | ||
tpm |
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
withset -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
- remove/uninstall plugins not on the plugin list
More plugins
For more plugins, check here.
Docs
More advanced features and instructions, regular users probably do not need this:
- How to create a plugin. It's easy.
- Managing plugins via the command line
- Changing plugins install dir
- Automatic TPM installation on a new machine
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.