tpm README

The project's README from github.com/tmux-plugins/tpm. As one markdown file: README.md.

Tmux Plugin Manager

Build Status

Installs and loads tmux plugins.

Tested and working on Linux, OSX, and Cygwin.

See list of plugins here.

Also, check out tpack, drop-in replacement for tpm with a TUI, auto-updates and plugins browser.

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 'github_username/plugin_name#branch'
# 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

prefix + U

prefix + alt + u

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

License

MIT

tpm (tmux-plugins/tpm)

Searching Database…

15.1K ·GitHub
Tpm
What is this?TPM (Tmux Plugin Manager) installs, loads, updates, and removes tmux plugins so you don't have to manage them by hand.
Is this a standalone app or does it live inside tmux?It's a small shell script that you source from your ~/.tmux.conf; there's no separate program to launch, you control it entirely through tmux key bindings.
How do I install plugins with it?Clone TPM, add a source line for it at the bottom of ~/.tmux.conf, reload tmux, then add `set -g @plugin '...'` lines for each plugin and press prefix + I to fetch and source them.
What do I need installed before using TPM?You need tmux 1.9 or higher, git, and bash.
Does it work on Windows?Not natively, but it's tested and working on Linux, OSX, and Cygwin, so Windows support comes through Cygwin.
How do I update or remove plugins?Press prefix + U to update all installed plugins, or remove a plugin from the list in tmux.conf and press prefix + alt + u to uninstall it.
Where do plugins get installed on disk?All plugins are cloned into the ~/.tmux/plugins/ directory, so you can also manage them manually there if needed.
Is there an alternative to TPM with a nicer interface?The README points to tpack, a drop-in replacement for TPM that adds a TUI, auto-updates, and a plugin browser.
What are similar projects?oh-my-fish, vim-plug, tmuxinator, direnv, lazy.nvim, vim-pathogen, dotfiles, tmux-resurrect
Which topics is it in?plugin-manager, tmux, dotfiles, configuration, bash, package-manager, git, shell, utility, plugin, terminal, automation
Creator
tmux-plugins
Size
0.2 MB
Stars
15.1K
Updated
CommitMay 17
Age
12y
Commits · 90 Days