@@ -13,7 +13,12 @@ shorthands:
13
13
14
14
Path to folder with ` .tmuxp.yaml ` , ` .tmuxp.yml ` , ` .tmuxp.json ` :
15
15
16
+ ```` {tab} Project based
17
+
18
+ Projects with a file named `.tmuxp.yaml` or `.tmuxp.json` can be loaded:
19
+
16
20
```console
21
+ // current directory
17
22
$ tmuxp load .
18
23
```
19
24
@@ -29,6 +34,10 @@ $ tmuxp load path/to/folder/
29
34
$ tmuxp load /path/to/folder/
30
35
```
31
36
37
+ ````
38
+
39
+ ```` {tab} User based
40
+
32
41
Name of the config, assume `$HOME/.tmuxp/myconfig.yaml`:
33
42
34
43
```console
@@ -49,18 +58,19 @@ $ tmuxp load /abs/path/to/myfile.yaml
49
58
$ tmuxp load ~/myfile.yaml
50
59
```
51
60
61
+ ````
62
+
63
+ ```` {tab} Direct
64
+
52
65
Absolute and relative directory paths are supported.
53
66
54
67
```console
55
68
$ tmuxp load [filename]
56
69
```
57
70
58
- Files named ` .tmuxp.yaml ` or ` .tmuxp.json ` in the current working
59
- directory may be loaded with:
71
+ ````
60
72
61
- ``` console
62
- $ tmuxp load .
63
- ```
73
+ ## Inside sessions
64
74
65
75
If you try to load a config file from within a tmux session, it will ask you
66
76
if 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?
72
82
[y/n/a]:
73
83
```
74
84
85
+ ## Options
86
+
75
87
All of these options can be preselected to skip the prompt:
76
88
77
89
- Attach / open client after load:
@@ -92,6 +104,8 @@ All of these options can be preselected to skip the prompt:
92
104
$ tmuxp load -a config
93
105
```
94
106
107
+ ## Loading multiple sessions
108
+
95
109
Multiple sessions can be loaded at once. The first ones will be created
96
110
without being attached. The last one will be attached if there is no
97
111
` -d ` flag on the command line.
@@ -100,13 +114,17 @@ without being attached. The last one will be attached if there is no
100
114
$ tmuxp load [filename1] [filename2] ...
101
115
```
102
116
117
+ ## Custom session name
118
+
103
119
A session name can be provided at the terminal. If multiple sessions
104
120
are created, the last session is named from the terminal.
105
121
106
122
``` console
107
123
$ tmuxp load -s [new_session_name] [filename1] ...
108
124
```
109
125
126
+ ## Logging
127
+
110
128
The output of the ` load ` command can be logged to a file for
111
129
debugging purposes. the log level can be controlled with the global
112
130
` --log-level ` option (defaults to INFO).
@@ -119,10 +137,12 @@ $ tmuxp load [filename] --log-file [log_filename]
119
137
$ tmuxp --log-level [LEVEL] load [filename] --log-file [log_filename]
120
138
```
121
139
140
+ ## Reference
141
+
122
142
(tmuxp-load-reference)=
123
143
124
144
``` {eval-rst}
125
- .. click:: tmuxp.cli:cli
145
+ .. click:: tmuxp.cli.load:command_load
126
146
:prog: tmuxp load
127
147
:commands: load
128
148
:nested: full
0 commit comments