Workspace configuration

LibTmux.Workspace 0.0.0-alpha.20 · Source

A workspace document describes one tmux session. Save this as configuration.yaml:

session_name: configuration-example
windows:
  - window_name: editor
    layout: even-horizontal
    panes:
      - printf ready
      - null

Load it on the private socket from the installation walkthrough:

$ tmux-workspace load \
    -S "$WORKSPACE_TMP/tmux.sock" \
    -d \
    --json \
    configuration.yaml

The CLI parses the document and validates its execution fields before creating windows and sending commands. YAML and JSON use the same field names. A successful load means construction and command delivery completed; pane applications can still be starting or failing independently.

Choose the fields for your task¶

• Session sets the name, shared options and environment.
• Windows sets indexes, layouts and option timing.
• Panes defines commands, launch shells and focus.
• Commands controls ordering, Enter and delays.
• Environment separates loader settings from pane variables.
• Directories explains discovery and working directories.
• Layouts arranges the panes.
• Hooks runs checked bootstrap programs and optional extensions.

CLI and application code¶

These pages describe the tmux-workspace executable. Application code uses the separate workspace library, whose accepted fields and build semantics have their own contract. A successful generic conversion preserves document values; it does not validate that a loader can execute them.

CLI source.