Convert workspace files

@libtmux/workspace 0.1.0-alpha.12 · 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:

$ 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:

$ 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.