Tmux Plugin Manager
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
tpm/README.md

90 lines
2.2 KiB

# Tmux Plugin Manager
9 years ago
![Build Status](https://travis-ci.org/tmux-plugins/tpm.png?branch=master)
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 URLs
set -g @tpm_plugins " \
9 years ago
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 *I*nstall) to fetch the plugin
You're good to go! The plugin was cloned to `~/.tmux/plugins/` dir and sourced.
### Uninstalling plugins
9 years ago
1. remove plugin from `@tpm_plugins` list
2. All the plugins are installed to `~/.tmux/plugins/`. Find plugin
directory there and just remove it.
### Key bindings
`prefix + I`
- installs new plugins from github or any other git repo
- refreshes TMUX environment
`prefix + U`
- updates plugin(s)
### List of plugins
For more plugins, check [here](https://github.com/tmux-plugins).
### 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)
### Creating plugins
[How to create a plugin](HOW_TO_PLUGIN.md). It's easy.
### Tests
9 years ago
Tests run on [travis](https://travis-ci.org/tmux-plugins/tpm).
9 years ago
When run locally, [vagrant](https://www.vagrantup.com/) is required.
Run tests with:
9 years ago
# within project directory
$ ./run-tests
### License
[MIT](LICENSE.md)