README

Tmux Plugin Manager



Installs and loads tmux plugins.

Tested and working on Linux, OSX, and Cygwin.

See list of plugins here.

Also, check out tpack, drop-in replacement
for tpm with a TUI, auto-updates and plugins browser.

 Installation

Requirements: tmux version 1.9 (or higher), git, bash.

Clone TPM:

bash
git clone https://github.com/tmux-plugins/tpm ~/.tmux/plugins/tpm


Put this at the bottom of ~/.tmux.conf ($XDG_CONFIG_HOME/tmux/tmux.conf
works too):

bash
 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 'github_username/plugin_namebranch'
 set -g @plugin '[email protected]:user/plugin'
 set -g @plugin '[email protected]: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:

bash
 type this in terminal if tmux is already running
tmux source ~/.tmux.conf


That's it!

 Installing plugins

1. Add new plugin to ~/.tmux.conf with set -g @plugin '...'
2. Press prefix + I (capital 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 (or comment out) plugin from the list.
2. Press prefix + alt + u (lowercase u as in uninstall) 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 repository
- Refreshes TMUX environment

prefix + U
- updates plugin(s)

prefix + alt + u
- remove/uninstall plugins not on the plugin list

 Docs

- Help, tpm not working - problem solutions

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

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

bash
 within project directory
./run_tests


 License

MIT