Prerelease This site documents an alpha of libtmux. Its structure, URLs and APIs are subject to change.

Find saved workspaces

Edit this page on GitHub

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.

Use an explicit YAML or JSON file path when you need an unambiguous input. A directory resolves its project configuration, and a saved name resolves through the tmuxp configuration roots.

Global directoriesLink to section

An existing TMUXP_CONFIGDIR takes precedence, followed by the XDG configuration directory and then the legacy ~/.tmuxp directory. A nonexistent explicit directory does not automatically win discovery. See environment for the relevant variables.

Project filesLink to section

Project discovery walks from the current directory toward its ancestors, stopping at home or the filesystem root. It selects at most one candidate per directory, preferring .tmuxp.yaml, then .tmuxp.yml, then .tmuxp.json. Nearer directories come first. It does not recursively enumerate child projects.

Load the current project’s configuration:

Terminal window
$ tmuxp load .

The normal command can attach or prompt. Use -d when you want detached execution and select -L or -S for an isolated server. ls, search, and edit use the same discovery concepts with their own result and error behavior.

tmuxp reference source.

Esc

Type to search.