LibTmux.Workspace 0.0.0-alpha.14 · Source
tmuxp compatibility reference. Examples using tmuxp run the Python reference. Local CLI status describes this port’s implemented coverage.
Import a workspace from a supported external configuration format. Select one of the two child commands.
Choose the source formatLink to section
- Teamocil converts a Teamocil workspace.
- tmuxinator converts a tmuxinator workspace.
The parent command groups importers and has no workspace file argument of its own. Each child requires a source at the parser boundary, despite optional-looking help. Conversion is schema translation; it does not make tmuxinator Ruby or ERB evaluation available in a native YAML reader.
Native .NET importsLink to section
The local tmux-workspace import commands translate YAML or JSON and validate
the result with the native workspace loader before printing or saving it.
Invalid shapes, conflicting non-null aliases and unsupported non-null fields
fail before a destination is written, including when --force is present.
Successful translation does not run pane commands or establish that their
applications and directories are available.
Without --save-to, --json returns the document and --ndjson returns a
result record containing it; neither mode guesses an output filename.
--save-to selects a destination, --workspace-format selects YAML or JSON,
and --force permits replacement. Saving publishes through a temporary file
in the destination directory. See output.
A missing session name uses the source filename stem. Relative project roots use the directory where import runs. Teamocil window roots use that same directory; tmuxinator window roots use the resolved project root.
The Teamocil and tmuxinator sections describe command grouping, focus, synchronization and unsupported fields. Launcher lifecycle hooks require an explicit supported workflow; importing them as pane commands would change where and when they run. The importer does not evaluate Ruby or ERB.
Native translation source; validation and saving source.
Arguments and flagsLink to section
The parent accepts -h / --help and selects a child command.
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.