Workspace ManagerConfiguration

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

Files and directories

LibTmux.Workspace 0.0.0-alpha.20 · Source

Use an explicit file path when debugging workspace discovery. A directory such as . selects a project configuration; a saved name selects a global workspace. See finding workspaces for that lookup order.

Set a starting directory

directories.yaml
session_name: directories-example
start_directory: ./
windows:
- window_name: shell
start_directory: ./
panes:
- start_directory: ./
shell_command: pwd

An explicit relative session directory starts from the configuration file’s directory. Child directories resolve through their parent configuration. Use absolute paths when a workspace deliberately points outside its project.

Quote home shortcuts in YAML, such as "~/src/project"; an unquoted ~ is a null value. An omitted directory lets the loader and tmux use their invocation context. The explicit relative directory in this example selects the file’s project context.

Verify the running pane

A saved path can be absent on another machine. Inspect the real pane directory after loading rather than relying on successful YAML parsing. tmux can fall back to a home directory when a requested path does not exist.

Bootstrap paths and process working directories have separate rules. See before scripts before using one to create directories.

CLI source.

Esc

Type to search.