tmuxp CLI manual

tmuxp 1.74.0 · Source

Use tmuxp to load, inspect and save workspace configurations. Install tmuxp separately from the core libtmux package.

Sessions¶

load

Build a session from files or saved workspace names.

freeze

Export a running session to a workspace configuration.

Workspace files¶

ls

List saved configurations.

search

Find configurations by name or content.

edit

Open a workspace in an editor.

convert

Change a workspace between YAML and JSON representation.

import

Translate Teamocil or tmuxinator configuration.

Diagnostics and shell¶

debug-info

Report runtime and tmux information.

shell

Evaluate Python with tmux context.

Command options¶

Root options precede the subcommand:

$ tmuxp --color never ls

Short flags belong to their command: $search -S selects smart-case matching, while load -S selects a socket path. Show the installed command options before using a flag:

$ tmuxp load --help

Machine output is command-specific. Read each command reference for its supported formats and empty-result behavior.

Command source.