psi-jack/tpm
1
0
Fork 0
mirror of synced 2024-12-13 19:05:45 -05:00
Code Issues Releases Wiki Activity
Tmux Plugin Manager
102 commits 4 branches 10 tags 499 KiB
Shell 100%
Find a file
Geoff Maciolek 91c03a18d9 Replaced "ENTER" prompt with "q" prompt in echo_message text. Fixes tmux-plugins/tpm#43
2015-07-30 10:30:38 -04:00
docs Move all the docs to docs/ dir 2015-07-10 17:10:41 +02:00
scripts Replaced "ENTER" prompt with "q" prompt in echo_message text. Fixes tmux-plugins/tpm#43 2015-07-30 10:30:38 -04: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 Move all the docs to docs/ dir 2015-07-10 17:10:41 +02:00
HOW_TO_PLUGIN.md Move to a directory 2015-07-10 17:05:09 +02:00
LICENSE.md Add README and license 2014-05-19 11:43:00 +02:00
README.md Update readme 2015-07-10 17:14:13 +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

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

  1. add new plugin to .tmux.conf with set -g @plugin '...'
  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 (or comment out) plugin from the list
  2. 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.

Docs

More advanced features and instructions, regular users probably do not need this:

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