Skip to content

Quick start

Install tpane:

sh
curl -fsSL https://raw.githubusercontent.com/phcurado/tpane/main/install.sh | sh

Add tpane at the end of your tmux config:

text
run-shell -b 'tpane'

tmux 3.2 and newer reads either ~/.tmux.conf or $XDG_CONFIG_HOME/tmux/tmux.conf (usually ~/.config/tmux/tmux.conf).

Create ~/.config/tmux/tpane/init.lua:

lua
tpane.use("sensible")
tpane.use("themes")

tpane.theme("Catppuccin Mocha")

tpane.opt.mouse = true
tpane.opt.mode_keys = "vi"

tpane.bind("h", tpane.pane.select("left"))
tpane.bind("j", tpane.pane.select("down"))
tpane.bind("k", tpane.pane.select("up"))
tpane.bind("l", tpane.pane.select("right"))

tpane.statusline {
  position = "top",
  left = { tpane.widgets.session, tpane.widgets.tabs },
  right = { tpane.widgets.clock, tpane.widgets.date, tpane.widgets.prefix },
}

Source the tmux config you edited:

sh
tmux source-file ~/.config/tmux/tmux.conf # or: tmux source-file ~/.tmux.conf

Check the configuration from inside tmux:

sh
tpane status

A valid configuration prints ok.