Workspace commands

C++

Python
Ruby Unavailable
Lua Unavailable
TypeScript
Rust
Go
Java
.NET
C++
Swift

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 sends workspace commands into panes in order. A command can be a string or a mapping with "cmd" and execution controls. shell_command_before adds shared setup without copying it into every pane.

session_name: command-example
shell_command_before:
  - echo session setup
windows:
  - window_name: main
    shell_command_before:
      - echo window setup
    panes:
      - shell_command_before:
          - echo pane setup
        shell_command:
          - cmd: echo ready
            sleep_after: 0.2
          - cmd: echo typed but not submitted
            enter: false
            sleep_after: 0

This sends the three setup commands, submits echo ready, waits 0.2 seconds, and leaves the final command at the prompt. The delay pauses construction; it does not ask the application whether it is ready.

Forms and orderLink to section

shell_command and shell_command_before accept a scalar command or a list. A command dictionary requires "cmd" for the text. The loader expands shell variables and tilde expressions in command strings before the builder sends them. Variables already known to the process running tmuxp can therefore be substituted before a pane shell sees the command.

For each pane, the loader concatenates session before commands, window before commands, pane before commands, then the pane’s own commands. A blank pane still receives inherited setup. Quoting affects the pane shell too; YAML quoting alone does not bypass tmuxp’s expansion step.

Enter and delaysLink to section

Setting	Default and scope
`"enter"`	True; pane default, then command override
`sleep_before`	No delay; pane default, then command override in seconds
`sleep_after`	No delay; pane default, then command override in seconds

In the classic builder, a command’s enter/delay override carries forward to subsequent commands in that pane. Set enter: true or an explicit zero delay to restore that behavior for a later command. Absence means keep the current value; zero is an intentional delay override.

Pauses run synchronously during construction. They can let a startup command settle but do not monitor its success. A failed pane command is not necessarily a failed tmux send operation, and starting a web server is not proof it is accepting connections.

History and prompt readinessLink to section

History suppression defaults to true. A session value trickles to a window, and a pane can override it. Suppression prefixes command text with a space. Bash needs HISTCONTROL containing ignorespace or ignoreboth; zsh needs HIST_IGNORE_SPACE. Without shell support, the command can still enter history.

Builder pane_readiness is separate from command delays. Auto waits for the configured zsh session shell, while custom pane/window launch commands skip prompt waiting. See hooks and builders for the policy and its limits.

A workspace before_script runs as a process outside the panes and checks its exit status. Use it for bootstrap work that must succeed before configured windows are built, rather than treating pane command delivery as a checked process result.

Current C++ builderLink to section

Command metadata supports enter, delays, and suppression. The consumer creates topology before delivering commands; it does not perform the complete tmuxp normalization pipeline.

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

Reference sourceLink to section

loader.py; classic.py; sleep.yaml; skip-send.yaml.