(index)=

Session manager for tmux. Load, freeze, and convert tmux sessions through YAML/JSON configuration files. Powered by libtmux.

::::{grid} 1 2 3 3 :gutter: 2 2 3 3

:::{grid-item-card} Quickstart :link: quickstart :link-type: doc Install and run your first command. :::

:::{grid-item-card} CLI Reference :link: cli/index :link-type: doc Every command, flag, and option. :::

:::{grid-item-card} Configuration :link: configuration/index :link-type: doc Config format, examples, and environment variables. :::

::::

::::{grid} 1 1 2 2 :gutter: 2 2 3 3

:::{grid-item-card} Topics :link: topics/index :link-type: doc Workflows, plugins, and troubleshooting. :::

:::{grid-item-card} Contributing :link: project/index :link-type: doc Internals, development setup, and release process. :::

::::

$ pip install tmuxp

$ uv tool install tmuxp

$ brew install tmuxp

See Quickstart for all installation methods and first steps.

session_name: my-project
windows:
  - window_name: editor
    panes:
      - shell_command:
          - vim
      - shell_command:
          - git status

$ tmuxp load my-project.yaml

:width: 888
:height: 589
:loading: lazy

:hidden:

quickstart
cli/index
configuration/index
topics/index
internals/index
project/index
history

:hidden:
:caption: More

about_tmux
migration
glossary