tmuxp import

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.

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 C++ importsLink to section

The local tmux-workspace command previews with --json and saves with an explicit destination. Both source and translated workspace are validated before a destination is replaced:

$ tmux-workspace import teamocil \
    --save-to team.json \
    team.yml

Use --force to replace an existing destination. A refused import leaves it intact. Unknown fields, ERB templates, host lifecycle hooks, pane titles and unsupported synchronization timing are reported explicitly. Imports do not execute Ruby.

See each importer for supported translations. Command text and paths should be reviewed before loading the result.

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.

Parser and implementation source.

tmuxp reference source.