1
0
Fork 0
mirror of synced 2024-07-20 19:40:36 -04:00
tpm/README.md

102 lines
2.6 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.svg?branch=master)](https://travis-ci.org/tmux-plugins/tpm)
2014-11-19 09:58:12 -05:00
Installs and loads `tmux` plugins.
2014-05-19 05:17:58 -04:00
Tested and working on Linux, OSX, and Cygwin.
2021-01-19 07:55:49 -05:00
See list of plugins [here](https://github.com/tmux-plugins/list).
2014-05-19 05:17:58 -04:00
### 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:
```bash
$ git clone https://github.com/tmux-plugins/tpm ~/.tmux/plugins/tpm
```
2014-05-19 05:17:58 -04:00
2018-11-07 06:39:08 -05:00
Put this at the bottom of `~/.tmux.conf` (`$XDG_CONFIG_HOME/tmux/tmux.conf`
works too):
2014-05-19 05:17:58 -04:00
```bash
# List of plugins
set -g @plugin 'tmux-plugins/tpm'
set -g @plugin 'tmux-plugins/tmux-sensible'
2015-07-06 19:46:53 -04:00
# Other examples:
# set -g @plugin 'github_username/plugin_name'
2019-05-19 16:59:06 -04:00
# set -g @plugin 'github_username/plugin_name#branch'
# set -g @plugin 'git@github.com:user/plugin'
# set -g @plugin 'git@bitbucket.com:user/plugin'
2014-05-19 05:17:58 -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:
```bash
# type this in terminal if tmux is already running
$ tmux source ~/.tmux.conf
```
2014-05-19 05:17:58 -04:00
That's it!
### Installing plugins
1. Add new plugin to `~/.tmux.conf` with `set -g @plugin '...'`
2019-02-20 09:22:35 -05:00
2. Press `prefix` + <kbd>I</kbd> (capital 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
1. Remove (or comment out) plugin from the list.
2. Press `prefix` + <kbd>alt</kbd> + <kbd>u</kbd> (lowercase u as in **u**ninstall) 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
`prefix` + <kbd>I</kbd>
- Installs new plugins from GitHub or any other git repository
- Refreshes TMUX environment
2014-05-19 05:17:58 -04:00
`prefix` + <kbd>U</kbd>
2014-08-05 15:04:17 -04:00
- updates plugin(s)
2014-05-19 05:17:58 -04:00
`prefix` + <kbd>alt</kbd> + <kbd>u</kbd>
- remove/uninstall plugins not on the plugin list
2015-07-10 11:05:09 -04:00
### Docs
2014-10-17 17:16:02 -04:00
2015-08-10 14:18:32 -04:00
- [Help, tpm not working](docs/tpm_not_working.md) - problem solutions
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.
- [Managing plugins via the command line](docs/managing_plugins_via_cmd_line.md)
2015-07-10 11:10:37 -04:00
- [Changing plugins install dir](docs/changing_plugins_install_dir.md)
2015-07-10 11:14:13 -04:00
- [Automatic TPM installation on a new machine](docs/automatic_tpm_installation.md)
2014-05-21 06:29:20 -04:00
2014-07-17 16:56:02 -04:00
### Tests
Tests for this project run on [Travis CI](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
```bash
# within project directory
$ ./run_tests
```
2014-07-17 16:56:02 -04:00
2014-05-19 05:17:58 -04:00
### License
[MIT](LICENSE.md)