CLI Reference¶
The tpack binary can be used directly from the command line, outside of tmux key bindings.
Commands¶
| Command | Description |
|---|---|
tpack install |
Install all plugins declared in tmux.conf |
tpack update [name...] |
Update one or more plugins by name, or all if all is given |
tpack clean |
Remove plugin directories not declared in tmux.conf |
tpack source |
Source all plugins without installing (useful for already-cloned plugins) |
tpack tui |
Open the interactive TUI (see flags below) |
tpack commits |
Show commit history for a plugin (internal, used by the TUI) |
tpack check-updates |
Check if any plugins have updates available |
tpack self-update |
Update the tpack binary to the latest release |
tpack version |
Print tpack version |
tpack init |
Initialize tpack (backward compatibility with TPM scripts) |
tpack completion [bash\|zsh\|fish] |
Generate shell completion scripts |
Examples¶
Install all declared plugins:
Update a single plugin:
Update all plugins:
Remove orphaned plugin directories:
TUI flags¶
tpack tui accepts a few flags used by the default key bindings and scripts:
| Flag | Description |
|---|---|
--popup |
Launch in a tmux popup window (requires tmux 3.2+; falls back to inline) |
--install |
Auto-run the install operation on open |
--update |
Auto-run the update operation on open |
--clean |
Auto-run the clean operation on open |
Example: open the TUI in a popup and start an update:
Shell Completions¶
Generate and install shell completion scripts for tab-completion support.
Zsh¶
Bash¶
# Linux:
tpack completion bash > /etc/bash_completion.d/tpack
# macOS:
tpack completion bash > $(brew --prefix)/etc/bash_completion.d/tpack
Fish¶
Completions include all commands, flags, and dynamic plugin name completion for tpack update and tpack commits --name.
Legacy shell scripts¶
For backward compatibility with TPM, tpack ships shell script wrappers in bin/. These work if tpack is installed via git clone to ~/.tmux/plugins/tpm: