Workspace environment

LibTmux.Workspace 0.0.0-alpha.20 · Source

The CLI’s process environment controls discovery and optional runtimes. Configuration environment maps provide variables to the workspace’s shells.

session_name: environment-example
environment:
  DOC_SESSION: session
windows:
  - window_name: shell
    environment:
      DOC_WINDOW: window
    panes:
      - environment:
          DOC_PANE: pane
        shell_command: 'printf "ENV=%s|%s|%s\n" "$DOC_SESSION" "$DOC_WINDOW" "$DOC_PANE"'
      - shell_command: 'printf "ENV=%s|%s|%s\n" "$DOC_SESSION" "$DOC_WINDOW" "$DOC_PANE"'

A pane map selects its launch environment in place of the window map. Session variables still apply. Repeat a window variable in the pane map when that pane needs it too. Avoid putting credentials in example files or diagnostic output.

Variable expressions¶

The loader expands defined variables in configuration values before delivery. An expression can therefore use the invoking process’s value before the pane shell reads it. Use explicit configuration variables and inspect resulting commands when moving a workspace between environments.

Loader settings¶

These are process settings, not workspace YAML keys. Read discovery, editing and shell inspection for their task-specific behavior.

CLI source.