Workspace ManagerGuides

Choose documentation 3

latest

Current version

latest
English

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

Edit this page on GitHub

Find saved workspaces

LibTmux.Workspace 0.0.0-alpha.20 · Source

Use an explicit path, such as ./workspace.yaml, to select one document. Pass a project directory such as . to use its .tmuxp.yaml, .tmuxp.yml or .tmuxp.json configuration. A bare saved name uses the global workspace directory.

List available files

Terminal window
$ tmux-workspace ls --json

Discovery includes project configurations in the current directory and its parents, plus saved global workspaces. The first existing global directory wins, in this order:

  1. TMUXP_CONFIGDIR.
  2. $XDG_CONFIG_HOME/tmuxp, with ~/.config as the XDG default.
  3. ~/.tmuxp.

An existing empty directory remains selected. A missing directory does not override an existing fallback merely because its environment variable is set.

Search by content

Terminal window
$ tmux-workspace search --json window:editor

Use search for field prefixes and pattern rules. Use edit to open a discovered workspace, or load with an explicit path when a name is ambiguous.

CLI source.

Esc

Type to search.