Workspace environment

tmux-workspace 0.1.2 · 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¶

Names, directories, options and environment values expand defined variables from the loader process. Command and launch-shell text keep their expressions for the pane shell; referenced loader variables are supplied to that pane unless the document already sets them. Shell quoting therefore remains meaningful.

Loader settings¶

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

CLI source.