GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — GitHub - tmux-plugins/tpm: Tmux Plugin Manager

BranchesTags
Open more actions menu

Latest commit

 

History

216 Commits
216 Commits

Folders and files

NameName
Last commit message
Last commit date
bin
bin
 
 
bindings
bindings
 
 
docs
docs
 
 
lib
lib
 
 
scripts
scripts
 
 
tests
tests
 
 
.gitattributes
.gitattributes
 
 
.gitignore
.gitignore
 
 
.gitmodules
.gitmodules
 
 
.travis.yml
.travis.yml
 
 
CHANGELOG.md
CHANGELOG.md
 
 
HOW_TO_PLUGIN.md
HOW_TO_PLUGIN.md
 
 
LICENSE.md
LICENSE.md
 
 
README.md
README.md
 
 
tpm
tpm
 
 

Repository files navigation

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

  • 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

Docs

  • Help, tpm not working - problem solutions

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

  • How to create a plugin. It's easy.
  • Managing plugins via the command line
  • Changing plugins install dir
  • Automatic TPM installation on a new machine

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

About

Tmux Plugin Manager

Resources

Readme
MIT license
Activity
Custom properties

Stars

15.2k stars

Watchers

84 watching

Forks

504 forks
Report repository

Releases

Packages

Used by

Contributors

Languages

You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.