Need help with tpm?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

tmux-plugins
6.6K Stars 242 Forks MIT License 193 Commits 74 Opened issues

Description

Tmux Plugin Manager

Services available

!
?

Need anything else?

Contributors list

No Data

Tmux Plugin Manager

Build Status

Installs and loads

tmux
plugins.

Tested and working on Linux, OSX, and Cygwin.

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

~/.tmux.conf
(
$XDG_CONFIG_HOME/tmux/tmux.conf
works too):
# List of plugins
set -g @plugin 'tmux-plugins/tpm'
set -g @plugin 'tmux-plugins/tmux-sensible'

Other examples:

set -g @plugin 'github_username/plugin_name'

set -g @plugin '[email protected]:user/plugin'

set -g @plugin '[email protected]:user/plugin'

Initialize TMUX plugin manager (keep this line at the very bottom of tmux.conf)

run '~/.tmux/plugins/tpm/tpm'

Reload TMUX environment so TPM is sourced:

# type this in terminal if tmux is already running
$ tmux source ~/.tmux.conf

That's it!

Installing plugins

  1. Add new plugin to
    ~/.tmux.conf
    with
    set -g @plugin '...'
  2. Press
    prefix
    + I (capital i, as in Install) to fetch the plugin.

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
    + alt + u (lowercase u as in uninstall) to remove the plugin.

All the plugins are installed to

~/.tmux/plugins/
so alternatively you can find plugin directory there and remove it.

Key bindings

prefix
+ I - Installs new plugins from GitHub or any other git repository - Refreshes TMUX environment

prefix
+ U - updates plugin(s)

prefix
+ alt + u - remove/uninstall plugins not on the plugin list

More plugins

For more plugins, check here.

Docs

More advanced features and instructions, regular users probably do not need this:

Tests

Tests for this project run on Travis CI.

When run locally, vagrant is required. Run tests with:

# within project directory
$ ./run_tests

Other goodies

  • tmux-copycat - a plugin for regex searches in tmux and fast match selection
  • tmux-yank - enables copying highlighted text to system clipboard
  • tmux-open - a plugin for quickly opening highlighted file or a url
  • tmux-continuum - automatic restoring and continuous saving of tmux env

License

MIT

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.