tmux session manager¶

We need help! tmuxp is a trusted session manager for tmux. If you could lend your time to helping answer issues and QA pull requests, please do! See issue #290!

New to tmux? The Tao of tmux is available on Leanpub and Amazon Kindle. Read and browse the book for free on the web.

Installation¶ $ pip install --user tmuxp

Load a tmux session¶ Load tmux sessions via json and YAML, tmuxinator and teamocil style. session_name : 4-pane-split windows : - window_name : dev window layout : tiled shell_command_before : - cd ~/ # run as a first command in all panes panes : - shell_command : # pane no. 1 - cd /var/log # run multiple commands in this pane - ls -al | grep \.log - echo second pane # pane no. 2 - echo third pane # pane no. 3 - echo forth pane # pane no. 4 Save as mysession.yaml, and load: $ tmuxp load ./mysession.yaml Projects with .tmuxp.yaml or .tmuxp.json load via directory: $ tmuxp load path/to/my/project/ Load multiple at once (in bg, offer to attach last): $ tmuxp load mysession ./another/project/ simple and very elaborate config examples

User-level configurations¶ tmuxp checks for configs in user directories: $TMUXP_CONFIGDIR , if set

, if set $XDG_CONFIG_HOME , usually $HOME/.config/tmuxp/

, usually $HOME/.config/tmuxp/ $HOME/.tmuxp/ Load your tmuxp config from anywhere by using the filename, assuming ~/.config/tmuxp/mysession.yaml (or .json): $ tmuxp load mysession See author’s tmuxp configs and the projects’ tmuxp.yaml.

Pre-load hook¶ Run custom startup scripts (such as installing project dependencies before loading tmux. See the bootstrap_env.py and before_script example

Load in detached state¶ You can also load sessions in the background by passing -d flag

Freeze a tmux session¶ $TMUXP_CONFIGDIR , if set

, if set $XDG_CONFIG_HOME , usually $HOME/.config/tmuxp/

, usually $HOME/.config/tmuxp/ $HOME/.tmuxp/ Load your tmuxp config from anywhere by using the filename, assuming ~/.config/tmuxp/mysession.yaml (or .json): $ tmuxp load mysession See author’s tmuxp configs and the projects’ tmuxp.yaml.

Pre-load hook¶ Run custom startup scripts (such as installing project dependencies before loading tmux. See the bootstrap_env.py and before_script example

Load in detached state¶ You can also load sessions in the background by passing -d flag

Freeze a tmux session¶ Snapshot your tmux layout, pane paths, and window/session names. $ tmuxp freeze session-name See more about freezing tmux sessions.