Workspace files and directories

Edit this page on GitHub

workspace consumer 0.1.0-alpha.10 · Source

tmuxp compatibility reference. Examples using tmuxp run the Python reference. Local CLI status describes this port’s implemented coverage.

Tmuxp accepts an explicit workspace file, a saved workspace name, or a project directory. The location of the selected file determines how config-relative paths expand. Use an explicit file while debugging a discovery problem.

Load a file on a dedicated server:

$ tmuxp load \
    -L directory-example \
    -d \
    ./workspace.yaml

Load the current project’s workspace:

$ tmuxp load .

These commands use Python tmuxp and assume the corresponding workspace file already exists. The first command leaves its session detached; use the session name from the file when inspecting or cleaning it up.

Global and local discoveryLink to section

For the preferred global workspace directory, tmuxp tries TMUXP_CONFIGDIR, XDG_CONFIG_HOME/tmuxp (or the XDG default), then the legacy ~/.tmuxp directory. It chooses the first existing directory. If none exists, it returns the legacy location. Setting TMUXP_CONFIGDIR to a nonexistent path does not automatically select that path over an existing fallback.

Project discovery walks the current directory and its parents, choosing at most one workspace per directory in .tmuxp.yaml, .tmuxp.yml, .tmuxp.json order. It stops at home or filesystem root. ls can report global directory candidates and locally discovered workspaces; that inventory is not identical to resolving one explicit load argument.

The importers use their own source roots: Teamocil uses ~/.teamocil; tmuxinator uses TMUXINATOR_CONFIG, with tilde expansion, or ~/.tmuxinator. Their source argument is effectively required, even though the parser’s positional arity looks optional.

Start directoriesLink to section

session_name: directory-example
start_directory: ./
windows:
  - window_name: root
    panes:
      - pwd
  - window_name: child
    start_directory: ./src
    panes:
      - pwd
      - start_directory: ./
        shell_command: pwd

This example assumes the project has a "src" directory. The first window inherits the session directory. The child window resolves ./src against the explicit session directory, and its second pane resolves ./ against that window directory. Both child panes start in src.

The root start_directory resolves a dot-relative path from the configuration file’s directory. At child levels, the pinned loader resolves dot-relative paths against the immediate parent’s start_directory before inherited defaults are filled. Define that parent value explicitly when using ./ or ../ in a child. A missing parent start_directory can raise KeyError during expansion.

A plain relative window directory such as src is joined to the session directory later, during trickle. A dot-relative pane under that still-relative window can resolve against the invoking process’s current directory first. Use an explicit ./src window value as above, or an absolute path, to avoid that inconsistency. Native normalization that resolves every child consistently would correct this reference behavior.

When a document names no start_directory at any level, panes start in the directory the command was run from, not the directory the workspace file lives in. That is what tmuxp does, and all eight implementations agree on it. An explicit relative value such as ./src is the other case: it always resolves against the workspace file’s directory, at every level, so a workspace stays portable no matter where it is loaded from.

Absolute and expanded-home paths retain their explicit location. Quote ~ in YAML to avoid its null spelling. A pane override also applies to the first pane in the Python classic builder. Inspect resolved values and the resulting pane directory when loading a workspace from a different working directory.

Missing directories and bootstrapLink to section

A nonexistent path can make tmux start somewhere unexpected, including a home directory, rather than producing a useful configuration error. Inspect the actual pane directory when verifying a workspace. Native ports may reject, retain, report, or pass through the value differently.

A relative before_script path is resolved from the workspace file. Its process working directory uses the session start_directory when supplied. A bootstrap process can create required project files, but it runs after the initial tmux session exists. See hooks for failure handling and environment for variable expansion.

Current C++ builderLink to section

The model carries directories; config discovery and all tmuxp expansion rules are not a CLI feature here. Open a core server handle against the intended live endpoint before using the consumer.

See the native builder behavior and configuration source before using these fields through application code.

Reference sourceLink to section

finders.py; loader.py; import_config.py; classic.py; start-directory.yaml.