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 里面的？它是一个小型 shell 脚本，你需要在 ~/.tmux.conf 中 source 它；无需单独启动任何程序，所有操作都通过 tmux 的快捷键完成。
我要怎么用它安装插件？克隆 TPM，在 ~/.tmux.conf 底部添加它的 source 语句行，重新加载 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