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
Что это такое?TPM (Tmux Plugin Manager) устанавливает, загружает, обновляет и удаляет плагины tmux, чтобы вам не приходилось делать это вручную.
Это отдельная программа или она работает внутри tmux?Это небольшой скрипт для командной оболочки, который подключается из ~/.tmux.conf; отдельной программы для запуска нет, всем управляете полностью через сочетания клавиш tmux.
Как с его помощью установить плагины?Клонируйте TPM, добавьте для него строку source в конец ~/.tmux.conf, перезагрузите tmux, затем добавьте строки `set -g @plugin '...'` для каждого плагина и нажмите prefix + I, чтобы загрузить их и подключить.
Что нужно установить перед использованием TPM?Нужны tmux версии 1.9 или выше, git и bash.
Работает ли это в Windows?Напрямую — нет, но он протестирован и работает в Linux, OSX и Cygwin, поэтому поддержка Windows обеспечивается через Cygwin.
Как обновлять или удалять плагины?Нажмите prefix + U, чтобы обновить все установленные плагины, или удалите плагин из списка в tmux.conf и нажмите prefix + alt + u, чтобы его удалить.
Где плагины сохраняются на диске?Все плагины клонируются в каталог ~/.tmux/plugins/, так что при необходимости ими можно управлять вручную прямо там.
Есть ли альтернатива TPM с более удобным интерфейсом?В README упоминается tpack — прямая замена TPM, которая добавляет текстовый интерфейс (TUI), автоматическое обновление и просмотр плагинов.
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