1
0
Fork 0
mirror of synced 2024-05-30 14:01:10 -04:00
tpm/README.md

104 lines
2.9 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
Put this at the bottom of your `.tmux.conf` (backslashes at the end of the lines
are required):
# List of plugins
2014-11-19 20:28:20 -05:00
# Supports `github_username/repo` or full git repo URLs
set -g @tpm_plugins ' \
2014-08-02 06:29:07 -04:00
tmux-plugins/tpm \
tmux-plugins/tmux-sensible \
2014-11-19 20:28:20 -05:00
'
2014-05-19 05:27:10 -04:00
# Other examples:
# github_username/plugin_name \
# git@github.com/user/plugin \
# git@bitbucket.com/user/plugin \
2014-05-19 05:17:58 -04:00
# Initializes TMUX plugin manager.
# Keep this line at the very bottom of tmux.conf.
2014-11-19 20:28:20 -05:00
run-shell '~/.tmux/plugins/tpm/tpm'
2014-05-19 05:17:58 -04:00
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 *I*nstall) to fetch the plugin
You're good to go! The plugin was cloned to `~/.tmux/plugins/` dir and sourced.
### Uninstalling plugins
2014-09-28 18:07:06 -04:00
1. remove plugin from `@tpm_plugins` list
2. All the plugins are installed to `~/.tmux/plugins/`. Find plugin
directory there and just 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
### List of plugins
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
2014-10-17 17:16:02 -04:00
### Wiki pages
More advanced features, regular users probably do not need this:
- [installing plugins via the command line](https://github.com/tmux-plugins/tpm/wiki/Installing-plugins-via-the-command-line-only)
- [changing plugins install dir](https://github.com/tmux-plugins/tpm/wiki/Changing-plugins-install-dir)
2014-05-19 05:17:58 -04:00
### Creating plugins
2014-05-21 06:29:20 -04:00
[How to create a plugin](HOW_TO_PLUGIN.md). It's easy.
2014-07-17 16:56:02 -04:00
### Tests
2014-11-19 09:58:12 -05:00
Tests 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)