Workspace ManagerCLI Manual

Choose documentation 3

latest

Current version

latest
English

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

Edit this page on GitHub

Convert workspace files

LibTmux.Workspace 0.0.0-alpha.20 · Source

Convert a complete workspace document between YAML and JSON. Conversion preserves mapping fields; it does not establish that every field can be loaded.

Inspect the result

Start with workspace.yaml from the installation walkthrough:

Terminal window
$ tmux-workspace convert --json workspace.yaml

Without a destination, machine mode returns the converted document in its result. YAML comments and textual formatting do not survive conversion to JSON.

Save a file

Choose an explicit destination and encoding:

Terminal window
$ tmux-workspace convert \
--json \
--workspace-format json \
--save-to workspace.json \
workspace.yaml

Replacing an existing destination requires --force. Keep that choice separate from --yes, which answers prompts. Review the result before loading it.

CLI source.

Esc

Type to search.