tmuxp load#

You can load your tmuxp file and attach the vim session via a few shorthands:

  1. The directory with a .tmuxp.{yaml,yml,json} file in it

  2. The name of the project file in your $HOME/.tmuxp folder

  3. The direct path of the tmuxp file you want to load

Path to folder with .tmuxp.yaml, .tmuxp.yml, .tmuxp.json:

Projects with a file named .tmuxp.yaml or .tmuxp.json can be loaded:

// current directory
$ tmuxp load .
$ tmuxp load ../
$ tmuxp load path/to/folder/
$ tmuxp load /path/to/folder/

Name of the config, assume $HOME/.tmuxp/myconfig.yaml:

$ tmuxp load myconfig

Direct path to json/yaml file:

$ tmuxp load ./myfile.yaml
$ tmuxp load /abs/path/to/myfile.yaml
$ tmuxp load ~/myfile.yaml

Absolute and relative directory paths are supported.

$ tmuxp load [filename]

Inside sessions#

If you try to load a config file from within a tmux session, it will ask you if you want to load and attach to the new session, or just load detached. You can also load a config file and append the windows to the current active session.

Already inside TMUX, switch to session? yes/no
Or (a)ppend windows in the current active session?
[y/n/a]:

Options#

All of these options can be preselected to skip the prompt:

  • Attach / open client after load:

    $ tmuxp load -y config
    
  • Detached / open in background:

    $ tmuxp load -d config
    
  • Append windows to existing session

    $ tmuxp load -a config
    

Loading multiple sessions#

Multiple sessions can be loaded at once. The first ones will be created without being attached. The last one will be attached if there is no -d flag on the command line.

$ tmuxp load [filename1] [filename2] ...

Custom session name#

A session name can be provided at the terminal. If multiple sessions are created, the last session is named from the terminal.

$ tmuxp load -s [new_session_name] [filename1] ...

Logging#

The output of the load command can be logged to a file for debugging purposes. the log level can be controlled with the global --log-level option (defaults to INFO).

$ tmuxp load [filename] --log-file [log_filename]
$ tmuxp --log-level [LEVEL] load [filename] --log-file [log_filename]

Reference#

tmuxp load#

Load a tmux workspace from each CONFIG.

CONFIG is a specifier for a configuration file.

If CONFIG is a path to a directory, tmuxp will search it for “.tmuxp.{yaml,yml,json}”.

If CONFIG is has no directory component and only a filename, e.g. “myconfig.yaml”, tmuxp will search the users’s config directory for that file.

If CONFIG has no directory component, and only a name with no extension, e.g. “myconfig”, tmuxp will search the users’s config directory for any file with the extension “.yaml”, “.yml”, or “.json” that matches that name.

If multiple configuration files that match a given CONFIG are found, tmuxp will warn and pick the first one found.

If multiple CONFIGs are provided, workspaces will be created for all of them. The last one provided will be attached. The others will be created in detached mode.

tmuxp load [OPTIONS] [CONFIG]...

Options

-S <socket_path>#

pass-through for tmux -S

-L <socket_name>#

pass-through for tmux -L

-f <tmux_config_file>#

pass-through for tmux -f

-s <new_session_name>#

start new session with new session name

-y, --yes#

yes

-d#

Load the session without attaching it

-a#

Load configuration, appending windows to the current session

-2#

Force tmux to assume the terminal supports 256 colours.

-8#

Like -2, but indicates that the terminal supports 88 colours.

--log-file <log_file>#

File to log errors/output to

Arguments

CONFIG#

Optional argument(s)