Top-level configuration¶
Top-level keys describe the session as a whole — its name, where it starts,
the tmux options it sets — and sit above the windows and panes that fill
it. Only session_name is required; leave the rest out and a workspace with
just a name and a list of windows loads fine. This page covers session_name
and the keys for choosing a workspace builder. For the full set of session,
window, and pane keys, work through Examples.
session_name¶
The name tmux gives the session — and the name tmuxp checks against when it decides whether that session is already running. It need not match the workspace filename.
For example, apple.yaml:
session_name: banana
windows:
- panes:
-
Load it detached:
$ tmuxp load ./apple.yaml -d
tmuxp reads apple.yaml from the current directory and builds a tmux session
called banana in the background — -d is detached. Attach to it with tmux
directly:
$ tmux attach -t banana
Workspace builder keys¶
A workspace file can also choose a custom builder and tune its behavior with
workspace_builder, workspace_builder_paths, and workspace_builder_options.
Most workspaces never set these — leave them out and you get tmuxp’s built-in
classic builder.
See also