tmuxinator

Automate tmux session configuration

TLDR

Start project

$ tmuxinator start [project]

Create new project

$ tmuxinator new [project]

Edit project

$ tmuxinator edit [project]

List projects

$ tmuxinator list

Delete project

$ tmuxinator delete [project]

Copy project

$ tmuxinator copy [existing] [new_name]

Stop project

$ tmuxinator stop [project]

Show project config

$ tmuxinator debug [project]

SYNOPSIS

tmuxinator [start] [new] [edit] [list] [delete] [options] [project]

tmuxinator automates tmux session setup. Project files define windows, panes, and commands that start with a single command.YAML configuration describes session layout. Windows have names, working directories, and pane configurations.Commands run automatically when panes open. Development servers, editors, and monitoring tools start in their designated locations.Layout presets handle common pane arrangements. Custom layouts specify exact pane dimensions.Project files live in ~/.config/tmuxinator. They're portable across machines and can be version controlled.Starting a project creates or attaches to the tmux session. Subsequent starts attach without recreating.

PARAMETERS

start PROJECT

Start project session.

new PROJECT

Create new project.

edit PROJECT

Edit project config.

open PROJECT

Alias for edit.

list, ls

List projects.

delete PROJECT

Delete project.

stop PROJECT

Kill project session.

copy SRC DEST

Copy project.

debug PROJECT

Show generated script.

doctor

Check configuration.

version

Show version.

-p FILE

Use project file.

-n NAME

Override session name.

CONFIGURATION

**~/.config/tmuxinator/*.yml**

Project configuration files in YAML format defining session layouts, windows, panes, and startup commands.

CAVEATS

Requires Ruby. Complex layouts need careful configuration. Some tmux versions may have compatibility issues.

HISTORY

Tmuxinator was created around 2010 to automate tmux session creation. It became the standard tool for managing development environment configurations.