tmuxinator

tmuxinator, a tmux session manager

Type object
File match .tmuxinator.yaml .tmuxinator.yml **/.tmuxinator/*.yaml **/.tmuxinator/*.yml **/tmuxinator/*.yaml **/tmuxinator/*.yml
Schema URL https://catalog.lintel.tools/schemas/schemastore/tmuxinator/latest.json
Source https://www.schemastore.org/tmuxinator.json

Validate with Lintel

npx @lintel/lintel check
Type: object

Properties

defaults object
name number | string
project_name string

Name of project root (deprecated, use name)

root string
project_root string

Name of project root (deprecated, use root)

socket_name string

Optional tmux socket.

on_project_start string | string[]

Runs on project start, always.

on_project_first_start string | string[]

Run on project start, the first time.

on_project_restart string | string[]

Run on project start, after the first time.

on_project_exit string | string[]

Run on project exit (detaching from tmux session).

on_project_stop string | string[]

Run on project stop.

pre string

Runs before everything (deprecated).

post string

Runs after everything (deprecated).

rbenv string

Specify version for rbenv (deprecated)

cli_args string

Pass arguments to tmux (deprecated)

tabs string | object[]

Specify tabs (deprecated)

pre_window string

Runs in each window and pane before window/pane specific commands. Useful for setting up interpreter versions.

tmux_options string

Pass command line options to tmux. Useful for specifying a different tmux.conf.

tmux_command string

Change the command to call tmux. This can be used by derivatives/wrappers like byobu.

startup_window string | integer

Specifies (by name or index) which window will be selected on project startup. If not set, the first window is used.

startup_pane integer

Specifies (by index) which pane of the specified window will be selected on project startup. If not set, the first pane is used.

attach boolean

Controls whether the tmux session should be attached to automatically. Defaults to true.

Default: true
tmux_detached boolean

Deprecated. Use attach

enable_pane_titles boolean

Enables the display of pane titles.

Default: false
pane_title_position string

Configures pane title position.

Default: "top"
pane_title_format string

Configures pane title format.

Default: "#{pane_index}: #{pane_title}"
windows string | object[]