Commands¶

General commands

Configuration

Diagnostic

tmuxp debug-info

Completion

Completions

Main command¶

The tmuxp command is the entry point for all tmuxp operations. Use subcommands to load sessions, manage configurations, and interact with tmux.

Command¶

tmuxp - tmux session manager.

Manage and launch tmux sessions from YAML/JSON workspace files.

Usage¶

usage: tmuxp [-h] [--version] [--log-level log-level]
             [--color {auto,always,never}]
             {load,shell,import,convert,debug-info,ls,search,edit,freeze} ...

Load Examples¶

$ tmuxp load myproject

$ tmuxp load ./workspace.yaml

$ tmuxp load -d myproject

$ tmuxp load -y dev staging

Freeze Examples¶

$ tmuxp freeze mysession

$ tmuxp freeze mysession -o session.yaml

Ls Examples¶

$ tmuxp ls

$ tmuxp ls --tree

$ tmuxp ls --full

$ tmuxp ls --json

Search Examples¶

$ tmuxp search dev

$ tmuxp search name:myproject

$ tmuxp search -i DEV

$ tmuxp search --json dev

Shell Examples¶

$ tmuxp shell

$ tmuxp shell -L mysocket

$ tmuxp shell -c 'print(server.sessions)'

Convert Examples¶

$ tmuxp convert workspace.yaml

$ tmuxp convert workspace.json

Import Examples¶

$ tmuxp import teamocil ~/.teamocil/project.yml

$ tmuxp import tmuxinator ~/.tmuxinator/project.yml

Edit Examples¶

$ tmuxp edit myproject

Debug-Info Examples¶

$ tmuxp debug-info

$ tmuxp debug-info --json

Options¶

--version, -V¶

show program's version number and exit

--log-level log-level¶

log level (debug, info, warning, error, critical) (default "info")

Default: info | Choices: debug, info, warning, error, critical

--color¶

when to use colors: auto (default), always, or never

Default: auto | Choices: auto, always, never