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.
List discovered project and saved workspace files, with optional grouping and configuration content.
List workspace recordsLink to section
$ tmuxp ls --jsonJSON output is an object with workspaces and global_workspace_dirs; no
workspaces still produces the object with an empty array. --ndjson emits one
workspace record per line and emits zero lines for no records. When both format
flags are supplied, NDJSON wins. --full includes full configuration content.
--tree groups the human display by directory.
Discovery includes nearest project configurations and configured global directories. It is not a recursive scan of every descendant directory. See discovery rules for precedence and candidate names.
Arguments and flagsLink to section
| Argument or flags | Arity / default | Choices or meaning |
|---|---|---|
--tree | flag; False | display workspaces grouped by directory |
--json | flag; False | output as JSON |
--ndjson | flag; False | output as NDJSON (one JSON per line) |
--full | flag; False | include full config content in output |
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.