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

tmuxp import tmuxinator

Edit this page on GitHub

libtmux-workspace 0.0.1-alpha.12-SNAPSHOT · 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:

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

Arguments and flagsLink to section

Argument or flagsArity / defaultChoices or meaning
workspace_fileeffectively requirednargs="?" belongs to a required exclusive group; omission exits 2. Source lookup honors TMUXINATOR_CONFIG.

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.

Esc

Type to search.