tmuxp edit

Edit this page on GitHub

tmuxp 1.74.0 · Source

This page documents the available Python tmuxp reference. Proposed native extensions are labeled separately.

Resolve a saved workspace or file and open it in the configured editor. The lookup rules are shared with loading.

Open a workspaceLink to section

With workspace.yaml already saved and $EDITOR set to a single executable:

$ tmuxp edit workspace.yaml

The reference passes the entire $EDITOR value as one executable string followed by the file path. An editor command containing arguments is not tokenized. It waits for the child process but does not propagate that child’s exit status. Use an editor wrapper executable when arguments are needed.

The proposed native contract defines argument parsing and propagates child failure. These are deliberate behavior changes, not existing Python guarantees. See discovery and environment.

Arguments and flagsLink to section

All commands accept -h / --help. Root options precede the command; see the CLI overview. The output reference distinguishes current Python flags from proposed all-command JSON and NDJSON.

Parser and implementation source.

tmuxp reference source.