# tmuxp import

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

> Import a workspace from a supported external configuration format. Select one of the two child commands.

**tmuxp compatibility reference.** Examples using `tmuxp` run the Python reference. [Local CLI status](../../reference/compatibility/) 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 format

- [Teamocil](../import-teamocil/) converts a Teamocil workspace.
- [tmuxinator](../import-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++ imports

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:

```console
$ 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 flags

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](../../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).