Prerelease This site documents an alpha of libtmux. Its structure, URLs and APIs are subject to change.

tmuxp edit

Edit this page on GitHub

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.

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:

Terminal window
$ 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 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

Argument or flagsArity / defaultChoices or meaning
workspace_filerequiredchecks current tmuxp and current directory for workspace files.

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

Parser and implementation source.

tmuxp reference source.

Esc

Type to search.