tmuxp import teamocil

Edit this page on GitHub

workspace consumer 0.1.0-alpha.10 · Source

tmuxp compatibility reference. Examples using tmuxp run the Python reference. Local CLI status describes this port’s implemented coverage.

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

Select an existing sourceLink to section

With project.yml already present in the Teamocil configuration directory:

$ 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. 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++ translationLink to section

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.

Arguments and flagsLink to section

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.