# tmuxp import teamocil

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

> Translate a Teamocil workspace into tmuxp configuration, review the result, and select its saved representation.

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

Translate a Teamocil workspace into tmuxp configuration, review the result, and
select its saved representation.

## Select an existing source

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

```console
$ tmuxp import teamocil project
```

The source lookup uses [`~/.teamocil`](./). A source argument is effectively required:
although its positional action has optional arity, it belongs to a required
exclusive group, and omission exits 2. The reference previews and saves the
transformed document interactively.

Native automation needs explicit destination, encoding, and overwrite policy
instead of implicit prompts. See [output](../../reference/output/). Inspect
translated commands and directories before loading the result.

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 teamocil` preserves names, roots, layouts, window
options and pane/window focus. It accepts pane command strings and `commands`
mappings. Command arrays join into one semicolon-separated shell input; the
first true focus flag wins in each scope.

The legacy `session` wrapper and `project_name`, `project_root`, `tabs`,
`splits` and `cmd` aliases are accepted. Null aliases fall back to the other
spelling; conflicting non-null values are refused. An omitted session name
uses the source filename stem.

Relative roots resolve against the directory where import runs and are saved
as absolute paths. Dollar expansion and `~user` paths are unsupported.
Enabled `synchronize-panes` is refused because the native builder creates all
panes before sending commands, changing which panes would receive input.
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 uses [`~/.teamocil`](./). |

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