muxi 0.3.1

Create bookmarks for your tmux sessions on the fly! 🚀
Documentation

Muxi

Create dynamic shortcuts for your tmux sessions!

Install

cargo install muxi

Configuration

In your tmux configuration:

if "type muxi" {
  run -b "muxi init"
}

Then provide a settings.toml in one of the following locations:

  • $MUXI_CONFIG_PATH
  • $XDG_CONFIG_HOME/muxi/
  • ~/.config/muxi/

Or run muxi config edit

muxi_prefix = "g"   # Muxi's table binding, `<prefix>g`
tmux_prefix = true  # Optional: Use <prefix> to define muxi's table (default: true)

# Optional bindings to be created on tmux's muxi table
[bindings]
e = { popup = true, command = "muxi sessions edit" }  # <prefix>ge => open a tmux popup to edit your sessions file
l = { command = "muxi sessions list" }  # <prefix>gl => tmux run-shell <command>

M-Space = { command = "tmux switch-client -l" }  # Binding tmux commands

# Quick session bindings (like vim's harpoon)
J = { command = "muxi sessions set j && tmux display 'bound current session to j'" }
K = { command = "muxi sessions set k && tmux display 'bound current session to k'" }
L = { command = "muxi sessions set l && tmux display 'bound current session to l'" }

Sessions

Running muxi sessions edit will open your sessions.toml file, which should look something like the following:

# <key> = { name = <session_name>, path = <session_path> }
d = { name = "dotfiles", path = "~/.dotfiles" }
m = { name = "muxi", path = "~/Sites/rust/muxi/" }
n = { name = "notes", path = "~/Library/Mobile Documents/com~apple~CloudDocs/notes" }

This is the file that muxi will use to generate your session bindings and keep state