tpm/README.md

73 lines
1.6 KiB
Markdown
Raw Normal View History

2014-05-19 09:17:58 +00:00
# Tmux Plugin Manager
Installs and loads TMUX plugins.
### Installation
Requirements: `tmux` version 1.9 (or higher), `git`
2014-05-19 09:22:16 +00:00
2014-05-19 09:17:58 +00:00
Clone TPM:
$ git clone https://github.com/tmux-plugins/tpm ~/.tmux/plugins/tpm
2014-05-19 09:17:58 +00:00
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 URLs
set -g @tpm_plugins " \
2014-08-02 10:29:07 +00:00
tmux-plugins/tpm \
tmux-plugins/tmux-sensible \
2014-05-19 09:17:58 +00:00
"
2014-05-19 09:27:10 +00:00
# Other examples:
# github_username/plugin_name \
# git@github.com/user/plugin \
# git@bitbucket.com/user/plugin \
2014-05-19 09:17:58 +00:00
# initializes TMUX plugin manager
2014-05-19 09:27:10 +00:00
run-shell ~/.tmux/plugins/tpm/tpm
2014-05-19 09:17:58 +00: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.
### Key bindings
TPM provides only 1 key binding: `prefix + I`. Here's what it does:
- clones new plugins from github or any other git repo
- pulls updates for already installed plugins
- refreshes TMUX environment
After you press `prefix + I`, everything should be up to date.
### List of plugins
2014-08-02 18:57:42 +00:00
For more plugins, check [here](https://github.com/tmux-plugins).
2014-05-21 09:14:23 +00:00
2014-05-19 09:17:58 +00:00
### Creating plugins
2014-05-21 10:29:20 +00:00
[How to create a plugin](HOW_TO_PLUGIN.md). It's easy.
2014-07-17 20:56:02 +00:00
### Tests
Requirements: [vagrant](https://www.vagrantup.com/)
2014-07-17 21:19:27 +00:00
To run a test suite:
2014-07-17 20:56:02 +00:00
$ ./run-tests
2014-05-19 09:17:58 +00:00
### License
[MIT](LICENSE.md)