1
0
Fork 0
mirror of synced 2024-07-15 22:26:43 -04:00
tpm/README.md

107 lines
3 KiB
Markdown
Raw Normal View History

2014-05-19 05:17:58 -04:00
# Tmux Plugin Manager
[![Build Status](https://travis-ci.org/tmux-plugins/tpm.png?branch=master)](https://travis-ci.org/tmux-plugins/tpm)
2014-11-19 09:58:12 -05:00
2014-05-19 05:17:58 -04:00
Installs and loads TMUX plugins.
### Installation
2014-09-10 15:54:59 -04:00
Requirements: `tmux` version 1.9 (or higher), `git`, `bash`.
2014-05-19 05:22:16 -04:00
2014-05-19 05:17:58 -04:00
Clone TPM:
$ git clone https://github.com/tmux-plugins/tpm ~/.tmux/plugins/tpm
2014-05-19 05:17:58 -04:00
2015-07-06 19:46:53 -04:00
Put this at the bottom of `.tmux.conf`:
2014-05-19 05:17:58 -04:00
# List of plugins
2015-07-06 19:46:53 -04:00
set -g @plugin 'tmux-plugins/tpm'
set -g @plugin 'tmux-plugins/tmux-sensible'
2014-05-19 05:27:10 -04:00
# Other examples:
2015-07-06 19:46:53 -04:00
# set -g @plugin 'github_username/plugin_name'
# set -g @plugin 'git@github.com/user/plugin'
# set -g @plugin 'git@bitbucket.com/user/plugin'
2014-05-19 05:17:58 -04:00
2015-07-06 19:46:53 -04:00
# Initialize TMUX plugin manager (keep this line at the very bottom of tmux.conf)
run '~/.tmux/plugins/tpm/tpm'
2014-05-19 05:17:58 -04:00
Reload TMUX environment so TPM is sourced:
# type this in terminal
2015-07-06 19:46:53 -04:00
$ tmux source ~/.tmux.conf
2014-05-19 05:17:58 -04:00
That's it!
2015-07-06 19:46:53 -04:00
(**Note:** using `set -g @tpm_plugins` is deprecated, but still works alongside
new syntax)
2014-05-19 05:17:58 -04:00
### Installing plugins
2015-07-06 19:46:53 -04:00
1. add new plugin to `.tmux.conf` with `set -g @plugin '...'`
2. hit `prefix + I` (I as in **I**nstall) to fetch the plugin
2014-05-19 05:17:58 -04:00
You're good to go! The plugin was cloned to `~/.tmux/plugins/` dir and sourced.
### Uninstalling plugins
2015-07-06 19:46:53 -04:00
1. remove (or comment out) plugin from the list
2. hit `prefix + alt + u` (u as in **u**install) to remove the plugin
2015-06-02 15:36:35 -04:00
2015-07-06 19:46:53 -04:00
All the plugins are installed to `~/.tmux/plugins/` so alternatively you can
2015-06-02 15:36:35 -04:00
find plugin directory there and remove it.
2014-05-19 05:17:58 -04:00
### Key bindings
2014-08-05 15:04:17 -04:00
`prefix + I`
- installs new plugins from github or any other git repo
2014-05-19 05:17:58 -04:00
- refreshes TMUX environment
2014-08-05 15:04:17 -04:00
`prefix + U`
- updates plugin(s)
2014-05-19 05:17:58 -04:00
`prefix + alt + u`
2015-07-06 19:46:53 -04:00
- uninstall plugins that are not on the plugin list
2015-07-06 19:46:53 -04:00
### More plugins
2014-05-19 05:17:58 -04:00
2014-08-02 14:57:42 -04:00
For more plugins, check [here](https://github.com/tmux-plugins).
2014-05-21 05:14:23 -04:00
2015-07-10 11:05:09 -04:00
### Docs
2014-10-17 17:16:02 -04:00
2015-07-10 11:05:09 -04:00
More advanced features and instructions, regular users probably do not need
this:
2014-10-17 17:16:02 -04:00
2015-07-10 11:05:09 -04:00
- [How to create a plugin](docs/how_to_create_plugin.md). It's easy.
2015-07-10 11:10:37 -04:00
- [Installing plugins via the command line](docs/installing_plugins_via_cmd_line.md)
- [Changing plugins install dir](docs/changing_plugins_install_dir.md)
- [Automatic TPM installation](docs/automatic_tpm_installation.md)
2014-05-21 06:29:20 -04:00
2014-07-17 16:56:02 -04:00
### Tests
2015-07-06 19:46:53 -04:00
Tests for this project run on [travis](https://travis-ci.org/tmux-plugins/tpm).
2014-07-17 16:56:02 -04:00
2014-11-19 09:58:12 -05:00
When run locally, [vagrant](https://www.vagrantup.com/) is required.
Run tests with:
2014-07-17 16:56:02 -04:00
2014-11-19 09:58:12 -05:00
# within project directory
2014-07-17 16:56:02 -04:00
$ ./run-tests
### Other goodies
- [tmux-copycat](https://github.com/tmux-plugins/tmux-copycat) - a plugin for
regex searches in tmux and fast match selection
- [tmux-yank](https://github.com/tmux-plugins/tmux-yank) - enables copying
highlighted text to system clipboard
- [tmux-open](https://github.com/tmux-plugins/tmux-open) - a plugin for quickly
opening highlighted file or a url
- [tmux-continuum](https://github.com/tmux-plugins/tmux-continuum) - automatic
restoring and continuous saving of tmux env
You might want to follow [@brunosutic](https://twitter.com/brunosutic) on
twitter if you want to hear about new tmux plugins or feature updates.
2014-05-19 05:17:58 -04:00
### License
[MIT](LICENSE.md)