tmuxp import tmuxinator

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.

Translate a tmuxinator workspace into tmuxp configuration, preserving an explicit boundary around dynamic Ruby configuration.

Select an existing sourceLink to section

With project.yml already present in the configured tmuxinator directory:

$ tmuxp import tmuxinator project

TMUXINATOR_CONFIG overrides the source directory and expands a leading tilde. A source argument is effectively required, and omission exits 2 despite optional-looking help. The reference previews and saves the transformed document interactively.

Do not interpret successful YAML parsing as support for ERB templates or arbitrary Ruby execution. Native importers must either implement a documented bridge or reject unsupported dynamic input. Inspect the resulting commands and directories before loading. See environment and output.

An extensionless name searches the configured source directory. A filename with an extension is resolved relative to the current directory unless you provide an explicit path.

Native C++ translationLink to section

tmux-workspace import tmuxinator translates session names, project roots, named windows, layouts and pane commands. A command array used as a window body remains one pane with ordered commands; explicit panes may each contain a command array.

pre_window arrays join with ; , while window pre arrays join with &&. A nonempty window pre requires explicit nonempty panes. Synchronization is supported only with synchronize: after. Host lifecycle hooks, ERB templates, named pane titles, startup selectors and endpoint/attachment settings are refused before saving.

Relative project roots resolve where import runs; relative window roots resolve against the project root. Saved paths are absolute. project_name, project_root and tabs aliases use non-null fallback and refuse conflicts. See native import saving.

Arguments and flagsLink to section

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.