Fork 0
mirror of synced 2024-06-18 23:11:09 -04:00
Tmux Plugin Manager
Go to file
2014-07-17 22:40:56 +02:00
scripts Switching to tab indentation 2014-05-24 23:15:13 +02:00
test Add test readme 2014-07-17 22:40:56 +02:00
.gitignore First version of tests 2014-07-17 20:36:54 +02:00
CHANGELOG.md Fix bug: tpm shared path is created before sync 2014-05-24 15:36:31 +02:00
HOW_TO_PLUGIN.md Improvements to the list of plugins 2014-05-21 12:52:54 +02:00
LICENSE.md Add README and license 2014-05-19 11:43:00 +02:00
PLUGINS.md Update plugins list 2014-05-28 13:59:04 +02:00
README.md Add tmux online status to the plugin list 2014-06-03 12:17:40 +02:00
tpm Switching to tab indentation 2014-05-24 23:15:13 +02:00

Tmux Plugin Manager

Installs and loads TMUX plugins.


Requirements: git

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                       \
  bruno-/tmux_pain_control         \
# Other examples:
# github_username/plugin_name    \
# git@github.com/user/plugin     \
# git@bitbucket.com/user/plugin  \

# initializes TMUX plugin manager
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 Install) 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 - useful standard bindings for controlling panes
  • goto session - faster session switching
  • battery osx - battery status for OSX in Tmux status-right
  • logging - easy logging and screen capturing
  • online status - online status indicator in Tmux status-right. Useful when on flaky connection to see if you're online.

If you create a plugin, feel free to create a pull request that adds it to the list.

Creating plugins

How to create a plugin. It's easy.


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 things with TMUX. See also instructions how to create your own plugin.