1
0
Fork 0
mirror of synced 2024-07-21 03:50:35 -04:00
tpm/README.md
2015-06-02 21:36:35 +02:00

3 KiB

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 repo 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. hit prefix + alt + u (u as in uinstall) to remove the plugin

All the plugins are installed to ~/.tmux/plugins/ so if you want you can just 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 unused 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

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