zim-tmuxp

A zimfw zmodule that wraps tmuxp and tmux to provide a fast, convenient, and functional mux command (similar to tmuxinator).

This plugin loads conditionally: it will only load and define the mux command if both tmux and tmuxp are installed and available in your $PATH. Otherwise, it does not autoload or expose any functions or aliases, keeping your shell environment clean.

Installation

Add the following to your ~/.zimrc:

zmodule psi-jack/zim-tmuxp

Then run:

zimfw install

Usage

The mux command provides several subcommands:

Command	Action	Description
mux start [<args>] <name>	tmuxp load [<args>] <name>	Loads the specified configuration.
mux stop <name>	tmux kill-session -t <session>	Stops the running session (resolving session_name from yaml/json config or falling back to <name>).
mux stop-all	tmux kill-session -t ...	Stops all active tmux sessions.
mux list / ls	Listing configurations	Lists all configured tmuxp sessions in ~/.config/tmuxp/ and ~/.tmuxp/, indicating which are currently active.
mux edit / new <name>	$EDITOR ~/.config/tmuxp/<name>.yaml	Opens the configuration in your $EDITOR. Creates the file with a starting skeleton template if it does not exist.
mux delete / rm <name>	rm ~/.config/tmuxp/<name>.yaml	Deletes the configuration file after confirmation.
mux help	Help output	Shows help information.

Autocomplete

This module includes a built-in Zsh completion script for the mux command, providing completion suggestions for all subcommands and configurations matching your YAML/YML/JSON files in ~/.config/tmuxp/ and ~/.tmuxp/.