Tmux plugin manager - [ Ellipsis extension ]
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin
docs
src
test
.gitignore
.travis.yml
LICENSE
Makefile
README.md
ellipsis.sh
mkdocs.yml

README.md

Ellipsis-TPM Build Status Documentation status Latest tag Gitter chat

Tmux plugin manager

Ellipsis-TPM is an Ellipsis extension to manage Tmux plugins. It can be used as replacement for TPM.

Features

  • Easy plugin management.
  • Easy plugin loading.
  • Compatible with existing plugins written for TPM!
  • No Tmux version restrictions!
  • Can be used without Tmux running.
  • Supports custom config file locations.
  • Supports branch based installs

Install

Requirements: Ellipsis

# With ellipsis installed
$ ellipsis install ellipsis-tpm

# Without ellipsis installed
$ curl -Ls ellipsis.sh | PACKAGES='ellipsis-tpm' sh

The .ellipsis/bin folder should be added to your path. If it isn't you will need to symlink .ellipsis/bin/ellipsis-tpm to a folder that is in your path.

Usage

Add your plugins in your .tmux.conf file.

# List of plugins
set -g @plugin 'tmux-plugins/tmux-resurrect'
set -g @plugin 'tmux-plugins/tmux-yank'

# Other examples
# set -g @plugin 'github_username/plugin_name'
# set -g @plugin 'github_username/plugin_name@branch_name'
# set -g @plugin 'http://github.com/user/plugin'
# set -g @plugin 'https://github.com/user/plugin'
# set -g @plugin 'git://github.com/user/plugin'
# set -g @plugin 'ssh://git@github.com/user/plugin'
# set -g @plugin 'https://gitlab.com/user/plugin'

# Initialize the manager (loads all plugins)
run 'ellipsis-tpm run'

After you modified your config file you can either source it again or run ellipsis-tpm run manually in your terminal.

Installing plugins

  • Add the plugins to your config file with set -g @plugin '...'
  • Press prefix + I to install newly added plugins or run ellipsis-tpm install in your terminal

Only testing a plugin? Run ellipsis-tpm install <plugin_url> to quickly install it!

Uninstalling plugins

  • Remove from your config file or comment out.
  • Press prefix + alt + u or run ellipsis-tpm clean in your terminal

Remove a specific plugin? Run ellipsis-tpm uninstall <plugin_name>.

Updating plugins

  • Press prefix + U or run ellipsis-tpm update in your terminal.

Update a specific plugin? Just run ellipsis-tpm update <plugin_name>

Docs

Please consult the docs for more information.

specific parts that could be off interest:

Development

Pull requests welcome! New code should follow the existing style (and ideally include tests).

Suggest a feature or report a bug? Create an issue!

Author(s)

You can thank these people for all there hard work.

License

Ellipsis-TPM is open-source software licensed under the MIT license.