# tmuxp import tmuxinator

Source: https://libtmux.org/en/cxx/latest/workspace/cli/import-tmuxinator/

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

**tmuxp compatibility reference.** Examples using `tmuxp` run the Python reference. [Local CLI status](../../reference/compatibility/) describes this port's implemented coverage.

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

## Select an existing source

With [`project.yml`](../../guides/discovery/) already present in the configured tmuxinator directory:

```console
$ 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](../../configuration/environment/)
and [output](../../reference/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++ translation

`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](../import/#native-c-imports).

## Arguments and flags

| Argument or flags | Arity / default | Choices or meaning |
| --- | --- | --- |
| `workspace_file` | effectively required | `nargs="?"` 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](../../reference/output/)
distinguishes current Python flags from native all-command JSON and NDJSON.

[Parser and implementation source](https://github.com/tmux-python/tmuxp/blob/618b398acc05506d3c682906c36cdeb29dcfa1ff/src/tmuxp/cli/import_config.py).

[tmuxp reference source](https://github.com/tmux-python/tmuxp/blob/618b398acc05506d3c682906c36cdeb29dcfa1ff/src/tmuxp/cli/__init__.py).