Workspace command reference
LibTmux.Workspace 0.0.0-alpha.14 · Source
tmuxp compatibility reference. Examples using tmuxp run the Python reference. Local CLI status describes this port’s implemented coverage.
The installed Python command is tmuxp. Native command names and installation
artifacts are not established by this documentation prototype. The pages below
document the Python reference grammar and identify native extensions.
CommandsLink to section
- load builds sessions from files or saved workspace names.
- freeze captures a live session to a workspace file.
- convert changes YAML and JSON representation.
- edit opens a resolved workspace in an editor.
- ls lists discovered configurations.
- search searches their names and content.
- debug-info reports runtime and tmux diagnostics.
- shell evaluates Python with tmux context.
- import selects Teamocil or tmuxinator conversion.
Root optionsLink to section
-h / --help shows help; -V / --version prints the version. --log-level
selects "debug", "info", warning, "error", or critical, with parser default
warning. --color accepts auto, always, or never, defaulting to auto.
Place root flags before the subcommand:
$ tmuxp --color never lsShort flags belong to their command: search -S is smart case, while load -S
selects a tmux socket path. Similarly, -f selects a tmux configuration for
load, a field for search, and an output format for freeze.
Machine mode and automationLink to section
Current Python machine output exists on ls, search, and debug-info as
described by their own flags. The native command tree adds --json and
--ndjson to every leaf and allows these long options before or after the
command. These additions are not installed Python features.
Read output and color, exit behavior, completion, and automation before building a script around a command.