tpm/README.md

94 lines
2.4 KiB
Markdown
Raw Normal View History

2014-05-19 05:17:58 -04:00
# Tmux Plugin Manager
Installs and loads TMUX plugins.
### Installation
Requirements: `tmux` version 1.9 (or higher), `git`
2014-05-19 05:22:16 -04:00
2014-05-19 05:17:58 -04:00
Clone TPM:
$ git clone https://github.com/bruno-/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 " \
bruno-/tpm \
2014-05-21 05:22:30 -04:00
bruno-/tmux_pain_control \
2014-05-19 05:17:58 -04: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
2014-05-19 05:27:10 -04: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.
### 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
- [pain control](https://github.com/bruno-/tmux_pain_control) - useful standard
bindings for controlling panes
2014-06-03 05:40:02 -04:00
- [goto session](https://github.com/bruno-/tmux_goto_session) - faster session
switching
2014-06-03 05:40:02 -04:00
- [battery osx](https://github.com/bruno-/tmux_battery_osx) - battery status
for OSX in Tmux `status-right`
2014-06-03 05:40:02 -04:00
- [logging](https://github.com/bruno-/tmux_logging) - easy logging and
screen capturing
- [online status](https://github.com/bruno-/tmux_online_status) - online status
indicator in Tmux `status-right`. Useful when on flaky connection to see if
you're online.
2014-05-21 05:14:23 -04:00
If you create a plugin, feel free to create a pull request that adds it to the
list.
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
Requirements: [vagrant](https://www.vagrantup.com/)
Running the test suite:
$ ./run-tests
### About
Truth be told, there aren't too many TMUX plugins out there. People mostly just
copy code snippets from each others' `.tmux.conf` files.
I hope TMUX plugin manager (TPM) inspires people to do better and more creative
2014-07-17 16:56:02 -04:00
things with TMUX.
2014-05-19 05:17:58 -04:00
### License
[MIT](LICENSE.md)