Workspace Manager1.xCLI Manual

Choose documentation 3

latest

Current version

latest
English

Early release libtmux is released, and its APIs may still change between releases. This site's structure and URLs may change too.

Edit this page on GitHub

Import from tmuxinator

tmuxp 1.74.0 · Source

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

Select an existing source

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

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 describes the formats supported by each command. Parser and implementation source.

tmuxp reference source.

Esc

Type to search.

Reference previewOpen reference