Skip to content

Commit 3703f2a

Browse files
committed
docs(cli[import]): Document tmuxinator and teamocil fallback mappings
why: Make the importer's key mappings discoverable for users migrating configs. what: - Note the fallback conversions on the import page
1 parent 76c899a commit 3703f2a

1 file changed

Lines changed: 20 additions & 0 deletions

File tree

docs/cli/import.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,14 @@ $ tmuxp import teamocil /path/to/file.json
3838
3939
````
4040

41+
### Supported teamocil fields
42+
43+
The teamocil importer preserves top-level and `session`-wrapped configs, window
44+
`root`, `layout`, `clear`, `focus`, `options`, and `filters` entries. Pane
45+
entries using `cmd`, `commands`, string panes, and blank panes are converted to
46+
tmuxp pane dictionaries. Unsupported pane `width` and `height` values are
47+
dropped with a warning.
48+
4149
(import-tmuxinator)=
4250

4351
## From tmuxinator
@@ -64,6 +72,18 @@ $ tmuxp import tmuxinator /path/to/file.yaml
6472
6573
````
6674

75+
### Supported tmuxinator fields
76+
77+
The tmuxinator importer maps `project_name`/`name`, `project_root`/`root`,
78+
legacy `tabs`, `cli_args`/`tmux_options` values for `-f`, `-L`, and `-S`,
79+
`socket_name`, `socket_path`, `pre`, `pre_window`, `pre_tab`, `rbenv`, `rvm`,
80+
`startup_window`, `startup_pane`, `synchronize`, pane-title keys, and lifecycle
81+
hook keys.
82+
83+
Named pane entries such as `{logs: tail -f log/development.log}` become tmuxp
84+
pane `title` values. Imported `config` values are resolved relative to the saved
85+
workspace file when the workspace is loaded.
86+
6787
````{tab} JSON
6888
6989
```console

0 commit comments

Comments
 (0)