Note

tmuxp is usable but still needs your help reporting errors, bugs and usability feedback. If you encounter an error, please post on the Issue tracker.

Command Line Interface

Bash completion

For bash, .bashrc:

$ source tmuxp.bash

For tcsh, .tcshrc:

$ complete tmuxp 'p/*/`tmuxp.tcsh`/'

For zsh, .zshrc:

$ source tmuxp.zsh

Freeze sessions

You can save the state of your tmux session by freezing it.

Tmuxp will offer to save your session state to .json or .yaml.

usage: tmuxp freeze [-h] [-L socket-name] [-S socket-path] [-y]
                    session_name [session_name ...]

Positional arguments:
session_name Name of session
Options:
-L socket name of tmux server. Same as tmux.
-S socket path of tmux server. Same as tmux.
-y Always answer yes.

Load session

Keep your configs in $HOME/.tmuxp for easy access and detection by Bash completion.

Files also may be loaded by absolute path.

$ tmuxp load <filename>

Files named .tmuxp.yaml or .tmuxp.json in the current working directory may be loaded with:

$ tmuxp load .
usage: tmuxp load [-h] [-L socket-name] [-S socket-path] [-y] [-2 | -8] [-d]
                  config [config ...]

Positional arguments:
config List config available in working directory and config folder.
Options:
-L socket name of tmux server. Same as tmux.
-S socket path of tmux server. Same as tmux.
-y Always answer yes.
-2 Force tmux to assume the terminal supports 256 colours.
-8 Like -2, but indicates that the terminal supports 88 colours.
-d Load a session without attaching to it.

Import

From teamocil

usage: tmuxp import teamocil [-h] (--list | config)

Positional arguments:
config Checks current ~/.teamocil and current directory for yaml files.
Options:
--list=False List configs in ~/.teamocil and current working directory.

From tmuxinator

usage: tmuxp import tmuxinator [-h] (--list | config)

Positional arguments:
config Checks current ~/.tmuxinator and current directory for yaml files.
Options:
--list=False List yaml configs in ~/.tmuxinator and current working directory.

Convert between YAML and JSON

tmuxp automatically will prompt to convert .yaml to .json and .json to .yaml.

usage: tmuxp convert [-h] config

Positional arguments:
config Absolute or relative path to config file.

Other commands

usage: tmuxp kill-session [-h] [-L socket-name] [-S socket-path] [-y]
                          session_name [session_name ...]

Positional arguments:
session_name Name of session
Options:
-L socket name of tmux server. Same as tmux.
-S socket path of tmux server. Same as tmux.
-y Always answer yes.
usage: tmuxp attach-session [-h] [-L socket-name] [-S socket-path] [-y]
                            [-2 | -8]
                            session_name [session_name ...]

Positional arguments:
session_name Name of session
Options:
-L socket name of tmux server. Same as tmux.
-S socket path of tmux server. Same as tmux.
-y Always answer yes.
-2 Force tmux to assume the terminal supports 256 colours.
-8 Like -2, but indicates that the terminal supports 88 colours.