1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
|
(cli-load)=
(tmuxp-load)=
(tmuxp-load-reference)=
# tmuxp load
```{eval-rst}
.. argparse::
:module: tmuxp.cli
:func: create_parser
:prog: tmuxp
:path: load
```
## Usage
You can load your tmuxp file and attach the tmux 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`:
````{tab} Project based
Projects with a file named `.tmuxp.yaml` or `.tmuxp.json` can be loaded:
```console
// current directory
$ tmuxp load .
```
```console
$ tmuxp load ../
```
```console
$ tmuxp load path/to/folder/
```
```console
$ tmuxp load /path/to/folder/
```
````
````{tab} User based
Name of the config, assume `$HOME/.tmuxp/myconfig.yaml`:
```console
$ tmuxp load myconfig
```
Direct path to json/yaml file:
```console
$ tmuxp load ./myfile.yaml
```
```console
$ tmuxp load /abs/path/to/myfile.yaml
```
```console
$ tmuxp load ~/myfile.yaml
```
````
````{tab} Direct
Absolute and relative directory paths are supported.
```console
$ tmuxp load [filename]
```
````
## Inside sessions
If you try to load a workspace 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 workspace 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 the client after load:
```console
$ tmuxp load -y config
```
- Detached / open in background:
```console
$ tmuxp load -d config
```
- Append windows to existing session
```console
$ 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.
```console
$ 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.
```console
$ 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).
```console
$ tmuxp load [filename] --log-file [log_filename]
```
```console
$ tmuxp --log-level [LEVEL] load [filename] --log-file [log_filename]
```
|
