@@ -13,7 +13,12 @@ shorthands:
1313
1414Path to folder with ` .tmuxp.yaml ` , ` .tmuxp.yml ` , ` .tmuxp.json ` :
1515
16+ ```` {tab} Project based
17+
18+ Projects with a file named `.tmuxp.yaml` or `.tmuxp.json` can be loaded:
19+
1620```console
21+ // current directory
1722$ tmuxp load .
1823```
1924
@@ -29,6 +34,10 @@ $ tmuxp load path/to/folder/
2934$ tmuxp load /path/to/folder/
3035```
3136
37+ ````
38+
39+ ```` {tab} User based
40+
3241Name of the config, assume `$HOME/.tmuxp/myconfig.yaml`:
3342
3443```console
@@ -49,18 +58,19 @@ $ tmuxp load /abs/path/to/myfile.yaml
4958$ tmuxp load ~/myfile.yaml
5059```
5160
61+ ````
62+
63+ ```` {tab} Direct
64+
5265Absolute and relative directory paths are supported.
5366
5467```console
5568$ tmuxp load [filename]
5669```
5770
58- Files named ` .tmuxp.yaml ` or ` .tmuxp.json ` in the current working
59- directory may be loaded with:
71+ ````
6072
61- ``` console
62- $ tmuxp load .
63- ```
73+ ## Inside sessions
6474
6575If you try to load a config file from within a tmux session, it will ask you
6676if you want to load and attach to the new session, or just load detached.
@@ -72,6 +82,8 @@ Or (a)ppend windows in the current active session?
7282[y/n/a]:
7383```
7484
85+ ## Options
86+
7587All of these options can be preselected to skip the prompt:
7688
7789- Attach / open client after load:
@@ -92,6 +104,8 @@ All of these options can be preselected to skip the prompt:
92104 $ tmuxp load -a config
93105 ```
94106
107+ ## Loading multiple sessions
108+
95109Multiple sessions can be loaded at once. The first ones will be created
96110without being attached. The last one will be attached if there is no
97111` -d ` flag on the command line.
@@ -100,13 +114,17 @@ without being attached. The last one will be attached if there is no
100114$ tmuxp load [filename1] [filename2] ...
101115```
102116
117+ ## Custom session name
118+
103119A session name can be provided at the terminal. If multiple sessions
104120are created, the last session is named from the terminal.
105121
106122``` console
107123$ tmuxp load -s [new_session_name] [filename1] ...
108124```
109125
126+ ## Logging
127+
110128The output of the ` load ` command can be logged to a file for
111129debugging purposes. the log level can be controlled with the global
112130` --log-level ` option (defaults to INFO).
@@ -119,10 +137,12 @@ $ tmuxp load [filename] --log-file [log_filename]
119137$ tmuxp --log-level [LEVEL] load [filename] --log-file [log_filename]
120138```
121139
140+ ## Reference
141+
122142(tmuxp-load-reference)=
123143
124144``` {eval-rst}
125- .. click:: tmuxp.cli:cli
145+ .. click:: tmuxp.cli.load:command_load
126146 :prog: tmuxp load
127147 :commands: load
128148 :nested: full
0 commit comments