Workspace ManagerConfiguration

Choose documentation 3

latest

Current version

latest
English

Prerelease This site documents an alpha of libtmux. Its structure, URLs and APIs are subject to change.

Edit this page on GitHub

Window configuration

LibTmux.Workspace 0.0.0-alpha.20 · Source

Each item in windows creates one window with its own ordered pane list. Set window_index when the tmux index matters independently of list position.

windows.yaml
session_name: windows-example
windows:
- window_name: tools
window_index: 2
layout: even-horizontal
focus: true
options:
automatic-rename: false
options_after:
synchronize-panes: true
panes:
- printf left
- printf right

options applies during construction. options_after applies after initial pane commands, which is useful for enabling synchronized typing after each pane has received its own setup. Later input in a synchronized pane can reach the other panes in that window.

Launch settings

start_directory supplies a directory for panes that do not override it. window_shell supplies their launch command; a pane’s shell overrides it. Set environment for a window-wide launch map and read environment inheritance before overriding it per pane.

Use distinct explicit indexes. focus: true selects the window after building. An explicit layout makes the intended arrangement clear across terminal sizes. Pane configuration controls each pane’s contents.

CLI source.

Esc

Type to search.