Workspace ManagerconceptCLI Manual

Choose documentation 3

latest

Current version

latest
English

Early release libtmux is released, and its APIs may still change between releases. This site's structure and URLs may change too.

Edit this page on GitHub

Import from tmuxinator

@libtmux/workspace 0.1.0-alpha.12 · Source

Import a saved tmuxinator project without starting tmux. Save this source as tmuxinator.yaml:

tmuxinator.yaml
name: imported-project
windows:
- editor:
- printf ready
- printf second

Preview the translation

Terminal window
$ tmux-workspace import tmuxinator --json ./tmuxinator.yaml

The window’s command list remains sequential commands in one pane. Use an explicit source panes list when the project needs separate panes.

Save the workspace

Terminal window
$ tmux-workspace import tmuxinator \
--json \
--workspace-format yaml \
--save-to imported-tmuxinator.yaml \
./tmuxinator.yaml

Existing destinations require --force. The importer rejects unexpanded ERB templates and unsupported lifecycle or runtime fields before writing. It does not evaluate Ruby. Review the translated commands and absolute directories before loading the file.

CLI source.

Esc

Type to search.

Reference previewOpen reference